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

Diff Legend

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