ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

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

Diff Legend

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