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

Diff Legend

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