ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.147 by root, Mon Jan 8 12:23:33 2007 UTC vs.
Revision 1.396 by root, Wed Nov 14 08:09:46 2007 UTC

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

Diff Legend

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