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

Diff Legend

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