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.185 by root, Fri Jan 19 23:32:52 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	489	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		490
358	aio_fsync $fh	491	sub fork_call(&@) {
359	and return;	492	my ($cb, @args) = @_;
360		493
361	close $fh	494	# we seemingly have to make a local copy of the whole thing,
362	or return;	495	# otherwise perl prematurely frees the stuff :/
		496	# TODO: investigate and fix (likely this will be rather laborious)
363		497
364	aio_rename "$runtime~", $runtime	498	my @res = Coro::Util::fork_eval {
365	and return;	499	reset_signals;
		500	&$cb
		501	}, @args;
366		502
		503	wantarray ? @res : $res[-1]
		504	}
		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
367	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 });
368	}	642	}
369		643
370	=back	644	=back
371		645
372	=cut	646	=cut
…		…
379	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")
380	to it. All such attachable objects support the following methods.	654	to it. All such attachable objects support the following methods.
381		655
382	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>
383	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
384	crossfire+).	658	Crossfire TRT).
385		659
386	=over 4	660	=over 4
387		661
388	=item $attachable->attach ($attachment, key => $value...)	662	=item $attachable->attach ($attachment, key => $value...)
389		663
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	826	$registry = $CB_TYPE[$object_type] ||= [];
553		827
554	} elsif ($type eq "subtype") {	828	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	829	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	830	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	831	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		832
559	} elsif ($type eq "package") {	833	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	834	my $pkg = shift @arg;
561		835
562	while (my ($name, $id) = each %cb_id) {	836	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	865	_attach $registry, $klass, @attach;
592	}	866	}
593		867
594	$obj->{$name} = \%arg;	868	$obj->{$name} = \%arg;
595	} else {	869	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	870	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	871	}
598		872
599	$obj->{_attachment}{$name} = undef;	873	$obj->{_attachment}{$name} = undef;
600	}	874	}
601		875
…		…
603	if (ref $_[0]) {	877	if (ref $_[0]) {
604	_object_attach @_;	878	_object_attach @_;
605	} else {	879	} else {
606	_attach shift->_attach_registry, @_;	880	_attach shift->_attach_registry, @_;
607	}	881	}
		882	_recalc_want;
608	};	883	};
609		884
610	# all those should be optimised	885	# all those should be optimised
611	sub cf::attachable::detach {	886	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	887	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	890	delete $obj->{_attachment}{$name};
616	reattach ($obj);	891	reattach ($obj);
617	} else {	892	} else {
618	Carp::croak "cannot, currently, detach class attachments";	893	Carp::croak "cannot, currently, detach class attachments";
619	}	894	}
		895	_recalc_want;
620	};	896	};
621		897
622	sub cf::attachable::attached {	898	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	899	my ($obj, $name) = @_;
624		900
…		…
639	";	915	";
640	die if $@;	916	die if $@;
641	}	917	}
642		918
643	our $override;	919	our $override;
644	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?
645		921
646	sub override {	922	sub override {
647	$override = 1;	923	$override = 1;
648	@invoke_results = ();	924	@INVOKE_RESULTS = (@_);
649	}	925	}
650		926
651	sub do_invoke {	927	sub do_invoke {
652	my $event = shift;	928	my $event = shift;
653	my $callbacks = shift;	929	my $callbacks = shift;
654		930
655	@invoke_results = ();	931	@INVOKE_RESULTS = ();
656		932
657	local $override;	933	local $override;
658		934
659	for (@$callbacks) {	935	for (@$callbacks) {
660	eval { &{$_->[1]} };	936	eval { &{$_->[1]} };
…		…
677		953
678	Generate an object-specific event with the given arguments.	954	Generate an object-specific event with the given arguments.
679		955
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	958	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		959
684	=back	960	=back
685		961
686	=cut	962	=cut
687		963
688	#############################################################################	964	#############################################################################
689	# 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	}
690		977
691	sub reattach {	978	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	979	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	980	my ($obj) = @_;
694		981
…		…
741	sub object_freezer_save {	1028	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1029	my ($filename, $rdata, $objs) = @_;
743		1030
744	sync_job {	1031	sync_job {
745	if (length $$rdata) {	1032	if (length $$rdata) {
		1033	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1034	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1035	$decname, length $$rdata, scalar @$objs;
748		1036
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1037	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1038	chmod SAVE_MODE, $fh;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1039	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1040	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1041	close $fh;
754		1042
755	if (@$objs) {	1043	if (@$objs) {
756	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1044	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
757	chmod SAVE_MODE, $fh;	1045	chmod SAVE_MODE, $fh;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1046	my $data = Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1047	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1048	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1049	close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1050	aio_rename "$filename.pst~", "$filename.pst";
763	}	1051	}
764	} else {	1052	} else {
765	aio_unlink "$filename.pst";	1053	aio_unlink "$filename.pst";
…		…
771	}	1059	}
772	} else {	1060	} else {
773	aio_unlink $filename;	1061	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1062	aio_unlink "$filename.pst";
775	}	1063	}
776	}	1064	};
777	}	1065	}
778		1066
779	sub object_freezer_as_string {	1067	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1068	my ($rdata, $objs) = @_;
781		1069
…		…
793	or return;	1081	or return;
794		1082
795	unless (aio_stat "$filename.pst") {	1083	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1084	(aio_load "$filename.pst", $av) >= 0
797	or return;	1085	or return;
		1086
798	$av = eval { (Storable::thaw $av)->{objs} };	1087	$av = eval { (Storable::thaw $av)->{objs} };
799	}	1088	}
800		1089
		1090	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1091	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1092	$decname, length $data, scalar @{$av || []};
		1093
803	return ($data, $av);	1094	($data, $av)
804	}	1095	}
		1096
		1097	=head2 COMMAND CALLBACKS
		1098
		1099	=over 4
		1100
		1101	=cut
805		1102
806	#############################################################################	1103	#############################################################################
807	# command handling &c	1104	# command handling &c
808		1105
809	=item cf::register_command $name => \&callback($ob,$args);	1106	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1119	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1120	}
824		1121
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1122	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1123
827	Register a callbackf ro execution when the client sends an extcmd packet.	1124	Register a callback for execution when the client sends an (synchronous)
		1125	extcmd packet. Ext commands will be processed in the order they are
		1126	received by the server, like other user commands. The first argument is
		1127	the logged-in player. Ext commands can only be processed after a player
		1128	has logged in successfully.
828		1129
829	If the callback returns something, it is sent back as if reply was being	1130	If the callback returns something, it is sent back as if reply was being
830	called.	1131	called.
831		1132
		1133	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1134
		1135	Register a callback for execution when the client sends an (asynchronous)
		1136	exticmd packet. Exti commands are processed by the server as soon as they
		1137	are received, i.e. out of order w.r.t. other commands. The first argument
		1138	is a client socket. Exti commands can be received anytime, even before
		1139	log-in.
		1140
		1141	If the callback returns something, it is sent back as if reply was being
		1142	called.
		1143
832	=cut	1144	=cut
833		1145
834	sub register_extcmd {	1146	sub register_extcmd {
835	my ($name, $cb) = @_;	1147	my ($name, $cb) = @_;
836		1148
837	$EXTCMD{$name} = $cb;	1149	$EXTCMD{$name} = $cb;
		1150	}
		1151
		1152	sub register_exticmd {
		1153	my ($name, $cb) = @_;
		1154
		1155	$EXTICMD{$name} = $cb;
838	}	1156	}
839		1157
840	cf::player->attach (	1158	cf::player->attach (
841	on_command => sub {	1159	on_command => sub {
842	my ($pl, $name, $params) = @_;	1160	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1169	cf::override;
852	},	1170	},
853	on_extcmd => sub {	1171	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1172	my ($pl, $buf) = @_;
855		1173
856	my $msg = eval { from_json $buf };	1174	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1175
858	if (ref $msg) {	1176	if (ref $msg) {
		1177	my ($type, $reply, @payload) =
		1178	"ARRAY" eq ref $msg
		1179	? @$msg
		1180	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1181
		1182	my @reply;
		1183
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1184	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1185	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1186	}
		1187
		1188	$pl->ext_reply ($reply, @reply)
		1189	if $reply;
		1190
864	} else {	1191	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1192	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1193	}
867		1194
868	cf::override;	1195	cf::override;
869	},	1196	},
870	);	1197	);
871		1198
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1199	sub load_extensions {
		1200	cf::sync_job {
		1201	my %todo;
		1202
907	for my $ext (<$LIBDIR/*.ext>) {	1203	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1204	next unless -r $path;
909	eval {	1205
910	load_extension $ext;	1206	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1207	my $base = $1;
		1208	my $pkg = $1;
		1209	$pkg =~ s/[^[:word:]]/_/g;
		1210	$pkg = "ext::$pkg";
		1211
		1212	open my $fh, "<:utf8", $path
		1213	or die "$path: $!";
		1214
		1215	my $source = do { local $/; <$fh> };
		1216
		1217	my %ext = (
		1218	path => $path,
		1219	base => $base,
		1220	pkg => $pkg,
		1221	);
		1222
		1223	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1224	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1225
		1226	$ext{source} =
		1227	"package $pkg; use strict; use utf8;\n"
		1228	. "#line 1 \"$path\"\n{\n"
		1229	. $source
		1230	. "\n};\n1";
		1231
		1232	$todo{$base} = \%ext;
		1233	}
		1234
		1235	my %done;
		1236	while (%todo) {
		1237	my $progress;
		1238
		1239	while (my ($k, $v) = each %todo) {
		1240	for (split /,\s*/, $v->{meta}{depends}) {
		1241	goto skip
		1242	unless exists $done{$_};
		1243	}
		1244
		1245	warn "... loading '$k' into '$v->{pkg}'\n";
		1246
		1247	unless (eval $v->{source}) {
		1248	my $msg = $@ ? "$v->{path}: $@\n"
		1249	: "$v->{base}: extension inactive.\n";
		1250
		1251	if (exists $v->{meta}{mandatory}) {
		1252	warn $msg;
		1253	warn "mandatory extension failed to load, exiting.\n";
		1254	exit 1;
		1255	}
		1256
		1257	warn $msg;
		1258	}
		1259
		1260	$done{$k} = delete $todo{$k};
		1261	push @EXTS, $v->{pkg};
		1262	$progress = 1;
911	1	1263	}
912	} or warn "$ext not loaded: $@";	1264
		1265	skip:
		1266	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1267	unless $progress;
		1268	}
913	}	1269	};
914	}	1270	}
915		1271
916	#############################################################################	1272	#############################################################################
917		1273
		1274	=back
		1275
918	=head2 CORE EXTENSIONS	1276	=head2 CORE EXTENSIONS
919		1277
920	Functions and methods that extend core crossfire objects.	1278	Functions and methods that extend core crossfire objects.
921		1279
922	=cut	1280	=cut
…		…
927		1285
928	=head3 cf::player	1286	=head3 cf::player
929		1287
930	=over 4	1288	=over 4
931		1289
		1290	=item cf::player::num_playing
		1291
		1292	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1293
		1294	=cut
		1295
		1296	sub num_playing {
		1297	scalar grep
		1298	$_->ob->map
		1299	&& !$_->hidden
		1300	&& !$_->ob->flag (cf::FLAG_WIZ),
		1301	cf::player::list
		1302	}
		1303
