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.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 2007 UTC

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

Diff Legend

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