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.178 by root, Thu Jan 18 00:06:55 2007 UTC vs.
Revision 1.371 by root, Thu Sep 13 16:16:01 2007 UTC

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

Diff Legend

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