932	=item cf::player::find $login	1304	=item cf::player::find $login
933		1305
934	Returns the given player object, loading it if necessary (might block).	1306	Returns the given player object, loading it if necessary (might block).
935		1307
936	=cut	1308	=cut
937		1309
938	sub playerdir($) {	1310	sub playerdir($) {
939	cf::localdir	1311	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1312	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1313	}
945		1314
946	sub path($) {	1315	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1316	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1317
949	(playerdir $login) . "/$login.pl"	1318	(playerdir $login) . "/playerdata"
950	}	1319	}
951		1320
952	sub find_active($) {	1321	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1322	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1323	and $cf::PLAYER{$_[0]}->active
…		…
967	my $login = $_[0];	1336	my $login = $_[0];
968		1337
969	my $guard = cf::lock_acquire "user_find:$login";	1338	my $guard = cf::lock_acquire "user_find:$login";
970		1339
971	$cf::PLAYER{$_[0]} || do {	1340	$cf::PLAYER{$_[0]} || do {
972	my $pl = load_pl path $login	1341	# rename old playerfiles to new ones
		1342	#TODO: remove when no longer required
		1343	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1344	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1345	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1346	aio_unlink +(playerdir $login) . "/$login.pl";
		1347
		1348	my $f = new_from_file cf::object::thawer path $login
973	or return;	1349	or return;
		1350
		1351	my $pl = cf::player::load_pl $f
		1352	or return;
		1353	local $cf::PLAYER_LOADING{$login} = $pl;
		1354	$f->resolve_delayed_derefs;
974	$cf::PLAYER{$login} = $pl	1355	$cf::PLAYER{$login} = $pl
975	}	1356	}
976	}	1357	}
977	}	1358	}
978		1359
…		…
988		1369
989	aio_mkdir playerdir $pl, 0770;	1370	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1371	$pl->{last_save} = $cf::RUNTIME;
991		1372
992	$pl->save_pl ($path);	1373	$pl->save_pl ($path);
993	Coro::cede;	1374	cf::cede_to_tick;
994	}	1375	}
995		1376
996	sub new($) {	1377	sub new($) {
997	my ($login) = @_;	1378	my ($login) = @_;
998		1379
…		…
1004	$cf::PLAYER{$login} = $self;	1385	$cf::PLAYER{$login} = $self;
1005		1386
1006	$self	1387	$self
1007	}	1388	}
1008		1389
		1390	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1391
		1392	=cut
		1393
		1394	sub send_msg {
		1395	my $ns = shift->ns
		1396	or return;
		1397	$ns->send_msg (@_);
		1398	}
		1399
1009	=item $pl->quit_character	1400	=item $pl->quit_character
1010		1401
1011	Nukes the player without looking back. If logged in, the connection will	1402	Nukes the player without looking back. If logged in, the connection will
1012	be destroyed. May block for a long time.	1403	be destroyed. May block for a long time.
1013		1404
1014	=cut	1405	=cut
1015		1406
1016	sub quit_character {	1407	sub quit_character {
1017	my ($pl) = @_;	1408	my ($pl) = @_;
		1409
		1410	my $name = $pl->ob->name;
1018		1411
1019	$pl->{deny_save} = 1;	1412	$pl->{deny_save} = 1;
1020	$pl->password ("*"); # this should lock out the player until we nuked the dir	1413	$pl->password ("*"); # this should lock out the player until we nuked the dir
1021		1414
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1415	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1027	my $path = playerdir $pl;	1420	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1421	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1422	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1423	delete $cf::PLAYER{$pl->ob->name};
1031	$pl->destroy;	1424	$pl->destroy;
		1425
		1426	my $prefix = qr<^~\Q$name\E/>;
		1427
		1428	# nuke player maps
		1429	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1430
1032	IO::AIO::aio_rmtree $temp;	1431	IO::AIO::aio_rmtree $temp;
		1432	}
		1433
		1434	=item $pl->kick
		1435
		1436	Kicks a player out of the game. This destroys the connection.
		1437
		1438	=cut
		1439
		1440	sub kick {
		1441	my ($pl, $kicker) = @_;
		1442
		1443	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1444	$pl->killer ("kicked");
		1445	$pl->ns->destroy;
1033	}	1446	}
1034		1447
1035	=item cf::player::list_logins	1448	=item cf::player::list_logins
1036		1449
1037	Returns am arrayref of all valid playernames in the system, can take a	1450	Returns am arrayref of all valid playernames in the system, can take a
1038	while and may block, so not sync_job-capable, ever.	1451	while and may block, so not sync_job-capable, ever.
1039		1452
1040	=cut	1453	=cut
1041		1454
1042	sub list_logins {	1455	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1456	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1457	or return [];
1045		1458
1046	my @logins;	1459	my @logins;
1047		1460
1048	for my $login (@$dirs) {	1461	for my $login (@$dirs) {
		1462	my $path = path $login;
		1463
		1464	# a .pst is a dead give-away for a valid player
		1465	unless (-e "$path.pst") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1466	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1467	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1468	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1469	}
1052		1470
1053	utf8::decode $login;	1471	utf8::decode $login;
1054	push @logins, $login;	1472	push @logins, $login;
1055	}	1473	}
1056		1474
…		…
1064		1482
1065	=cut	1483	=cut
1066		1484
1067	sub maps($) {	1485	sub maps($) {
1068	my ($pl) = @_;	1486	my ($pl) = @_;
		1487
		1488	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1489
1070	my $files = aio_readdir playerdir $pl	1490	my $files = aio_readdir playerdir $pl
1071	or return;	1491	or return;
1072		1492
1073	my @paths;	1493	my @paths;
…		…
1075	for (@$files) {	1495	for (@$files) {
1076	utf8::decode $_;	1496	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1497	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1498	next unless /^$PATH_SEP/o;
1079		1499
1080	s/\.map$//;	1500	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1501	}
1083		1502
1084	\@paths	1503	\@paths
1085	}	1504	}
1086		1505
		1506	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1507
		1508	Expand crossfire pod fragments into protocol xml.
		1509
		1510	=cut
		1511
		1512	sub expand_cfpod {
		1513	((my $self), (local $_)) = @_;
		1514
		1515	# escape & and <
		1516	s/&/&amp;/g;
		1517	s/(?<![BIUGHT])</&lt;/g;
		1518
		1519	# this is buggy, it needs to properly take care of nested <'s
		1520
		1521	1 while
		1522	# replace B<>, I<>, U<> etc.
		1523	s/B<([^\>]*)>/<b>$1<\/b>/
		1524	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1525	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1526	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1527	# replace G<male|female> tags
		1528	|| s{G<([^>|]*)\|([^>]*)>}{
		1529	$self->gender ? $2 : $1
		1530	}ge
		1531	# replace H<hint text>
		1532	|| s{H<([^\>]*)>}
		1533	{
		1534	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1535	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1536	"")
		1537	[$self->{hintmode}]
		1538	}ge;
		1539
		1540	# create single paragraphs (very hackish)
		1541	s/(?<=\S)\n(?=\w)/ /g;
		1542
		1543	# compress some whitespace
		1544	s/\s+\n/\n/g; # ws line-ends
		1545	s/\n\n+/\n/g; # double lines
		1546	s/^\n+//; # beginning lines
		1547	s/\n+$//; # ending lines
		1548
		1549	$_
		1550	}
		1551
		1552	sub hintmode {
		1553	$_[0]{hintmode} = $_[1] if @_ > 1;
		1554	$_[0]{hintmode}
		1555	}
		1556
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1557	=item $player->ext_reply ($msgid, @msg)
1088		1558
1089	Sends an ext reply to the player.	1559	Sends an ext reply to the player.
1090		1560
1091	=cut	1561	=cut
1092		1562
1093	sub ext_reply($$$%) {	1563	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1564	my ($self, $id, @msg) = @_;
1095		1565
1096	$msg{msgid} = $id;	1566	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1567	}
1100		1568
1101	package cf;	1569	=item $player->ext_msg ($type, @msg)
		1570
		1571	Sends an ext event to the client.
		1572
		1573	=cut
		1574
		1575	sub ext_msg($$@) {
		1576	my ($self, $type, @msg) = @_;
		1577
		1578	$self->ns->ext_msg ($type, @msg);
		1579	}
		1580
		1581	=head3 cf::region
		1582
		1583	=over 4
		1584
		1585	=cut
		1586
		1587	package cf::region;
		1588
		1589	=item cf::region::find_by_path $path
		1590
		1591	Tries to decuce the likely region for a map knowing only its path.
		1592
		1593	=cut
		1594
		1595	sub find_by_path($) {
		1596	my ($path) = @_;
		1597
		1598	my ($match, $specificity);
		1599
		1600	for my $region (list) {
		1601	if ($region->{match} && $path =~ $region->{match}) {
		1602	($match, $specificity) = ($region, $region->specificity)
		1603	if $region->specificity > $specificity;
		1604	}
		1605	}
		1606
		1607	$match
		1608	}
1102		1609
1103	=back	1610	=back
1104
1105		1611
1106	=head3 cf::map	1612	=head3 cf::map
1107		1613
1108	=over 4	1614	=over 4
1109		1615
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1643	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1644	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1645	)
1140	}	1646	}
1141		1647
		1648	=item cf::map->register ($regex, $prio)
		1649
		1650	Register a handler for the map path matching the given regex at the
		1651	givne priority (higher is better, built-in handlers have priority 0, the
		1652	default).
		1653
		1654	=cut
		1655
1142	sub register {	1656	sub register {
1143	my (undef, $regex) = @_;	1657	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1658	my $pkg = caller;
1145		1659
1146	no strict;	1660	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1661	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1662
1149	$EXT_MAP{$pkg} = qr<$regex>;	1663	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1664	}
1151		1665
1152	# also paths starting with '/'	1666	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1667	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1668
1155	sub thawer_merge {	1669	sub thawer_merge {
1156	my ($self, $merge) = @_;	1670	my ($self, $merge) = @_;
1157		1671
1158	# we have to keep some variables in memory intact	1672	# we have to keep some variables in memory intact
1159	local $self->{path};	1673	local $self->{path};
1160	local $self->{load_path};	1674	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1675
1164	$self->SUPER::thawer_merge ($merge);	1676	$self->SUPER::thawer_merge ($merge);
1165	}	1677	}
1166		1678
1167	sub normalise {	1679	sub normalise {
1168	my ($path, $base) = @_;	1680	my ($path, $base) = @_;
		1681
		1682	$path = "$path"; # make sure its a string
		1683
		1684	$path =~ s/\.map$//;
1169		1685
1170	# map plan:	1686	# map plan:
1171	#	1687	#
1172	# /! non-realised random map exit (special hack!)	1688	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1689	# {... are special paths that are not being touched
…		…
1201		1717
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1718	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		1719
1204	$path = normalise $path, $base;	1720	$path = normalise $path, $base;
1205		1721
1206	for my $pkg (keys %EXT_MAP) {	1722	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1723	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1724	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1725	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1726	$self->init; # pass $1 etc.
1211	return $self;	1727	return $self;
1212	}	1728	}
1213	}	1729	}
1214		1730
1215	Carp::carp "unable to resolve path '$path'.";	1731	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1732	()
1217	}	1733	}
1218		1734
1219	sub init {	1735	sub init {
1220	my ($self) = @_;	1736	my ($self) = @_;
…		…
1235		1751
1236	# the original (read-only) location	1752	# the original (read-only) location
1237	sub load_path {	1753	sub load_path {
1238	my ($self) = @_;	1754	my ($self) = @_;
1239		1755
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1756	"$MAPDIR/$self->{path}.map"
1241	}	1757	}
1242		1758
1243	# the temporary/swap location	1759	# the temporary/swap location
1244	sub save_path {	1760	sub save_path {
1245	my ($self) = @_;	1761	my ($self) = @_;
1246		1762
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1763	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1764	"$TMPDIR/$path.map"
1249	}	1765	}
1250		1766
1251	# the unique path, undef == no special unique path	1767	# the unique path, undef == no special unique path
1252	sub uniq_path {	1768	sub uniq_path {
1253	my ($self) = @_;	1769	my ($self) = @_;
1254		1770
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1771	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1772	"$UNIQUEDIR/$path"
1257	}	1773	}
1258		1774
1259	# and all this just because we cannot iterate over	1775	# and all this just because we cannot iterate over
1260	# all maps in C++...	1776	# all maps in C++...
1261	sub change_all_map_light {	1777	sub change_all_map_light {
…		…
1263		1779
1264	$_->change_map_light ($change)	1780	$_->change_map_light ($change)
1265	for grep $_->outdoor, values %cf::MAP;	1781	for grep $_->outdoor, values %cf::MAP;
1266	}	1782	}
1267		1783
		1784	sub decay_objects {
		1785	my ($self) = @_;
		1786
		1787	return if $self->{deny_reset};
		1788
		1789	$self->do_decay_objects;
		1790	}
		1791
1268	sub unlink_save {	1792	sub unlink_save {
1269	my ($self) = @_;	1793	my ($self) = @_;
1270		1794
1271	utf8::encode (my $save = $self->save_path);	1795	utf8::encode (my $save = $self->save_path);
1272	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1796	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1275		1799
1276	sub load_header_from($) {	1800	sub load_header_from($) {
1277	my ($self, $path) = @_;	1801	my ($self, $path) = @_;
1278		1802
1279	utf8::encode $path;	1803	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1804	my $f = new_from_file cf::object::thawer $path
1281	or return;	1805	or return;
1282		1806
1283	$self->_load_header ($path)	1807	$self->_load_header ($f)
1284	or return;	1808	or return;
1285		1809
		1810	local $MAP_LOADING{$self->{path}} = $self;
		1811	$f->resolve_delayed_derefs;
		1812
1286	$self->{load_path} = $path;	1813	$self->{load_path} = $path;
1287		1814
1288	1	1815	1
1289	}	1816	}
1290		1817
1291	sub load_orig {	1818	sub load_header_orig {
1292	my ($self) = @_;	1819	my ($self) = @_;
1293		1820
1294	$self->load_header_from ($self->load_path)	1821	$self->load_header_from ($self->load_path)
1295	}	1822	}
1296		1823
1297	sub load_temp {	1824	sub load_header_temp {
1298	my ($self) = @_;	1825	my ($self) = @_;
1299		1826
1300	$self->load_header_from ($self->save_path)	1827	$self->load_header_from ($self->save_path)
		1828	}
		1829
		1830	sub prepare_temp {
		1831	my ($self) = @_;
		1832
		1833	$self->last_access ((delete $self->{last_access})
		1834	|| $cf::RUNTIME); #d#
		1835	# safety
		1836	$self->{instantiate_time} = $cf::RUNTIME
		1837	if $self->{instantiate_time} > $cf::RUNTIME;
		1838	}
		1839
		1840	sub prepare_orig {
		1841	my ($self) = @_;
		1842
		1843	$self->{load_original} = 1;
		1844	$self->{instantiate_time} = $cf::RUNTIME;
		1845	$self->last_access ($cf::RUNTIME);
		1846	$self->instantiate;
1301	}	1847	}
1302		1848
1303	sub load_header {	1849	sub load_header {
1304	my ($self) = @_;	1850	my ($self) = @_;
1305		1851
1306	if ($self->load_temp) {	1852	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1853	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1854	} else {
1313	$self->load_orig	1855	$self->load_header_orig
1314	or return;	1856	or return;
1315		1857	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	1858	}
		1859
		1860	$self->{deny_reset} = 1
		1861	if $self->no_reset;
		1862
		1863	$self->default_region (cf::region::find_by_path $self->{path})
		1864	unless $self->default_region;
1321		1865
1322	1	1866	1
1323	}	1867	}
1324		1868
1325	sub find;	1869	sub find;
1326	sub find {	1870	sub find {
1327	my ($path, $origin) = @_;	1871	my ($path, $origin) = @_;
1328		1872
1329	$path = normalise $path, $origin && $origin->path;	1873	$path = normalise $path, $origin && $origin->path;
1330		1874
		1875	cf::lock_wait "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	1876	cf::lock_wait "map_find:$path";
1332		1877
1333	$cf::MAP{$path} || do {	1878	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";	1879	my $guard1 = cf::lock_acquire "map_find:$path";
		1880	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1881
1335	my $map = new_from_path cf::map $path	1882	my $map = new_from_path cf::map $path
1336	or return;	1883	or return;
1337		1884
1338	$map->{last_save} = $cf::RUNTIME;	1885	$map->{last_save} = $cf::RUNTIME;
1339		1886
1340	$map->load_header	1887	$map->load_header
1341	or return;	1888	or return;
1342		1889
1343	if ($map->should_reset) {	1890	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1344	# doing this can freeze the server in a sync job, obviously	1891	# doing this can freeze the server in a sync job, obviously
1345	#$cf::WAIT_FOR_TICK->wait;	1892	#$cf::WAIT_FOR_TICK->wait;
		1893	undef $guard1;
		1894	undef $guard2;
1346	$map->reset;	1895	$map->reset;
1347	undef $guard;
1348	$map = find $path	1896	return find $path;
1349	or return;
1350	}	1897	}
1351		1898
1352	$cf::MAP{$path} = $map	1899	$cf::MAP{$path} = $map
1353	}	1900	}
1354	}	1901	}
		1902
		1903	sub pre_load { }
		1904	sub post_load { }
1355		1905
1356	sub load {	1906	sub load {
1357	my ($self) = @_;	1907	my ($self) = @_;
1358		1908
		1909	local $self->{deny_reset} = 1; # loading can take a long time
		1910
1359	my $path = $self->{path};	1911	my $path = $self->{path};
		1912
		1913	{
1360	my $guard = cf::lock_acquire "map_load:$path";	1914	my $guard = cf::lock_acquire "map_data:$path";
1361		1915
		1916	return unless $self->valid;
1362	return if $self->in_memory != cf::MAP_SWAPPED;	1917	return unless $self->in_memory == cf::MAP_SWAPPED;
1363		1918
1364	$self->in_memory (cf::MAP_LOADING);	1919	$self->in_memory (cf::MAP_LOADING);
1365		1920
1366	$self->alloc;	1921	$self->alloc;
1367	$self->_load_objects ($self->{load_path}, 1)	1922
		1923	$self->pre_load;
		1924	cf::cede_to_tick;
		1925
		1926	my $f = new_from_file cf::object::thawer $self->{load_path};
		1927	$f->skip_block;
		1928	$self->_load_objects ($f)
1368	or return;	1929	or return;
1369		1930
1370	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1931	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1371	if delete $self->{load_original};	1932	if delete $self->{load_original};
1372		1933
1373	if (my $uniq = $self->uniq_path) {	1934	if (my $uniq = $self->uniq_path) {
1374	utf8::encode $uniq;	1935	utf8::encode $uniq;
1375	if (aio_open $uniq, O_RDONLY, 0) {	1936	unless (aio_stat $uniq) {
		1937	if (my $f = new_from_file cf::object::thawer $uniq) {
1376	$self->clear_unique_items;	1938	$self->clear_unique_items;
1377	$self->_load_objects ($uniq, 0);	1939	$self->_load_objects ($f);
		1940	$f->resolve_delayed_derefs;
		1941	}
1378	}	1942	}
1379	}	1943	}
1380		1944
1381	Coro::cede;	1945	$f->resolve_delayed_derefs;
1382		1946
		1947	cf::cede_to_tick;
1383	# now do the right thing for maps	1948	# now do the right thing for maps
1384	$self->link_multipart_objects;	1949	$self->link_multipart_objects;
1385
1386	unless ($self->{deny_activate}) {
1387	$self->decay_objects;
1388	$self->fix_auto_apply;
1389	$self->update_buttons;
1390	Coro::cede;
1391	$self->set_darkness_map;
1392	$self->difficulty ($self->estimate_difficulty)	1950	$self->difficulty ($self->estimate_difficulty)
1393	unless $self->difficulty;	1951	unless $self->difficulty;
1394	Coro::cede;	1952	cf::cede_to_tick;
		1953
		1954	unless ($self->{deny_activate}) {
		1955	$self->decay_objects;
		1956	$self->fix_auto_apply;
		1957	$self->update_buttons;
		1958	cf::cede_to_tick;
		1959	$self->set_darkness_map;
		1960	cf::cede_to_tick;
1395	$self->activate;	1961	$self->activate;
1396	}	1962	}
1397		1963
		1964	$self->{last_save} = $cf::RUNTIME;
		1965	$self->last_access ($cf::RUNTIME);
		1966
1398	$self->in_memory (cf::MAP_IN_MEMORY);	1967	$self->in_memory (cf::MAP_IN_MEMORY);
		1968	}
		1969
		1970	$self->post_load;
1399	}	1971	}
1400		1972
1401	sub customise_for {	1973	sub customise_for {
1402	my ($self, $ob) = @_;	1974	my ($self, $ob) = @_;
1403		1975
1404	return find "~" . $ob->name . "/" . $self->{path}	1976	return find "~" . $ob->name . "/" . $self->{path}
1405	if $self->per_player;	1977	if $self->per_player;
1406		1978
		1979	# return find "?party/" . $ob->name . "/" . $self->{path}
		1980	# if $self->per_party;
		1981
1407	$self	1982	$self
1408	}	1983	}
1409		1984
1410	# find and load all maps in the 3x3 area around a map	1985	# find and load all maps in the 3x3 area around a map
1411	sub load_diag {	1986	sub load_neighbours {
1412	my ($map) = @_;	1987	my ($map) = @_;
1413		1988
1414	my @diag; # diagonal neighbours	1989	my @neigh; # diagonal neighbours
1415		1990
1416	for (0 .. 3) {	1991	for (0 .. 3) {
1417	my $neigh = $map->tile_path ($_)	1992	my $neigh = $map->tile_path ($_)
1418	or next;	1993	or next;
1419	$neigh = find $neigh, $map	1994	$neigh = find $neigh, $map
1420	or next;	1995	or next;
1421	$neigh->load;	1996	$neigh->load;
1422		1997
		1998	push @neigh,
1423	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1999	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1424	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2000	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1425	}	2001	}
1426		2002
1427	for (@diag) {	2003	for (grep defined $_->[0], @neigh) {
		2004	my ($path, $origin) = @$_;
1428	my $neigh = find @$_	2005	my $neigh = find $path, $origin
1429	or next;	2006	or next;
1430	$neigh->load;	2007	$neigh->load;
1431	}	2008	}
1432	}	2009	}
1433		2010
…		…
1438	}	2015	}
1439		2016
1440	sub do_load_sync {	2017	sub do_load_sync {
1441	my ($map) = @_;	2018	my ($map) = @_;
1442		2019
		2020	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2021	if $Coro::current == $Coro::main;
		2022
1443	cf::sync_job { $map->load };	2023	cf::sync_job { $map->load };
1444	}	2024	}
1445		2025
1446	our %MAP_PREFETCH;	2026	our %MAP_PREFETCH;
1447	our $MAP_PREFETCHER = undef;	2027	our $MAP_PREFETCHER = undef;
1448		2028
1449	sub find_async {	2029	sub find_async {
1450	my ($path, $origin) = @_;	2030	my ($path, $origin, $load) = @_;
1451		2031
1452	$path = normalise $path, $origin && $origin->{path};	2032	$path = normalise $path, $origin && $origin->{path};
1453		2033
1454	if (my $map = $cf::MAP{$path}) {	2034	if (my $map = $cf::MAP{$path}) {
1455	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2035	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1456	}	2036	}
1457		2037
1458	undef $MAP_PREFETCH{$path};	2038	$MAP_PREFETCH{$path} |= $load;
		2039
1459	$MAP_PREFETCHER ||= cf::async {	2040	$MAP_PREFETCHER ||= cf::async {
1460	while (%MAP_PREFETCH) {	2041	while (%MAP_PREFETCH) {
1461	for my $path (keys %MAP_PREFETCH) {	2042	while (my ($k, $v) = each %MAP_PREFETCH) {
1462	my $map = find $path	2043	if (my $map = find $k) {
1463	or next;
1464	$map->load;	2044	$map->load if $v;
		2045	}
1465		2046
1466	delete $MAP_PREFETCH{$path};	2047	delete $MAP_PREFETCH{$k};
1467	}	2048	}
1468	}	2049	}
1469	undef $MAP_PREFETCHER;	2050	undef $MAP_PREFETCHER;
1470	};	2051	};
		2052	$MAP_PREFETCHER->prio (6);
1471		2053
1472	()	2054	()
1473	}	2055	}
1474		2056
1475	sub save {	2057	sub save {
1476	my ($self) = @_;	2058	my ($self) = @_;
1477		2059
1478	my $lock = cf::lock_acquire "map_data:" . $self->path;	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1479		2061
1480	$self->{last_save} = $cf::RUNTIME;	2062	$self->{last_save} = $cf::RUNTIME;
1481		2063
1482	return unless $self->dirty;	2064	return unless $self->dirty;
1483		2065
…		…
1506	my ($self) = @_;	2088	my ($self) = @_;
1507		2089
1508	# save first because save cedes	2090	# save first because save cedes
1509	$self->save;	2091	$self->save;
1510		2092
1511	my $lock = cf::lock_acquire "map_data:" . $self->path;	2093	my $lock = cf::lock_acquire "map_data:$self->{path}";
1512		2094
1513	return if $self->players;	2095	return if $self->players;
1514	return if $self->in_memory != cf::MAP_IN_MEMORY;	2096	return if $self->in_memory != cf::MAP_IN_MEMORY;
1515	return if $self->{deny_save};	2097	return if $self->{deny_save};
1516		2098
		2099	$self->in_memory (cf::MAP_SWAPPED);
		2100
		2101	$self->deactivate;
		2102	$_->clear_links_to ($self) for values %cf::MAP;
1517	$self->clear;	2103	$self->clear;
1518	$self->in_memory (cf::MAP_SWAPPED);
1519	}	2104	}
1520		2105
1521	sub reset_at {	2106	sub reset_at {
1522	my ($self) = @_;	2107	my ($self) = @_;
1523		2108
1524	# TODO: safety, remove and allow resettable per-player maps	2109	# TODO: safety, remove and allow resettable per-player maps
1525	return 1e99 if $self->isa ("ext::map_per_player");#d#
1526	return 1e99 if $self->{deny_reset};	2110	return 1e99 if $self->{deny_reset};
1527		2111
1528	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2112	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2113	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1530		2114
…		…
1541	my ($self) = @_;	2125	my ($self) = @_;
1542		2126
1543	my $lock = cf::lock_acquire "map_data:$self->{path}";	2127	my $lock = cf::lock_acquire "map_data:$self->{path}";
1544		2128
1545	return if $self->players;	2129	return if $self->players;
1546	return if $self->isa ("ext::map_per_player");#d#
1547		2130
1548	warn "resetting map ", $self->path;#d#	2131	warn "resetting map ", $self->path;
		2132
		2133	$self->in_memory (cf::MAP_SWAPPED);
		2134
		2135	# need to save uniques path
		2136	unless ($self->{deny_save}) {
		2137	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2138
		2139	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2140	if $uniq;
		2141	}
1549		2142
1550	delete $cf::MAP{$self->path};	2143	delete $cf::MAP{$self->path};
1551		2144
1552	$self->in_memory (cf::MAP_SWAPPED);	2145	$self->deactivate;
		2146	$_->clear_links_to ($self) for values %cf::MAP;
1553	$self->clear;	2147	$self->clear;
1554
1555	$_->clear_links_to ($self) for values %cf::MAP;
1556		2148
1557	$self->unlink_save;	2149	$self->unlink_save;
1558	$self->destroy;	2150	$self->destroy;
1559	}	2151	}
1560		2152
1561	my $nuke_counter = "aaaa";	2153	my $nuke_counter = "aaaa";
1562		2154
1563	sub nuke {	2155	sub nuke {
1564	my ($self) = @_;	2156	my ($self) = @_;
1565		2157
		2158	{
		2159	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2160
1566	delete $cf::MAP{$self->path};	2161	delete $cf::MAP{$self->path};
1567		2162
1568	$self->unlink_save;	2163	$self->unlink_save;
1569		2164
1570	bless $self, "cf::map";	2165	bless $self, "cf::map";
1571	delete $self->{deny_reset};	2166	delete $self->{deny_reset};
1572	$self->{deny_save} = 1;	2167	$self->{deny_save} = 1;
1573	$self->reset_timeout (1);	2168	$self->reset_timeout (1);
1574	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2169	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1575		2170
1576	$cf::MAP{$self->path} = $self;	2171	$cf::MAP{$self->path} = $self;
		2172	}
1577		2173
1578	$self->reset; # polite request, might not happen	2174	$self->reset; # polite request, might not happen
		2175	}
		2176
		2177	=item $maps = cf::map::tmp_maps
		2178
		2179	Returns an arrayref with all map paths of currently instantiated and saved
		2180	maps. May block.
		2181
		2182	=cut
		2183
		2184	sub tmp_maps() {
		2185	[
		2186	map {
		2187	utf8::decode $_;
		2188	/\.map$/
		2189	? normalise $_
		2190	: ()
		2191	} @{ aio_readdir $TMPDIR or [] }
		2192	]
		2193	}
		2194
		2195	=item $maps = cf::map::random_maps
		2196
		2197	Returns an arrayref with all map paths of currently instantiated and saved
		2198	random maps. May block.
		2199
		2200	=cut
		2201
		2202	sub random_maps() {
		2203	[
		2204	map {
		2205	utf8::decode $_;
		2206	/\.map$/
		2207	? normalise "?random/$_"
		2208	: ()
		2209	} @{ aio_readdir $RANDOMDIR or [] }
		2210	]
1579	}	2211	}
1580		2212
1581	=item cf::map::unique_maps	2213	=item cf::map::unique_maps
1582		2214
1583	Returns an arrayref of paths of all shared maps that have	2215	Returns an arrayref of paths of all shared maps that have
1584	instantiated unique items. May block.	2216	instantiated unique items. May block.
1585		2217
1586	=cut	2218	=cut
1587		2219
1588	sub unique_maps() {	2220	sub unique_maps() {
1589	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2221	[
1590	or return;	2222	map {
1591
1592	my @paths;
1593
1594	for (@$files) {
1595	utf8::decode $_;	2223	utf8::decode $_;
1596	next if /\.pst$/;
1597	next unless /^$PATH_SEP/o;
1598
1599	s/\.map$//;	2224	/\.map$/
1600	push @paths, $_;	2225	? normalise $_
		2226	: ()
		2227	} @{ aio_readdir $UNIQUEDIR or [] }
1601	}	2228	]
1602
1603	\@paths
1604	}	2229	}
1605		2230
1606	package cf;	2231	package cf;
1607		2232
1608	=back	2233	=back
…		…
1626	map { $_, inv_recursive_ $_->inv } @_	2251	map { $_, inv_recursive_ $_->inv } @_
1627	}	2252	}
1628		2253
1629	sub inv_recursive {	2254	sub inv_recursive {
1630	inv_recursive_ inv $_[0]	2255	inv_recursive_ inv $_[0]
		2256	}
		2257
		2258	=item $ref = $ob->ref
		2259
		2260	creates and returns a persistent reference to an objetc that can be stored as a string.
		2261
		2262	=item $ob = cf::object::deref ($refstring)
		2263
		2264	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2265	even if the object actually exists. May block.
		2266
		2267	=cut
		2268
		2269	sub deref {
		2270	my ($ref) = @_;
		2271
		2272	# temporary compatibility#TODO#remove
		2273	$ref =~ s{^<}{player/<};
		2274
		2275	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2276	my ($uuid, $name) = ($1, $2);
		2277	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2278	or return;
		2279	$pl->ob->uuid eq $uuid
		2280	or return;
		2281
		2282	$pl->ob
		2283	} else {
		2284	warn "$ref: cannot resolve object reference\n";
		2285	undef
		2286	}
1631	}	2287	}
1632		2288
1633	package cf;	2289	package cf;
1634		2290
1635	=back	2291	=back
…		…
1654		2310
1655	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2311	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1656		2312
1657	if ($self->{record_replies}) {	2313	if ($self->{record_replies}) {
1658	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2314	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2315
1659	} else {	2316	} else {
		2317	my $pl = $self->contr;
		2318
		2319	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2320	my $dialog = $pl->{npc_dialog};
		2321	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2322
		2323	} else {
1660	$msg = $npc->name . " says: $msg" if $npc;	2324	$msg = $npc->name . " says: $msg" if $npc;
1661	$self->message ($msg, $flags);	2325	$self->message ($msg, $flags);
		2326	}
1662	}	2327	}
		2328	}
		2329
		2330	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2331
		2332	=cut
		2333
		2334	sub cf::object::send_msg {
		2335	my $pl = shift->contr
		2336	or return;
		2337	$pl->send_msg (@_);
1663	}	2338	}
1664		2339
1665	=item $player_object->may ("access")	2340	=item $player_object->may ("access")
1666		2341
1667	Returns wether the given player is authorized to access resource "access"	2342	Returns wether the given player is authorized to access resource "access"
…		…
1699	=cut	2374	=cut
1700		2375
1701	sub link_map {	2376	sub link_map {
1702	unless ($LINK_MAP) {	2377	unless ($LINK_MAP) {
1703	$LINK_MAP = cf::map::find "{link}"	2378	$LINK_MAP = cf::map::find "{link}"
1704	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2379	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1705	$LINK_MAP->load;	2380	$LINK_MAP->load;
1706	}	2381	}
1707		2382
1708	$LINK_MAP	2383	$LINK_MAP
1709	}	2384	}
…		…
1714	$self->deactivate_recursive;	2389	$self->deactivate_recursive;
1715		2390
1716	return if UNIVERSAL::isa $self->map, "ext::map_link";	2391	return if UNIVERSAL::isa $self->map, "ext::map_link";
1717		2392
1718	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2393	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719	if $self->map;	2394	if $self->map && $self->map->{path} ne "{link}";
1720		2395
1721	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2396	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1722	}	2397	}
1723		2398
1724	sub cf::object::player::leave_link {	2399	sub cf::object::player::leave_link {
1725	my ($self, $map, $x, $y) = @_;	2400	my ($self, $map, $x, $y) = @_;
		2401
		2402	return unless $self->contr->active;
1726		2403
1727	my $link_pos = delete $self->{_link_pos};	2404	my $link_pos = delete $self->{_link_pos};
1728		2405
1729	unless ($map) {	2406	unless ($map) {
1730	# restore original map position	2407	# restore original map position
…		…
1744	# use -1 or undef as default coordinates, not 0, 0	2421	# use -1 or undef as default coordinates, not 0, 0
1745	($x, $y) = ($map->enter_x, $map->enter_y)	2422	($x, $y) = ($map->enter_x, $map->enter_y)
1746	if $x <=0 && $y <= 0;	2423	if $x <=0 && $y <= 0;
1747		2424
1748	$map->load;	2425	$map->load;
1749	$map->load_diag;	2426	$map->load_neighbours;
1750		2427
1751	return unless $self->contr->active;	2428	return unless $self->contr->active;
1752	$self->activate_recursive;	2429	$self->activate_recursive;
		2430
		2431	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1753	$self->enter_map ($map, $x, $y);	2432	$self->enter_map ($map, $x, $y);
1754	}	2433	}
1755		2434
1756	cf::player->attach (	2435	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1757	on_logout => sub {
1758	my ($pl) = @_;
1759		2436
1760	# abort map switching before logout	2437	Moves the player to the given map-path and coordinates by first freezing
1761	if ($pl->ob->{_link_pos}) {	2438	her, loading and preparing them map, calling the provided $check callback
1762	cf::sync_job {	2439	that has to return the map if sucecssful, and then unfreezes the player on
1763	$pl->ob->leave_link	2440	the new (success) or old (failed) map position. In either case, $done will
1764	};	2441	be called at the end of this process.
1765	}
1766	},
1767	on_login => sub {
1768	my ($pl) = @_;
1769		2442
1770	# try to abort aborted map switching on player login :)
1771	# should happen only on crashes
1772	if ($pl->ob->{_link_pos}) {
1773	$pl->ob->enter_link;
1774	(async {
1775	# we need this sleep as the login has a concurrent enter_exit running
1776	# and this sleep increases chances of the player not ending up in scorn
1777	$pl->ob->reply (undef,
1778	"There was an internal problem at your last logout, "
1779	. "the server will try to bring you to your intended destination in a second.",
1780	cf::NDI_RED);
1781	Coro::Timer::sleep 1;
1782	$pl->ob->leave_link;
1783	})->prio (2);
1784	}
1785	},
1786	);
1787
1788	=item $player_object->goto ($path, $x, $y)
1789
1790	=cut	2443	=cut
		2444
		2445	our $GOTOGEN;
1791		2446
1792	sub cf::object::player::goto {	2447	sub cf::object::player::goto {
1793	my ($self, $path, $x, $y) = @_;	2448	my ($self, $path, $x, $y, $check, $done) = @_;
		2449
		2450	# do generation counting so two concurrent goto's will be executed in-order
		2451	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1794		2452
1795	$self->enter_link;	2453	$self->enter_link;
1796		2454
1797	(async {	2455	(async {
1798	my $map = cf::map::find $path;	2456	# *tag paths override both path and x|y
		2457	if ($path =~ /^\*(.*)$/) {
		2458	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2459	my $ob = $obs[rand @obs];
		2460
		2461	# see if we actually can go there
		2462	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2463	$ob = $obs[rand @obs];
		2464	} else {
		2465	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2466	}
		2467	# else put us there anyways for now #d#
		2468
		2469	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2470	} else {
		2471	($path, $x, $y) = (undef, undef, undef);
		2472	}
		2473	}
		2474
		2475	my $map = eval {
		2476	my $map = defined $path ? cf::map::find $path : undef;
		2477
		2478	if ($map) {
1799	$map = $map->customise_for ($self) if $map;	2479	$map = $map->customise_for ($self);
1800		2480	$map = $check->($map) if $check && $map;
1801	# warn "entering ", $map->path, " at ($x, $y)\n"	2481	} else {
1802	# if $map;
1803
1804	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2482	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2483	}
1805		2484
		2485	$map
		2486	};
		2487
		2488	if ($@) {
		2489	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2490	LOG llevError | logBacktrace, Carp::longmess $@;
		2491	}
		2492
		2493	if ($gen == $self->{_goto_generation}) {
		2494	delete $self->{_goto_generation};
1806	$self->leave_link ($map, $x, $y);	2495	$self->leave_link ($map, $x, $y);
		2496	}
		2497
		2498	$done->() if $done;
1807	})->prio (1);	2499	})->prio (1);
1808	}	2500	}
1809		2501
1810	=item $player_object->enter_exit ($exit_object)	2502	=item $player_object->enter_exit ($exit_object)
1811		2503
…		…
1840	# that depends on the exit object	2532	# that depends on the exit object
1841		2533
1842	my $rmp = parse_random_map_params $exit->msg;	2534	my $rmp = parse_random_map_params $exit->msg;
1843		2535
1844	if ($exit->map) {	2536	if ($exit->map) {
1845	$rmp->{region} = $exit->map->region_name;	2537	$rmp->{region} = $exit->region->name;
1846	$rmp->{origin_map} = $exit->map->path;	2538	$rmp->{origin_map} = $exit->map->path;
1847	$rmp->{origin_x} = $exit->x;	2539	$rmp->{origin_x} = $exit->x;
1848	$rmp->{origin_y} = $exit->y;	2540	$rmp->{origin_y} = $exit->y;
1849	}	2541	}
1850		2542
1851	$rmp->{random_seed} ||= $exit->random_seed;	2543	$rmp->{random_seed} ||= $exit->random_seed;
1852		2544
1853	my $data = cf::to_json $rmp;	2545	my $data = cf::to_json $rmp;
1854	my $md5 = Digest::MD5::md5_hex $data;	2546	my $md5 = Digest::MD5::md5_hex $data;
1855	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2547	my $meta = "$RANDOMDIR/$md5.meta";
1856		2548
1857	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2549	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1858	aio_write $fh, 0, (length $data), $data, 0;	2550	aio_write $fh, 0, (length $data), $data, 0;
1859	undef $fh;	2551	undef $fh;
1860	aio_rename "$meta~", $meta;	2552	aio_rename "$meta~", $meta;
…		…
1867	sub cf::object::player::enter_exit {	2559	sub cf::object::player::enter_exit {
1868	my ($self, $exit) = @_;	2560	my ($self, $exit) = @_;
1869		2561
1870	return unless $self->type == cf::PLAYER;	2562	return unless $self->type == cf::PLAYER;
1871		2563
		2564	if ($exit->slaying eq "/!") {
		2565	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2566	# the problem is that $exit might not survive long enough
		2567	# so it needs to be done right now, right here
		2568	cf::sync_job { prepare_random_map $exit };
		2569	}
		2570
		2571	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2572	my $hp = $exit->stats->hp;
		2573	my $sp = $exit->stats->sp;
		2574
1872	$self->enter_link;	2575	$self->enter_link;
		2576
		2577	# if exit is damned, update players death & WoR home-position
		2578	$self->contr->savebed ($slaying, $hp, $sp)
		2579	if $exit->flag (FLAG_DAMNED);
1873		2580
1874	(async {	2581	(async {
1875	$self->deactivate_recursive; # just to be sure	2582	$self->deactivate_recursive; # just to be sure
1876	unless (eval {	2583	unless (eval {
1877	prepare_random_map $exit	2584	$self->goto ($slaying, $hp, $sp);
1878	if $exit->slaying eq "/!";
1879
1880	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1881	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1882		2585
1883	1;	2586	1;
1884	}) {	2587	}) {
1885	$self->message ("Something went wrong deep within the crossfire server. "	2588	$self->message ("Something went wrong deep within the crossfire server. "
1886	. "I'll try to bring you back to the map you were before. "	2589	. "I'll try to bring you back to the map you were before. "
1887	. "Please report this to the dungeon master!",	2590	. "Please report this to the dungeon master!",
1888	cf::NDI_UNIQUE | cf::NDI_RED);	2591	cf::NDI_UNIQUE | cf::NDI_RED);
1889		2592
1890	warn "ERROR in enter_exit: $@";	2593	warn "ERROR in enter_exit: $@";
1891	$self->leave_link;	2594	$self->leave_link;
1892	}	2595	}
1893	})->prio (1);	2596	})->prio (1);
…		…
1906		2609
1907	sub cf::client::send_drawinfo {	2610	sub cf::client::send_drawinfo {
1908	my ($self, $text, $flags) = @_;	2611	my ($self, $text, $flags) = @_;
1909		2612
1910	utf8::encode $text;	2613	utf8::encode $text;
1911	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2614	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1912	}	2615	}
1913		2616
		2617	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2618
		2619	Send a drawinfo or msg packet to the client, formatting the msg for the
		2620	client if neccessary. C<$type> should be a string identifying the type of
		2621	the message, with C<log> being the default. If C<$color> is negative, suppress
		2622	the message unless the client supports the msg packet.
		2623
		2624	=cut
		2625
		2626	our %CHANNEL = (
		2627	"c/identify" => {
		2628	id => "identify",
		2629	title => "Identify",
		2630	reply => undef,
		2631	tooltip => "Items recently identified",
		2632	},
		2633	"c/examine" => {
		2634	id => "examine",
		2635	title => "Examine",
		2636	reply => undef,
		2637	tooltip => "Signs and other items you examined",
		2638	},
		2639	);
		2640
		2641	sub cf::client::send_msg {
		2642	my ($self, $channel, $msg, $color, @extra) = @_;
		2643
		2644	$msg = $self->pl->expand_cfpod ($msg);
		2645
		2646	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2647
		2648	# check predefined channels, for the benefit of C
		2649	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2650
		2651	if (ref $channel) {
		2652	# send meta info to client, if not yet sent
		2653	unless (exists $self->{channel}{$channel->{id}}) {
		2654	$self->{channel}{$channel->{id}} = $channel;
		2655	$self->ext_msg (channel_info => $channel)
		2656	if $self->can_msg;
		2657	}
		2658
		2659	$channel = $channel->{id};
		2660	}
		2661
		2662	return unless @extra || length $msg;
		2663
		2664	if ($self->can_msg) {
		2665	# default colour, mask it out
		2666	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2667	if $color & cf::NDI_DEF;
		2668
		2669	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2670	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2671	} else {
		2672	if ($color >= 0) {
		2673	# replace some tags by gcfclient-compatible ones
		2674	for ($msg) {
		2675	1 while
		2676	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2677	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2678	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2679	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2680	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2681	}
		2682
		2683	$color &= cf::NDI_COLOR_MASK;
		2684
		2685	utf8::encode $msg;
		2686
		2687	if (0 && $msg =~ /\[/) {
		2688	# COMMAND/INFO
		2689	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2690	} else {
		2691	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2692	$self->send_packet ("drawinfo $color $msg")
		2693	}
		2694	}
		2695	}
		2696	}
		2697
		2698	=item $client->ext_msg ($type, @msg)
		2699
		2700	Sends an ext event to the client.
		2701
		2702	=cut
		2703
		2704	sub cf::client::ext_msg($$@) {
		2705	my ($self, $type, @msg) = @_;
		2706
		2707	if ($self->extcmd == 2) {
		2708	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2709	} elsif ($self->extcmd == 1) { # TODO: remove
		2710	push @msg, msgtype => "event_$type";
		2711	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2712	}
		2713	}
		2714
		2715	=item $client->ext_reply ($msgid, @msg)
		2716
		2717	Sends an ext reply to the client.
		2718
		2719	=cut
		2720
		2721	sub cf::client::ext_reply($$@) {
		2722	my ($self, $id, @msg) = @_;
		2723
		2724	if ($self->extcmd == 2) {
		2725	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2726	} elsif ($self->extcmd == 1) {
		2727	#TODO: version 1, remove
		2728	unshift @msg, msgtype => "reply", msgid => $id;
		2729	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2730	}
		2731	}
1914		2732
1915	=item $success = $client->query ($flags, "text", \&cb)	2733	=item $success = $client->query ($flags, "text", \&cb)
1916		2734
1917	Queues a query to the client, calling the given callback with	2735	Queues a query to the client, calling the given callback with
1918	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2736	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1919	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2737	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1920		2738
1921	Queries can fail, so check the return code. Or don't, as queries will become	2739	Queries can fail, so check the return code. Or don't, as queries will
1922	reliable at some point in the future.	2740	become reliable at some point in the future.
1923		2741
1924	=cut	2742	=cut
1925		2743
1926	sub cf::client::query {	2744	sub cf::client::query {
1927	my ($self, $flags, $text, $cb) = @_;	2745	my ($self, $flags, $text, $cb) = @_;
…		…
1935	utf8::encode $text;	2753	utf8::encode $text;
1936	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2754	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1937		2755
1938	$self->send_packet ($self->{query_queue}[0][0])	2756	$self->send_packet ($self->{query_queue}[0][0])
1939	if @{ $self->{query_queue} } == 1;	2757	if @{ $self->{query_queue} } == 1;
		2758
		2759	1
1940	}	2760	}
1941		2761
1942	cf::client->attach (	2762	cf::client->attach (
		2763	on_connect => sub {
		2764	my ($ns) = @_;
		2765
		2766	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2767	},
1943	on_reply => sub {	2768	on_reply => sub {
1944	my ($ns, $msg) = @_;	2769	my ($ns, $msg) = @_;
1945		2770
1946	# this weird shuffling is so that direct followup queries	2771	# this weird shuffling is so that direct followup queries
1947	# get handled first	2772	# get handled first
1948	my $queue = delete $ns->{query_queue}	2773	my $queue = delete $ns->{query_queue}
1949	or return; # be conservative, not sure how that can happen, but we saw a crash here	2774	or return; # be conservative, not sure how that can happen, but we saw a crash here
1950		2775
1951	(shift @$queue)->[1]->($msg);	2776	(shift @$queue)->[1]->($msg);
		2777	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1952		2778
1953	push @{ $ns->{query_queue} }, @$queue;	2779	push @{ $ns->{query_queue} }, @$queue;
1954		2780
1955	if (@{ $ns->{query_queue} } == @$queue) {	2781	if (@{ $ns->{query_queue} } == @$queue) {
1956	if (@$queue) {	2782	if (@$queue) {
…		…
1958	} else {	2784	} else {
1959	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2785	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1960	}	2786	}
1961	}	2787	}
1962	},	2788	},
		2789	on_exticmd => sub {
		2790	my ($ns, $buf) = @_;
		2791
		2792	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2793
		2794	if (ref $msg) {
		2795	my ($type, $reply, @payload) =
		2796	"ARRAY" eq ref $msg
		2797	? @$msg
		2798	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2799
		2800	my @reply;
		2801
		2802	if (my $cb = $EXTICMD{$type}) {
		2803	@reply = $cb->($ns, @payload);
		2804	}
		2805
		2806	$ns->ext_reply ($reply, @reply)
		2807	if $reply;
		2808
		2809	} else {
		2810	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2811	}
		2812
		2813	cf::override;
		2814	},
1963	);	2815	);
1964		2816
1965	=item $client->async (\&cb)	2817	=item $client->async (\&cb)
1966		2818
1967	Create a new coroutine, running the specified callback. The coroutine will	2819	Create a new coroutine, running the specified callback. The coroutine will
…		…
2008	our $safe = new Safe "safe";	2860	our $safe = new Safe "safe";
2009	our $safe_hole = new Safe::Hole;	2861	our $safe_hole = new Safe::Hole;
2010		2862
2011	$SIG{FPE} = 'IGNORE';	2863	$SIG{FPE} = 'IGNORE';
2012		2864
2013	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2865	$safe->permit_only (Opcode::opset qw(
		2866	:base_core :base_mem :base_orig :base_math
		2867	grepstart grepwhile mapstart mapwhile
		2868	sort time
		2869	));
2014		2870
2015	# here we export the classes and methods available to script code	2871	# here we export the classes and methods available to script code
2016		2872
2017	=pod	2873	=pod
2018		2874
2019	The following fucntions and emthods are available within a safe environment:	2875	The following functions and methods are available within a safe environment:
2020		2876
2021	cf::object contr pay_amount pay_player map	2877	cf::object
		2878	contr pay_amount pay_player map x y force_find force_add
		2879	insert remove name archname title slaying race decrease_ob_nr
		2880
2022	cf::object::player player	2881	cf::object::player
2023	cf::player peaceful	2882	player
2024	cf::map trigger	2883
		2884	cf::player
		2885	peaceful
		2886
		2887	cf::map
		2888	trigger
2025		2889
2026	=cut	2890	=cut
2027		2891
2028	for (	2892	for (
2029	["cf::object" => qw(contr pay_amount pay_player map)],	2893	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2894	insert remove inv name archname title slaying race
		2895	decrease_ob_nr)],
2030	["cf::object::player" => qw(player)],	2896	["cf::object::player" => qw(player)],
2031	["cf::player" => qw(peaceful)],	2897	["cf::player" => qw(peaceful)],
2032	["cf::map" => qw(trigger)],	2898	["cf::map" => qw(trigger)],
2033	) {	2899	) {
2034	no strict 'refs';	2900	no strict 'refs';
…		…
2105	=back	2971	=back
2106		2972
2107	=cut	2973	=cut
2108		2974
2109	#############################################################################	2975	#############################################################################
		2976	# the server's init and main functions
2110		2977
2111	=head2 EXTENSION DATABASE SUPPORT	2978	sub load_facedata($) {
		2979	my ($path) = @_;
2112		2980
2113	Crossfire maintains a very simple database for extension use. It can	2981	# HACK to clear player env face cache, we need some signal framework
2114	currently store anything that can be serialised using Storable, which	2982	# for this (global event?)
2115	excludes objects.	2983	%ext::player_env::MUSIC_FACE_CACHE = ();
2116		2984
2117	The parameter C<$family> should best start with the name of the extension	2985	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2118	using it, it should be unique.
2119		2986
2120	=over 4	2987	warn "loading facedata from $path\n";
2121		2988
2122	=item $hashref = cf::db_get $family	2989	my $facedata;
		2990	0 < aio_load $path, $facedata
		2991	or die "$path: $!";
2123		2992
2124	Return a hashref for use by the extension C<$family>, which can be	2993	$facedata = Coro::Storable::thaw $facedata;
2125	modified. After modifications, you have to call C<cf::db_dirty> or
2126	C<cf::db_sync>.
2127		2994
2128	=item $value = cf::db_get $family => $key	2995	$facedata->{version} == 2
		2996	or cf::cleanup "$path: version mismatch, cannot proceed.";
2129		2997
2130	Returns a single value from the database	2998	# patch in the exptable
2131		2999	$facedata->{resource}{"res/exp_table"} = {
2132	=item cf::db_put $family => $hashref	3000	type => FT_RSRC,
2133		3001	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2134	Stores the given family hashref into the database. Updates are delayed, if
2135	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2136
2137	=item cf::db_put $family => $key => $value
2138
2139	Stores the given C<$value> in the family hash. Updates are delayed, if you
2140	want the data to be synced to disk immediately, use C<cf::db_sync>.
2141
2142	=item cf::db_dirty
2143
2144	Marks the database as dirty, to be updated at a later time.
2145
2146	=item cf::db_sync
2147
2148	Immediately write the database to disk I<if it is dirty>.
2149
2150	=cut
2151
2152	our $DB;
2153
2154	{
2155	my $path = cf::localdir . "/database.pst";
2156
2157	sub db_load() {
2158	$DB = stat $path ? Storable::retrieve $path : { };
2159	}
2160
2161	my $pid;
2162
2163	sub db_save() {
2164	waitpid $pid, 0 if $pid;
2165	if (0 == ($pid = fork)) {
2166	$DB->{_meta}{version} = 1;
2167	Storable::nstore $DB, "$path~";
2168	rename "$path~", $path;
2169	cf::_exit 0 if defined $pid;
2170	}
2171	}
2172
2173	my $dirty;
2174
2175	sub db_sync() {
2176	db_save if $dirty;
2177	undef $dirty;
2178	}
2179
2180	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2181	db_sync;
2182	});	3002	};
		3003	cf::cede_to_tick;
2183		3004
2184	sub db_dirty() {
2185	$dirty = 1;
2186	$idle->start;
2187	}	3005	{
		3006	my $faces = $facedata->{faceinfo};
2188		3007
2189	sub db_get($;$) {	3008	while (my ($face, $info) = each %$faces) {
2190	@_ >= 2	3009	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2191	? $DB->{$_[0]}{$_[1]}	3010	cf::face::set_visibility $idx, $info->{visibility};
2192	: ($DB->{$_[0]} ||= { })	3011	cf::face::set_magicmap $idx, $info->{magicmap};
2193	}	3012	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3013	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2194		3014
2195	sub db_put($$;$) {	3015	cf::cede_to_tick;
2196	if (@_ >= 3) {
2197	$DB->{$_[0]}{$_[1]} = $_[2];
2198	} else {
2199	$DB->{$_[0]} = $_[1];
2200	}
2201	db_dirty;
2202	}
2203
2204	cf::global->attach (
2205	prio => 10000,
2206	on_cleanup => sub {
2207	db_sync;
2208	},	3016	}
2209	);
2210	}
2211		3017
2212	#############################################################################	3018	while (my ($face, $info) = each %$faces) {
2213	# the server's main()	3019	next unless $info->{smooth};
		3020	my $idx = cf::face::find $face
		3021	or next;
		3022	if (my $smooth = cf::face::find $info->{smooth}) {
		3023	cf::face::set_smooth $idx, $smooth;
		3024	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3025	} else {
		3026	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3027	}
2214		3028
2215	sub cfg_load {	3029	cf::cede_to_tick;
		3030	}
		3031	}
		3032
		3033	{
		3034	my $anims = $facedata->{animinfo};
		3035
		3036	while (my ($anim, $info) = each %$anims) {
		3037	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3038	cf::cede_to_tick;
		3039	}
		3040
		3041	cf::anim::invalidate_all; # d'oh
		3042	}
		3043
		3044	{
		3045	# TODO: for gcfclient pleasure, we should give resources
		3046	# that gcfclient doesn't grok a >10000 face index.
		3047	my $res = $facedata->{resource};
		3048
		3049	my $soundconf = delete $res->{"res/sound.conf"};
		3050
		3051	while (my ($name, $info) = each %$res) {
		3052	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3053	my $data;
		3054
		3055	if ($info->{type} & 1) {
		3056	# prepend meta info
		3057
		3058	my $meta = $enc->encode ({
		3059	name => $name,
		3060	%{ $info->{meta} || {} },
		3061	});
		3062
		3063	$data = pack "(w/a*)*", $meta, $info->{data};
		3064	} else {
		3065	$data = $info->{data};
		3066	}
		3067
		3068	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3069	cf::face::set_type $idx, $info->{type};
		3070
		3071	cf::cede_to_tick;
		3072	}
		3073
		3074	if ($soundconf) {
		3075	$soundconf = $enc->decode (delete $soundconf->{data});
		3076
		3077	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3078	my $sound = $soundconf->{compat}[$_]
		3079	or next;
		3080
		3081	my $face = cf::face::find "sound/$sound->[1]";
		3082	cf::sound::set $sound->[0] => $face;
		3083	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3084	}
		3085
		3086	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3087	my $face = cf::face::find "sound/$v";
		3088	cf::sound::set $k => $face;
		3089	}
		3090	}
		3091	}
		3092
		3093	1
		3094	}
		3095
		3096	register_exticmd fx_want => sub {
		3097	my ($ns, $want) = @_;
		3098
		3099	while (my ($k, $v) = each %$want) {
		3100	$ns->fx_want ($k, $v);
		3101	}
		3102	};
		3103
		3104	sub reload_regions {
		3105	# HACK to clear player env face cache, we need some signal framework
		3106	# for this (global event?)
		3107	%ext::player_env::MUSIC_FACE_CACHE = ();
		3108
		3109	load_resource_file "$MAPDIR/regions"
		3110	or die "unable to load regions file\n";
		3111
		3112	for (cf::region::list) {
		3113	$_->{match} = qr/$_->{match}/
		3114	if exists $_->{match};
		3115	}
		3116	}
		3117
		3118	sub reload_facedata {
		3119	load_facedata "$DATADIR/facedata"
		3120	or die "unable to load facedata\n";
		3121	}
		3122
		3123	sub reload_archetypes {
		3124	load_resource_file "$DATADIR/archetypes"
		3125	or die "unable to load archetypes\n";
		3126	#d# NEED to laod twice to resolve forward references
		3127	# this really needs to be done in an extra post-pass
		3128	# (which needs to be synchronous, so solve it differently)
		3129	load_resource_file "$DATADIR/archetypes"
		3130	or die "unable to load archetypes\n";
		3131	}
		3132
		3133	sub reload_treasures {
		3134	load_resource_file "$DATADIR/treasures"
		3135	or die "unable to load treasurelists\n";
		3136	}
		3137
		3138	sub reload_resources {
		3139	warn "reloading resource files...\n";
		3140
		3141	reload_regions;
		3142	reload_facedata;
		3143	#reload_archetypes;#d#
		3144	reload_archetypes;
		3145	reload_treasures;
		3146
		3147	warn "finished reloading resource files\n";
		3148	}
		3149
		3150	sub init {
		3151	reload_resources;
		3152	}
		3153
		3154	sub reload_config {
2216	open my $fh, "<:utf8", cf::confdir . "/config"	3155	open my $fh, "<:utf8", "$CONFDIR/config"
2217	or return;	3156	or return;
2218		3157
2219	local $/;	3158	local $/;
2220	*CFG = YAML::Syck::Load <$fh>;	3159	*CFG = YAML::Syck::Load <$fh>;
2221		3160
…		…
2240	(async {	3179	(async {
2241	Event::one_event;	3180	Event::one_event;
2242	})->prio (Coro::PRIO_MAX);	3181	})->prio (Coro::PRIO_MAX);
2243	};	3182	};
2244		3183
2245	cfg_load;	3184	reload_config;
2246	db_load;	3185	db_init;
2247	load_extensions;	3186	load_extensions;
2248		3187
2249	$TICK_WATCHER->start;	3188	$TICK_WATCHER->start;
2250	Event::loop;	3189	Event::loop;
2251	}	3190	}
…		…
2255		3194
2256	# install some emergency cleanup handlers	3195	# install some emergency cleanup handlers
2257	BEGIN {	3196	BEGIN {
2258	for my $signal (qw(INT HUP TERM)) {	3197	for my $signal (qw(INT HUP TERM)) {
2259	Event->signal (	3198	Event->signal (
		3199	reentrant => 0,
2260	data => WF_AUTOCANCEL,	3200	data => WF_AUTOCANCEL,
2261	signal => $signal,	3201	signal => $signal,
		3202	prio => 0,
2262	cb => sub {	3203	cb => sub {
2263	cf::cleanup "SIG$signal";	3204	cf::cleanup "SIG$signal";
2264	},	3205	},
2265	);	3206	);
2266	}	3207	}
		3208	}
		3209
		3210	sub write_runtime {
		3211	my $runtime = "$LOCALDIR/runtime";
		3212
		3213	# first touch the runtime file to show we are still running:
		3214	# the fsync below can take a very very long time.
		3215
		3216	IO::AIO::aio_utime $runtime, undef, undef;
		3217
		3218	my $guard = cf::lock_acquire "write_runtime";
		3219
		3220	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3221	or return;
		3222
		3223	my $value = $cf::RUNTIME + 90 + 10;
		3224	# 10 is the runtime save interval, for a monotonic clock
		3225	# 60 allows for the watchdog to kill the server.
		3226
		3227	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3228	and return;
		3229
		3230	# always fsync - this file is important
		3231	aio_fsync $fh
		3232	and return;
		3233
		3234	# touch it again to show we are up-to-date
		3235	aio_utime $fh, undef, undef;
		3236
		3237	close $fh
		3238	or return;
		3239
		3240	aio_rename "$runtime~", $runtime
		3241	and return;
		3242
		3243	warn "runtime file written.\n";
		3244
		3245	1
2267	}	3246	}
2268		3247
2269	sub emergency_save() {	3248	sub emergency_save() {
2270	my $freeze_guard = cf::freeze_mainloop;	3249	my $freeze_guard = cf::freeze_mainloop;
2271		3250
…		…
2288	my $map = $cf::MAP{$path} or next;	3267	my $map = $cf::MAP{$path} or next;
2289	$map->valid or next;	3268	$map->valid or next;
2290	$map->save;	3269	$map->save;
2291	}	3270	}
2292	warn "end emergency map save\n";	3271	warn "end emergency map save\n";
		3272
		3273	warn "begin emergency database checkpoint\n";
		3274	BDB::db_env_txn_checkpoint $DB_ENV;
		3275	warn "end emergency database checkpoint\n";
2293	};	3276	};
2294		3277
2295	warn "leave emergency perl save\n";	3278	warn "leave emergency perl save\n";
2296	}	3279	}
2297		3280
		3281	sub post_cleanup {
		3282	my ($make_core) = @_;
		3283
		3284	warn Carp::longmess "post_cleanup backtrace"
		3285	if $make_core;
		3286	}
		3287
2298	sub reload() {	3288	sub do_reload_perl() {
2299	# can/must only be called in main	3289	# can/must only be called in main
2300	if ($Coro::current != $Coro::main) {	3290	if ($Coro::current != $Coro::main) {
2301	warn "can only reload from main coroutine";	3291	warn "can only reload from main coroutine";
2302	return;	3292	return;
2303	}	3293	}
2304		3294
2305	warn "reloading...";	3295	warn "reloading...";
2306		3296
2307	warn "cancelling server ticker";	3297	warn "entering sync_job";
2308	$TICK_WATCHER->cancel;
2309		3298
		3299	cf::sync_job {
		3300	cf::write_runtime; # external watchdog should not bark
2310	cf::emergency_save;	3301	cf::emergency_save;
		3302	cf::write_runtime; # external watchdog should not bark
2311		3303
2312	eval {	3304	warn "syncing database to disk";
		3305	BDB::db_env_txn_checkpoint $DB_ENV;
		3306
2313	# if anything goes wrong in here, we should simply crash as we already saved	3307	# if anything goes wrong in here, we should simply crash as we already saved
2314
2315	warn "syncing database to disk";
2316	cf::db_sync;
2317		3308
2318	warn "cancelling all WF_AUTOCANCEL watchers";	3309	warn "cancelling all WF_AUTOCANCEL watchers";
2319	for (Event::all_watchers) {	3310	for (Event::all_watchers) {
2320	$_->cancel if $_->data & WF_AUTOCANCEL;	3311	$_->cancel if $_->data & WF_AUTOCANCEL;
2321	}	3312	}
2322		3313
2323	warn "flushing outstanding aio requests";	3314	warn "flushing outstanding aio requests";
2324	for (;;) {	3315	for (;;) {
		3316	BDB::flush;
2325	IO::AIO::flush;	3317	IO::AIO::flush;
2326	Coro::cede;	3318	Coro::cede;
2327	last unless IO::AIO::nreqs;	3319	last unless IO::AIO::nreqs || BDB::nreqs;
2328	warn "iterate...";	3320	warn "iterate...";
2329	}	3321	}
		3322
		3323	++$RELOAD;
2330		3324
2331	warn "cancelling all extension coros";	3325	warn "cancelling all extension coros";
2332	$_->cancel for values %EXT_CORO;	3326	$_->cancel for values %EXT_CORO;
2333	%EXT_CORO = ();	3327	%EXT_CORO = ();
2334		3328
2335	warn "removing commands";	3329	warn "removing commands";
2336	%COMMAND = ();	3330	%COMMAND = ();
2337		3331
2338	warn "removing ext commands";	3332	warn "removing ext/exti commands";
2339	%EXTCMD = ();	3333	%EXTCMD = ();
		3334	%EXTICMD = ();
2340		3335
2341	warn "unloading/nuking all extensions";	3336	warn "unloading/nuking all extensions";
2342	for my $pkg (@EXTS) {	3337	for my $pkg (@EXTS) {
2343	warn "... unloading $pkg";	3338	warn "... unloading $pkg";
2344		3339
…		…
2374	Symbol::delete_package "safe::$_"	3369	Symbol::delete_package "safe::$_"
2375	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3370	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2376		3371
2377	warn "unloading cf.pm \"a bit\"";	3372	warn "unloading cf.pm \"a bit\"";
2378	delete $INC{"cf.pm"};	3373	delete $INC{"cf.pm"};
		3374	delete $INC{"cf/pod.pm"};
2379		3375
2380	# don't, removes xs symbols, too,	3376	# don't, removes xs symbols, too,
2381	# and global variables created in xs	3377	# and global variables created in xs
2382	#Symbol::delete_package __PACKAGE__;	3378	#Symbol::delete_package __PACKAGE__;
2383		3379
…		…
2386	warn "reloading cf.pm";	3382	warn "reloading cf.pm";
2387	require cf;	3383	require cf;
2388	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3384	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2389		3385
2390	warn "loading config and database again";	3386	warn "loading config and database again";
2391	cf::cfg_load;	3387	cf::reload_config;
2392	cf::db_load;
2393		3388
2394	warn "loading extensions";	3389	warn "loading extensions";
2395	cf::load_extensions;	3390	cf::load_extensions;
2396		3391
2397	warn "reattaching attachments to objects/players";	3392	warn "reattaching attachments to objects/players";
2398	_global_reattach;	3393	_global_reattach; # objects, sockets
2399	warn "reattaching attachments to maps";	3394	warn "reattaching attachments to maps";
2400	reattach $_ for values %MAP;	3395	reattach $_ for values %MAP;
		3396	warn "reattaching attachments to players";
		3397	reattach $_ for values %PLAYER;
2401		3398
2402	warn "restarting server ticker";	3399	warn "leaving sync_job";
2403		3400
2404	$TICK_WATCHER->start;	3401	1
2405	};	3402	} or do {
2406
2407	if ($@) {
2408	warn $@;	3403	warn $@;
2409	warn "error while reloading, exiting.";	3404	warn "error while reloading, exiting.";
2410	exit 1;	3405	exit 1;
2411	}	3406	};
2412		3407
2413	warn "reloaded";	3408	warn "reloaded";
2414	};	3409	};
2415		3410
2416	our $RELOAD_WATCHER; # used only during reload	3411	our $RELOAD_WATCHER; # used only during reload
2417		3412
		3413	sub reload_perl() {
		3414	# doing reload synchronously and two reloads happen back-to-back,
		3415	# coro crashes during coro_state_free->destroy here.
		3416
		3417	$RELOAD_WATCHER ||= Event->timer (
		3418	reentrant => 0,
		3419	after => 0,
		3420	data => WF_AUTOCANCEL,
		3421	cb => sub {
		3422	do_reload_perl;
		3423	undef $RELOAD_WATCHER;
		3424	},
		3425	);
		3426	}
		3427
2418	register_command "reload" => sub {	3428	register_command "reload" => sub {
2419	my ($who, $arg) = @_;	3429	my ($who, $arg) = @_;
2420		3430
2421	if ($who->flag (FLAG_WIZ)) {	3431	if ($who->flag (FLAG_WIZ)) {
2422	$who->message ("reloading server.");	3432	$who->message ("reloading server.");
2423		3433	async { reload_perl };
2424	# doing reload synchronously and two reloads happen back-to-back,
2425	# coro crashes during coro_state_free->destroy here.
2426
2427	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2428	reload;
2429	undef $RELOAD_WATCHER;
2430	});
2431	}	3434	}
2432	};	3435	};
2433		3436
2434	unshift @INC, $LIBDIR;	3437	unshift @INC, $LIBDIR;
2435		3438
2436	my $bug_warning = 0;	3439	my $bug_warning = 0;
		3440
		3441	our @WAIT_FOR_TICK;
		3442	our @WAIT_FOR_TICK_BEGIN;
		3443
		3444	sub wait_for_tick {
		3445	return unless $TICK_WATCHER->is_active;
		3446	return if $Coro::current == $Coro::main;
		3447
		3448	my $signal = new Coro::Signal;
		3449	push @WAIT_FOR_TICK, $signal;
		3450	$signal->wait;
		3451	}
		3452
		3453	sub wait_for_tick_begin {
		3454	return unless $TICK_WATCHER->is_active;
		3455	return if $Coro::current == $Coro::main;
		3456
		3457	my $signal = new Coro::Signal;
		3458	push @WAIT_FOR_TICK_BEGIN, $signal;
		3459	$signal->wait;
		3460	}
2437		3461
2438	$TICK_WATCHER = Event->timer (	3462	$TICK_WATCHER = Event->timer (
2439	reentrant => 0,	3463	reentrant => 0,
2440	parked => 1,	3464	parked => 1,
2441	prio => 0,	3465	prio => 0,
…		…
2446	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3470	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2447	unless ++$bug_warning > 10;	3471	unless ++$bug_warning > 10;
2448	return;	3472	return;
2449	}	3473	}
2450		3474
2451	$NOW = Event::time;	3475	$NOW = $tick_start = Event::time;
2452		3476
2453	cf::server_tick; # one server iteration	3477	cf::server_tick; # one server iteration
		3478
2454	$RUNTIME += $TICK;	3479	$RUNTIME += $TICK;
2455	$NEXT_TICK += $TICK;	3480	$NEXT_TICK += $TICK;
2456		3481
2457	$WAIT_FOR_TICK->broadcast;	3482	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2458	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3483	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3484	Coro::async_pool {
		3485	write_runtime
		3486	or warn "ERROR: unable to write runtime file: $!";
		3487	};
		3488	}
		3489
		3490	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3491	$sig->send;
		3492	}
		3493	while (my $sig = shift @WAIT_FOR_TICK) {
		3494	$sig->send;
		3495	}
		3496
		3497	$NOW = Event::time;
2459		3498
2460	# if we are delayed by four ticks or more, skip them all	3499	# if we are delayed by four ticks or more, skip them all
2461	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3500	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2462		3501
2463	$TICK_WATCHER->at ($NEXT_TICK);	3502	$TICK_WATCHER->at ($NEXT_TICK);
2464	$TICK_WATCHER->start;	3503	$TICK_WATCHER->start;
		3504
		3505	$LOAD = ($NOW - $tick_start) / $TICK;
		3506	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3507
		3508	_post_tick;
2465	},	3509	},
2466	);	3510	);
2467		3511
		3512	{
		3513	BDB::min_parallel 8;
		3514	BDB::max_poll_time $TICK * 0.1;
		3515	$BDB_POLL_WATCHER = Event->io (
		3516	reentrant => 0,
		3517	fd => BDB::poll_fileno,
		3518	poll => 'r',
		3519	prio => 0,
		3520	data => WF_AUTOCANCEL,
		3521	cb => \&BDB::poll_cb,
		3522	);
		3523
		3524	BDB::set_sync_prepare {
		3525	my $status;
		3526	my $current = $Coro::current;
		3527	(
		3528	sub {
		3529	$status = $!;
		3530	$current->ready; undef $current;
		3531	},
		3532	sub {
		3533	Coro::schedule while defined $current;
		3534	$! = $status;
		3535	},
		3536	)
		3537	};
		3538
		3539	unless ($DB_ENV) {
		3540	$DB_ENV = BDB::db_env_create;
		3541	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3542	| BDB::LOG_AUTOREMOVE, 1);
		3543	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3544	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3545
		3546	cf::sync_job {
		3547	eval {
		3548	BDB::db_env_open
		3549	$DB_ENV,
		3550	$BDBDIR,
		3551	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3552	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3553	0666;
		3554
		3555	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3556	};
		3557
		3558	cf::cleanup "db_env_open(db): $@" if $@;
		3559	};
		3560	}
		3561
		3562	$BDB_DEADLOCK_WATCHER = Event->timer (
		3563	after => 3,
		3564	interval => 1,
		3565	hard => 1,
		3566	prio => 0,
		3567	data => WF_AUTOCANCEL,
		3568	cb => sub {
		3569	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3570	},
		3571	);
		3572	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3573	after => 11,
		3574	interval => 60,
		3575	hard => 1,
		3576	prio => 0,
		3577	data => WF_AUTOCANCEL,
		3578	cb => sub {
		3579	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3580	},
		3581	);
		3582	$BDB_TRICKLE_WATCHER = Event->timer (
		3583	after => 5,
		3584	interval => 10,
		3585	hard => 1,
		3586	prio => 0,
		3587	data => WF_AUTOCANCEL,
		3588	cb => sub {
		3589	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3590	},
		3591	);
		3592	}
		3593
		3594	{
		3595	IO::AIO::min_parallel 8;
		3596
		3597	undef $Coro::AIO::WATCHER;
2468	IO::AIO::max_poll_time $TICK * 0.2;	3598	IO::AIO::max_poll_time $TICK * 0.1;
2469
2470	$AIO_POLL_WATCHER = Event->io (	3599	$AIO_POLL_WATCHER = Event->io (
2471	fd => IO::AIO::poll_fileno,	3600	reentrant => 0,
2472	poll => 'r',
2473	prio => 5,
2474	data => WF_AUTOCANCEL,
2475	cb => \&IO::AIO::poll_cb,
2476	);
2477
2478	$WRITE_RUNTIME_WATCHER = Event->timer (
2479	data => WF_AUTOCANCEL,	3601	data => WF_AUTOCANCEL,
2480	after => 1,	3602	fd => IO::AIO::poll_fileno,
2481	interval => 10,	3603	poll => 'r',
2482	cb => Coro::unblock_sub {	3604	prio => 6,
2483	write_runtime	3605	cb => \&IO::AIO::poll_cb,
2484	or warn "ERROR: unable to write runtime file: $!";	3606	);
		3607	}
		3608
		3609	my $_log_backtrace;
		3610
		3611	sub _log_backtrace {
		3612	my ($msg, @addr) = @_;
		3613
		3614	$msg =~ s/\n//;
		3615
		3616	# limit the # of concurrent backtraces
		3617	if ($_log_backtrace < 2) {
		3618	++$_log_backtrace;
		3619	async {
		3620	my @bt = fork_call {
		3621	@addr = map { sprintf "%x", $_ } @addr;
		3622	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3623	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3624	or die "addr2line: $!";
		3625
		3626	my @funcs;
		3627	my @res = <$fh>;
		3628	chomp for @res;
		3629	while (@res) {
		3630	my ($func, $line) = splice @res, 0, 2, ();
		3631	push @funcs, "[$func] $line";
		3632	}
		3633
		3634	@funcs
		3635	};
		3636
		3637	LOG llevInfo, "[ABT] $msg\n";
		3638	LOG llevInfo, "[ABT] $_\n" for @bt;
		3639	--$_log_backtrace;
		3640	};
		3641	} else {
		3642	LOG llevInfo, "[ABT] $msg\n";
		3643	LOG llevInfo, "[ABT] [suppressed]\n";
2485	},	3644	}
2486	);	3645	}
		3646
		3647	# load additional modules
		3648	use cf::pod;
2487		3649
2488	END { cf::emergency_save }	3650	END { cf::emergency_save }
2489		3651
2490	1	3652	1
2491		3653

Diff Legend

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