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.336 by root, Tue Aug 21 00:31:18 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	$self->ns->ext_reply ($id, @msg)
		1511	}
		1512
		1513	=item $player->ext_msg ($type, @msg)
		1514
		1515	Sends an ext event to the client.
		1516
		1517	=cut
		1518
		1519	sub ext_msg($$@) {
		1520	my ($self, $type, @msg) = @_;
		1521
		1522	$self->ns->ext_msg ($type, @msg);
		1523	}
		1524
		1525	=head3 cf::region
		1526
		1527	=over 4
		1528
		1529	=cut
		1530
		1531	package cf::region;
		1532
		1533	=item cf::region::find_by_path $path
		1534
		1535	Tries to decuce the likely region for a map knowing only its path.
		1536
		1537	=cut
		1538
		1539	sub find_by_path($) {
967	my ($path) = @_;	1540	my ($path) = @_;
968		1541
969	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1542	my ($match, $specificity);
970	my $base = $1;
971	my $pkg = $1;
972	$pkg =~ s/[^[:word:]]/_/g;
973	$pkg = "ext::$pkg";
974		1543
975	warn "loading '$path' into '$pkg'\n";	1544	for my $region (list) {
976		1545	if ($region->{match} && $path =~ $region->{match}) {
977	open my $fh, "<:utf8", $path	1546	($match, $specificity) = ($region, $region->specificity)
978	or die "$path: $!";	1547	if $region->specificity > $specificity;
979		1548	}
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	# }	1549	}
1009		1550
1010	# remove commands	1551	$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	}	1552	}
1116		1553
1117	=back	1554	=back
1118
1119		1555
1120	=head3 cf::map	1556	=head3 cf::map
1121		1557
1122	=over 4	1558	=over 4
1123		1559
…		…
1126	package cf::map;	1562	package cf::map;
1127		1563
1128	use Fcntl;	1564	use Fcntl;
1129	use Coro::AIO;	1565	use Coro::AIO;
1130		1566
		1567	use overload
		1568	'""' => \&as_string,
		1569	fallback => 1;
		1570
1131	our $MAX_RESET = 7200;	1571	our $MAX_RESET = 3600;
1132	our $DEFAULT_RESET = 3600;	1572	our $DEFAULT_RESET = 3000;
1133		1573
1134	sub generate_random_map {	1574	sub generate_random_map {
1135	my ($path, $rmp) = @_;	1575	my ($self, $rmp) = @_;
1136
1137	# mit "rum" bekleckern, nicht	1576	# mit "rum" bekleckern, nicht
1138	cf::map::_create_random_map	1577	$self->_create_random_map (
1139	$path,
1140	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1578	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1579	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1580	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143	$rmp->{exit_on_final_map},	1581	$rmp->{exit_on_final_map},
1144	$rmp->{xsize}, $rmp->{ysize},	1582	$rmp->{xsize}, $rmp->{ysize},
1145	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1583	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1584	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1585	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1586	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1587	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150	(cf::region::find $rmp->{region})	1588	(cf::region::find $rmp->{region}), $rmp->{custom}
		1589	)
		1590	}
		1591
		1592	=item cf::map->register ($regex, $prio)
		1593
		1594	Register a handler for the map path matching the given regex at the
		1595	givne priority (higher is better, built-in handlers have priority 0, the
		1596	default).
		1597
		1598	=cut
		1599
		1600	sub register {
		1601	my (undef, $regex, $prio) = @_;
		1602	my $pkg = caller;
		1603
		1604	no strict;
		1605	push @{"$pkg\::ISA"}, __PACKAGE__;
		1606
		1607	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1608	}
		1609
		1610	# also paths starting with '/'
		1611	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1612
		1613	sub thawer_merge {
		1614	my ($self, $merge) = @_;
		1615
		1616	# we have to keep some variables in memory intact
		1617	local $self->{path};
		1618	local $self->{load_path};
		1619
		1620	$self->SUPER::thawer_merge ($merge);
		1621	}
		1622
		1623	sub normalise {
		1624	my ($path, $base) = @_;
		1625
		1626	$path = "$path"; # make sure its a string
		1627
		1628	$path =~ s/\.map$//;
		1629
		1630	# map plan:
		1631	#
		1632	# /! non-realised random map exit (special hack!)
		1633	# {... are special paths that are not being touched
		1634	# ?xxx/... are special absolute paths
		1635	# ?random/... random maps
		1636	# /... normal maps
		1637	# ~user/... per-player map of a specific user
		1638
		1639	$path =~ s/$PATH_SEP/\//go;
		1640
		1641	# treat it as relative path if it starts with
		1642	# something that looks reasonable
		1643	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1644	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1645
		1646	$base =~ s{[^/]+/?$}{};
		1647	$path = "$base/$path";
		1648	}
		1649
		1650	for ($path) {
		1651	redo if s{//}{/};
		1652	redo if s{/\.?/}{/};
		1653	redo if s{/[^/]+/\.\./}{/};
		1654	}
		1655
		1656	$path
		1657	}
		1658
		1659	sub new_from_path {
		1660	my (undef, $path, $base) = @_;
		1661
		1662	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1663
		1664	$path = normalise $path, $base;
		1665
		1666	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1667	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1668	my $self = bless cf::map::new, $pkg;
		1669	$self->{path} = $path; $self->path ($path);
		1670	$self->init; # pass $1 etc.
		1671	return $self;
		1672	}
		1673	}
		1674
		1675	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1676	()
		1677	}
		1678
		1679	sub init {
		1680	my ($self) = @_;
		1681
		1682	$self
		1683	}
		1684
		1685	sub as_string {
		1686	my ($self) = @_;
		1687
		1688	"$self->{path}"
		1689	}
		1690
		1691	# the displayed name, this is a one way mapping
		1692	sub visible_name {
		1693	&as_string
		1694	}
		1695
		1696	# the original (read-only) location
		1697	sub load_path {
		1698	my ($self) = @_;
		1699
		1700	"$MAPDIR/$self->{path}.map"
		1701	}
		1702
		1703	# the temporary/swap location
		1704	sub save_path {
		1705	my ($self) = @_;
		1706
		1707	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1708	"$TMPDIR/$path.map"
		1709	}
		1710
		1711	# the unique path, undef == no special unique path
		1712	sub uniq_path {
		1713	my ($self) = @_;
		1714
		1715	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1716	"$UNIQUEDIR/$path"
1151	}	1717	}
1152		1718
1153	# and all this just because we cannot iterate over	1719	# and all this just because we cannot iterate over
1154	# all maps in C++...	1720	# all maps in C++...
1155	sub change_all_map_light {	1721	sub change_all_map_light {
1156	my ($change) = @_;	1722	my ($change) = @_;
1157		1723
1158	$_->change_map_light ($change) for values %cf::MAP;	1724	$_->change_map_light ($change)
		1725	for grep $_->outdoor, values %cf::MAP;
1159	}	1726	}
1160		1727
		1728	sub decay_objects {
		1729	my ($self) = @_;
		1730
		1731	return if $self->{deny_reset};
		1732
		1733	$self->do_decay_objects;
		1734	}
		1735
		1736	sub unlink_save {
		1737	my ($self) = @_;
		1738
		1739	utf8::encode (my $save = $self->save_path);
		1740	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1741	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1742	}
		1743
1161	sub try_load_header($) {	1744	sub load_header_from($) {
1162	my ($path) = @_;	1745	my ($self, $path) = @_;
1163		1746
1164	utf8::encode $path;	1747	utf8::encode $path;
1165	aio_open $path, O_RDONLY, 0	1748	#aio_open $path, O_RDONLY, 0
		1749	# or return;
		1750
		1751	$self->_load_header ($path)
1166	or return;	1752	or return;
1167		1753
1168	my $map = cf::map::new	1754	$self->{load_path} = $path;
		1755
		1756	1
		1757	}
		1758
		1759	sub load_header_orig {
		1760	my ($self) = @_;
		1761
		1762	$self->load_header_from ($self->load_path)
		1763	}
		1764
		1765	sub load_header_temp {
		1766	my ($self) = @_;
		1767
		1768	$self->load_header_from ($self->save_path)
		1769	}
		1770
		1771	sub prepare_temp {
		1772	my ($self) = @_;
		1773
		1774	$self->last_access ((delete $self->{last_access})
		1775	|| $cf::RUNTIME); #d#
		1776	# safety
		1777	$self->{instantiate_time} = $cf::RUNTIME
		1778	if $self->{instantiate_time} > $cf::RUNTIME;
		1779	}
		1780
		1781	sub prepare_orig {
		1782	my ($self) = @_;
		1783
		1784	$self->{load_original} = 1;
		1785	$self->{instantiate_time} = $cf::RUNTIME;
		1786	$self->last_access ($cf::RUNTIME);
		1787	$self->instantiate;
		1788	}
		1789
		1790	sub load_header {
		1791	my ($self) = @_;
		1792
		1793	if ($self->load_header_temp) {
		1794	$self->prepare_temp;
		1795	} else {
		1796	$self->load_header_orig
1169	or return;	1797	or return;
		1798	$self->prepare_orig;
		1799	}
1170		1800
1171	$map->load_header ($path)	1801	$self->{deny_reset} = 1
1172	or return;	1802	if $self->no_reset;
1173		1803
1174	$map->{load_path} = $path;	1804	$self->default_region (cf::region::find_by_path $self->{path})
		1805	unless $self->default_region;
1175		1806
1176	$map	1807	1
1177	}	1808	}
1178		1809
		1810	sub find;
1179	sub find_map {	1811	sub find {
1180	my ($path, $origin) = @_;	1812	my ($path, $origin) = @_;
1181		1813
1182	#warn "find_map<$path,$origin>\n";#d#
1183
1184	$path = new cf::path $path, $origin && $origin->path;	1814	$path = normalise $path, $origin && $origin->path;
1185	my $key = $path->as_string;
1186		1815
1187	cf::lock_wait "map_find:$key";	1816	cf::lock_wait "map_find:$path";
1188		1817
1189	$cf::MAP{$key} || do {	1818	$cf::MAP{$path} || do {
1190	my $guard = cf::lock_acquire "map_find:$key";	1819	my $guard = cf::lock_acquire "map_find:$path";
1191		1820	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;	1821	or return;
1207		1822
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;	1823	$map->{last_save} = $cf::RUNTIME;
1220	$map->last_access ($cf::RUNTIME);
1221		1824
1222	if ($map->should_reset) {	1825	$map->load_header
		1826	or return;
		1827
		1828	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1829	# doing this can freeze the server in a sync job, obviously
		1830	#$cf::WAIT_FOR_TICK->wait;
1223	$map->reset;	1831	$map->reset;
1224	$map = find_map $path;	1832	undef $guard;
		1833	return find $path;
1225	}	1834	}
1226		1835
1227	$cf::MAP{$key} = $map	1836	$cf::MAP{$path} = $map
1228	}	1837	}
1229	}	1838	}
		1839
		1840	sub pre_load { }
		1841	sub post_load { }
1230		1842
1231	sub load {	1843	sub load {
1232	my ($self) = @_;	1844	my ($self) = @_;
1233		1845
		1846	local $self->{deny_reset} = 1; # loading can take a long time
		1847
1234	my $path = $self->{path};	1848	my $path = $self->{path};
		1849
		1850	{
1235	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1851	my $guard = cf::lock_acquire "map_load:$path";
1236		1852
1237	return if $self->in_memory != cf::MAP_SWAPPED;	1853	return if $self->in_memory != cf::MAP_SWAPPED;
1238		1854
1239	$self->in_memory (cf::MAP_LOADING);	1855	$self->in_memory (cf::MAP_LOADING);
1240		1856
1241	$self->alloc;	1857	$self->alloc;
		1858
		1859	$self->pre_load;
		1860	Coro::cede;
		1861
1242	$self->load_objects ($self->{load_path}, 1)	1862	$self->_load_objects ($self->{load_path}, 1)
1243	or return;	1863	or return;
1244		1864
1245	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1865	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1246	if delete $self->{load_original};	1866	if delete $self->{load_original};
1247		1867
1248	if (my $uniq = $path->uniq_path) {	1868	if (my $uniq = $self->uniq_path) {
1249	utf8::encode $uniq;	1869	utf8::encode $uniq;
1250	if (aio_open $uniq, O_RDONLY, 0) {	1870	if (aio_open $uniq, O_RDONLY, 0) {
1251	$self->clear_unique_items;	1871	$self->clear_unique_items;
1252	$self->load_objects ($uniq, 0);	1872	$self->_load_objects ($uniq, 0);
1253	}	1873	}
1254	}	1874	}
1255		1875
		1876	Coro::cede;
1256	# now do the right thing for maps	1877	# now do the right thing for maps
1257	$self->link_multipart_objects;	1878	$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)	1879	$self->difficulty ($self->estimate_difficulty)
1268	unless $self->difficulty;	1880	unless $self->difficulty;
		1881	Coro::cede;
		1882
		1883	unless ($self->{deny_activate}) {
		1884	$self->decay_objects;
		1885	$self->fix_auto_apply;
		1886	$self->update_buttons;
		1887	Coro::cede;
		1888	$self->set_darkness_map;
		1889	Coro::cede;
1269	$self->activate;	1890	$self->activate;
1270	}	1891	}
1271		1892
		1893	$self->{last_save} = $cf::RUNTIME;
		1894	$self->last_access ($cf::RUNTIME);
		1895
1272	$self->in_memory (cf::MAP_IN_MEMORY);	1896	$self->in_memory (cf::MAP_IN_MEMORY);
1273	}	1897	}
1274		1898
1275	sub load_map_sync {	1899	$self->post_load;
		1900	}
		1901
		1902	sub customise_for {
		1903	my ($self, $ob) = @_;
		1904
		1905	return find "~" . $ob->name . "/" . $self->{path}
		1906	if $self->per_player;
		1907
		1908	# return find "?party/" . $ob->name . "/" . $self->{path}
		1909	# if $self->per_party;
		1910
		1911	$self
		1912	}
		1913
		1914	# find and load all maps in the 3x3 area around a map
		1915	sub load_neighbours {
		1916	my ($map) = @_;
		1917
		1918	my @neigh; # diagonal neighbours
		1919
		1920	for (0 .. 3) {
		1921	my $neigh = $map->tile_path ($_)
		1922	or next;
		1923	$neigh = find $neigh, $map
		1924	or next;
		1925	$neigh->load;
		1926
		1927	push @neigh,
		1928	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		1929	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1930	}
		1931
		1932	for (grep defined $_->[0], @neigh) {
		1933	my ($path, $origin) = @$_;
		1934	my $neigh = find $path, $origin
		1935	or next;
		1936	$neigh->load;
		1937	}
		1938	}
		1939
		1940	sub find_sync {
1276	my ($path, $origin) = @_;	1941	my ($path, $origin) = @_;
1277		1942
1278	#warn "load_map_sync<$path, $origin>\n";#d#	1943	cf::sync_job { find $path, $origin }
		1944	}
1279		1945
1280	cf::sync_job {	1946	sub do_load_sync {
1281	my $map = cf::map::find_map $path, $origin	1947	my ($map) = @_;
1282	or return;	1948
		1949	cf::sync_job { $map->load };
		1950	}
		1951
		1952	our %MAP_PREFETCH;
		1953	our $MAP_PREFETCHER = undef;
		1954
		1955	sub find_async {
		1956	my ($path, $origin) = @_;
		1957
		1958	$path = normalise $path, $origin && $origin->{path};
		1959
		1960	if (my $map = $cf::MAP{$path}) {
		1961	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1962	}
		1963
		1964	undef $MAP_PREFETCH{$path};
		1965	$MAP_PREFETCHER ||= cf::async {
		1966	while (%MAP_PREFETCH) {
		1967	for my $path (keys %MAP_PREFETCH) {
		1968	if (my $map = find $path) {
1283	$map->load;	1969	$map->load;
1284	$map	1970	}
		1971
		1972	delete $MAP_PREFETCH{$path};
		1973	}
		1974	}
		1975	undef $MAP_PREFETCHER;
1285	}	1976	};
		1977	$MAP_PREFETCHER->prio (6);
		1978
		1979	()
1286	}	1980	}
1287		1981
1288	sub save {	1982	sub save {
1289	my ($self) = @_;	1983	my ($self) = @_;
1290		1984
		1985	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1986
1291	$self->{last_save} = $cf::RUNTIME;	1987	$self->{last_save} = $cf::RUNTIME;
1292		1988
1293	return unless $self->dirty;	1989	return unless $self->dirty;
1294		1990
1295	my $save = $self->{path}->save_path; utf8::encode $save;	1991	my $save = $self->save_path; utf8::encode $save;
1296	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1992	my $uniq = $self->uniq_path; utf8::encode $uniq;
1297		1993
1298	$self->{load_path} = $save;	1994	$self->{load_path} = $save;
1299		1995
1300	return if $self->{deny_save};	1996	return if $self->{deny_save};
1301		1997
		1998	local $self->{last_access} = $self->last_access;#d#
		1999
		2000	cf::async {
		2001	$_->contr->save for $self->players;
		2002	};
		2003
1302	if ($uniq) {	2004	if ($uniq) {
1303	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2005	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1304	$self->save_objects ($uniq, cf::IO_UNIQUES);	2006	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1305	} else {	2007	} else {
1306	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2008	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1307	}	2009	}
1308	}	2010	}
1309		2011
1310	sub swap_out {	2012	sub swap_out {
1311	my ($self) = @_;	2013	my ($self) = @_;
		2014
		2015	# save first because save cedes
		2016	$self->save;
		2017
		2018	my $lock = cf::lock_acquire "map_data:" . $self->path;
1312		2019
1313	return if $self->players;	2020	return if $self->players;
1314	return if $self->in_memory != cf::MAP_IN_MEMORY;	2021	return if $self->in_memory != cf::MAP_IN_MEMORY;
1315	return if $self->{deny_save};	2022	return if $self->{deny_save};
1316		2023
1317	$self->save;
1318	$self->clear;	2024	$self->clear;
1319	$self->in_memory (cf::MAP_SWAPPED);	2025	$self->in_memory (cf::MAP_SWAPPED);
1320	}	2026	}
1321		2027
1322	sub reset_at {	2028	sub reset_at {
1323	my ($self) = @_;	2029	my ($self) = @_;
1324		2030
1325	# TODO: safety, remove and allow resettable per-player maps	2031	# TODO: safety, remove and allow resettable per-player maps
1326	return 1e99 if $self->{path}{user_rel};
1327	return 1e99 if $self->{deny_reset};	2032	return 1e99 if $self->{deny_reset};
1328		2033
1329	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2034	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1330	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2035	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1331		2036
…		…
1336	my ($self) = @_;	2041	my ($self) = @_;
1337		2042
1338	$self->reset_at <= $cf::RUNTIME	2043	$self->reset_at <= $cf::RUNTIME
1339	}	2044	}
1340		2045
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 {	2046	sub reset {
1363	my ($self) = @_;	2047	my ($self) = @_;
1364		2048
		2049	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2050
1365	return if $self->players;	2051	return if $self->players;
1366	return if $self->{path}{user_rel};#d#
1367		2052
1368	warn "resetting map ", $self->path;#d#	2053	warn "resetting map ", $self->path;
		2054
		2055	$self->in_memory (cf::MAP_SWAPPED);
		2056
		2057	# need to save uniques path
		2058	unless ($self->{deny_save}) {
		2059	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2060
		2061	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2062	if $uniq;
		2063	}
1369		2064
1370	delete $cf::MAP{$self->path};	2065	delete $cf::MAP{$self->path};
		2066
		2067	$self->clear;
1371		2068
1372	$_->clear_links_to ($self) for values %cf::MAP;	2069	$_->clear_links_to ($self) for values %cf::MAP;
1373		2070
1374	$self->unlink_save;	2071	$self->unlink_save;
1375	$self->destroy;	2072	$self->destroy;
…		…
1378	my $nuke_counter = "aaaa";	2075	my $nuke_counter = "aaaa";
1379		2076
1380	sub nuke {	2077	sub nuke {
1381	my ($self) = @_;	2078	my ($self) = @_;
1382		2079
		2080	delete $cf::MAP{$self->path};
		2081
		2082	$self->unlink_save;
		2083
		2084	bless $self, "cf::map";
		2085	delete $self->{deny_reset};
1383	$self->{deny_save} = 1;	2086	$self->{deny_save} = 1;
1384	$self->reset_timeout (1);	2087	$self->reset_timeout (1);
1385	$self->rename ("{nuke}/" . ($nuke_counter++));	2088	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2089
		2090	$cf::MAP{$self->path} = $self;
		2091
1386	$self->reset; # polite request, might not happen	2092	$self->reset; # polite request, might not happen
1387	}	2093	}
1388		2094
1389	sub customise_for {	2095	=item $maps = cf::map::tmp_maps
1390	my ($map, $ob) = @_;
1391		2096
1392	if ($map->per_player) {	2097	Returns an arrayref with all map paths of currently instantiated and saved
1393	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2098	maps. May block.
		2099
		2100	=cut
		2101
		2102	sub tmp_maps() {
1394	}	2103	[
1395		2104	map {
1396	$map	2105	utf8::decode $_;
		2106	/\.map$/
		2107	? normalise $_
		2108	: ()
		2109	} @{ aio_readdir $TMPDIR or [] }
		2110	]
1397	}	2111	}
1398		2112
1399	sub emergency_save {	2113	=item $maps = cf::map::random_maps
1400	local $cf::FREEZE = 1;
1401		2114
1402	warn "enter emergency map save\n";	2115	Returns an arrayref with all map paths of currently instantiated and saved
		2116	random maps. May block.
1403		2117
1404	cf::sync_job {	2118	=cut
1405	warn "begin emergency map save\n";
1406	$_->save for values %cf::MAP;
1407	};
1408		2119
1409	warn "end emergency map save\n";	2120	sub random_maps() {
		2121	[
		2122	map {
		2123	utf8::decode $_;
		2124	/\.map$/
		2125	? normalise "?random/$_"
		2126	: ()
		2127	} @{ aio_readdir $RANDOMDIR or [] }
		2128	]
		2129	}
		2130
		2131	=item cf::map::unique_maps
		2132
		2133	Returns an arrayref of paths of all shared maps that have
		2134	instantiated unique items. May block.
		2135
		2136	=cut
		2137
		2138	sub unique_maps() {
		2139	[
		2140	map {
		2141	utf8::decode $_;
		2142	/\.map$/
		2143	? normalise $_
		2144	: ()
		2145	} @{ aio_readdir $UNIQUEDIR or [] }
		2146	]
1410	}	2147	}
1411		2148
1412	package cf;	2149	package cf;
1413		2150
1414	=back	2151	=back
1415		2152
		2153	=head3 cf::object
		2154
		2155	=cut
		2156
		2157	package cf::object;
		2158
		2159	=over 4
		2160
		2161	=item $ob->inv_recursive
		2162
		2163	Returns the inventory of the object _and_ their inventories, recursively.
		2164
		2165	=cut
		2166
		2167	sub inv_recursive_;
		2168	sub inv_recursive_ {
		2169	map { $_, inv_recursive_ $_->inv } @_
		2170	}
		2171
		2172	sub inv_recursive {
		2173	inv_recursive_ inv $_[0]
		2174	}
		2175
		2176	package cf;
		2177
		2178	=back
1416		2179
1417	=head3 cf::object::player	2180	=head3 cf::object::player
1418		2181
1419	=over 4	2182	=over 4
1420		2183
…		…
1434		2197
1435	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2198	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1436		2199
1437	if ($self->{record_replies}) {	2200	if ($self->{record_replies}) {
1438	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2201	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2202
1439	} else {	2203	} else {
		2204	my $pl = $self->contr;
		2205
		2206	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2207	my $dialog = $pl->{npc_dialog};
		2208	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2209
		2210	} else {
1440	$msg = $npc->name . " says: $msg" if $npc;	2211	$msg = $npc->name . " says: $msg" if $npc;
1441	$self->message ($msg, $flags);	2212	$self->message ($msg, $flags);
		2213	}
1442	}	2214	}
		2215	}
		2216
		2217	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2218
		2219	=cut
		2220
		2221	sub cf::object::send_msg {
		2222	my $pl = shift->contr
		2223	or return;
		2224	$pl->send_msg (@_);
1443	}	2225	}
1444		2226
1445	=item $player_object->may ("access")	2227	=item $player_object->may ("access")
1446		2228
1447	Returns wether the given player is authorized to access resource "access"	2229	Returns wether the given player is authorized to access resource "access"
…		…
1460		2242
1461	=item $player_object->enter_link	2243	=item $player_object->enter_link
1462		2244
1463	Freezes the player and moves him/her to a special map (C<{link}>).	2245	Freezes the player and moves him/her to a special map (C<{link}>).
1464		2246
1465	The player should be reaosnably safe there for short amounts of time. You	2247	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.	2248	I<MUST> call C<leave_link> as soon as possible, though.
1467		2249
		2250	Will never block.
		2251
1468	=item $player_object->leave_link ($map, $x, $y)	2252	=item $player_object->leave_link ($map, $x, $y)
1469		2253
1470	Moves the player out of the specila link map onto the given map. If the	2254	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	2255	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,	2256	to the location he/she was before the call to C<enter_link>, or, if that
1473	to the emergency map position.	2257	fails, to the emergency map position.
1474		2258
1475	Might block.	2259	Might block.
1476		2260
1477	=cut	2261	=cut
		2262
		2263	sub link_map {
		2264	unless ($LINK_MAP) {
		2265	$LINK_MAP = cf::map::find "{link}"
		2266	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2267	$LINK_MAP->load;
		2268	}
		2269
		2270	$LINK_MAP
		2271	}
1478		2272
1479	sub cf::object::player::enter_link {	2273	sub cf::object::player::enter_link {
1480	my ($self) = @_;	2274	my ($self) = @_;
1481		2275
1482	$self->deactivate_recursive;	2276	$self->deactivate_recursive;
1483		2277
1484	return if $self->map == $LINK_MAP;	2278	return if UNIVERSAL::isa $self->map, "ext::map_link";
1485		2279
1486	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2280	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1487	if $self->map;	2281	if $self->map && $self->map->{path} ne "{link}";
1488		2282
1489	$self->enter_map ($LINK_MAP, 20, 20);	2283	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1490	}	2284	}
1491		2285
1492	sub cf::object::player::leave_link {	2286	sub cf::object::player::leave_link {
1493	my ($self, $map, $x, $y) = @_;	2287	my ($self, $map, $x, $y) = @_;
		2288
		2289	return unless $self->contr->active;
1494		2290
1495	my $link_pos = delete $self->{_link_pos};	2291	my $link_pos = delete $self->{_link_pos};
1496		2292
1497	unless ($map) {	2293	unless ($map) {
1498	# restore original map position	2294	# restore original map position
1499	($map, $x, $y) = @{ $link_pos || [] };	2295	($map, $x, $y) = @{ $link_pos || [] };
1500	$map = cf::map::find_map $map;	2296	$map = cf::map::find $map;
1501		2297
1502	unless ($map) {	2298	unless ($map) {
1503	($map, $x, $y) = @$EMERGENCY_POSITION;	2299	($map, $x, $y) = @$EMERGENCY_POSITION;
1504	$map = cf::map::find_map $map	2300	$map = cf::map::find $map
1505	or die "FATAL: cannot load emergency map\n";	2301	or die "FATAL: cannot load emergency map\n";
1506	}	2302	}
1507	}	2303	}
1508		2304
1509	($x, $y) = (-1, -1)	2305	($x, $y) = (-1, -1)
…		…
1512	# use -1 or undef as default coordinates, not 0, 0	2308	# use -1 or undef as default coordinates, not 0, 0
1513	($x, $y) = ($map->enter_x, $map->enter_y)	2309	($x, $y) = ($map->enter_x, $map->enter_y)
1514	if $x <=0 && $y <= 0;	2310	if $x <=0 && $y <= 0;
1515		2311
1516	$map->load;	2312	$map->load;
		2313	$map->load_neighbours;
1517		2314
		2315	return unless $self->contr->active;
1518	$self->activate_recursive;	2316	$self->activate_recursive;
		2317
		2318	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1519	$self->enter_map ($map, $x, $y);	2319	$self->enter_map ($map, $x, $y);
1520	}	2320	}
1521		2321
1522	cf::player->attach (	2322	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1523	on_logout => sub {
1524	my ($pl) = @_;
1525		2323
1526	# abort map switching before logout	2324	Moves the player to the given map-path and coordinates by first freezing
1527	if ($pl->ob->{_link_pos}) {	2325	her, loading and preparing them map, calling the provided $check callback
1528	cf::sync_job {	2326	that has to return the map if sucecssful, and then unfreezes the player on
1529	$pl->ob->leave_link	2327	the new (success) or old (failed) map position. In either case, $done will
1530	};	2328	be called at the end of this process.
1531	}
1532	},
1533	on_login => sub {
1534	my ($pl) = @_;
1535		2329
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	2330	=cut
1553		2331
		2332	our $GOTOGEN;
		2333
1554	sub cf::object::player::goto_map {	2334	sub cf::object::player::goto {
1555	my ($self, $path, $x, $y) = @_;	2335	my ($self, $path, $x, $y, $check, $done) = @_;
		2336
		2337	# do generation counting so two concurrent goto's will be executed in-order
		2338	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1556		2339
1557	$self->enter_link;	2340	$self->enter_link;
1558		2341
1559	(Coro::async {	2342	(async {
1560	$path = new cf::path $path;	2343	my $map = eval {
1561
1562	my $map = cf::map::find_map $path->as_string;	2344	my $map = cf::map::find $path;
		2345
		2346	if ($map) {
1563	$map = $map->customise_for ($self) if $map;	2347	$map = $map->customise_for ($self);
1564		2348	$map = $check->($map) if $check && $map;
1565	# warn "entering ", $map->path, " at ($x, $y)\n"	2349	} else {
1566	# if $map;
1567
1568	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2350	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2351	}
1569		2352
		2353	$map
		2354	};
		2355
		2356	if ($@) {
		2357	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2358	LOG llevError | logBacktrace, Carp::longmess $@;
		2359	}
		2360
		2361	if ($gen == $self->{_goto_generation}) {
		2362	delete $self->{_goto_generation};
1570	$self->leave_link ($map, $x, $y);	2363	$self->leave_link ($map, $x, $y);
		2364	}
		2365
		2366	$done->() if $done;
1571	})->prio (1);	2367	})->prio (1);
1572	}	2368	}
1573		2369
1574	=item $player_object->enter_exit ($exit_object)	2370	=item $player_object->enter_exit ($exit_object)
1575		2371
…		…
1577		2373
1578	sub parse_random_map_params {	2374	sub parse_random_map_params {
1579	my ($spec) = @_;	2375	my ($spec) = @_;
1580		2376
1581	my $rmp = { # defaults	2377	my $rmp = { # defaults
1582	xsize => 10,	2378	xsize => (cf::rndm 15, 40),
1583	ysize => 10,	2379	ysize => (cf::rndm 15, 40),
		2380	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2381	#layout => string,
1584	};	2382	};
1585		2383
1586	for (split /\n/, $spec) {	2384	for (split /\n/, $spec) {
1587	my ($k, $v) = split /\s+/, $_, 2;	2385	my ($k, $v) = split /\s+/, $_, 2;
1588		2386
…		…
1592	$rmp	2390	$rmp
1593	}	2391	}
1594		2392
1595	sub prepare_random_map {	2393	sub prepare_random_map {
1596	my ($exit) = @_;	2394	my ($exit) = @_;
		2395
		2396	my $guard = cf::lock_acquire "exit_prepare:$exit";
1597		2397
1598	# all this does is basically replace the /! path by	2398	# all this does is basically replace the /! path by
1599	# a new random map path (?random/...) with a seed	2399	# a new random map path (?random/...) with a seed
1600	# that depends on the exit object	2400	# that depends on the exit object
1601		2401
1602	my $rmp = parse_random_map_params $exit->msg;	2402	my $rmp = parse_random_map_params $exit->msg;
1603		2403
1604	if ($exit->map) {	2404	if ($exit->map) {
1605	$rmp->{region} = $exit->map->region_name;	2405	$rmp->{region} = $exit->region->name;
1606	$rmp->{origin_map} = $exit->map->path;	2406	$rmp->{origin_map} = $exit->map->path;
1607	$rmp->{origin_x} = $exit->x;	2407	$rmp->{origin_x} = $exit->x;
1608	$rmp->{origin_y} = $exit->y;	2408	$rmp->{origin_y} = $exit->y;
1609	}	2409	}
1610		2410
1611	$rmp->{random_seed} ||= $exit->random_seed;	2411	$rmp->{random_seed} ||= $exit->random_seed;
1612		2412
1613	my $data = cf::to_json $rmp;	2413	my $data = cf::to_json $rmp;
1614	my $md5 = Digest::MD5::md5_hex $data;	2414	my $md5 = Digest::MD5::md5_hex $data;
		2415	my $meta = "$RANDOMDIR/$md5.meta";
1615		2416
1616	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2417	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1617	aio_write $fh, 0, (length $data), $data, 0;	2418	aio_write $fh, 0, (length $data), $data, 0;
		2419	undef $fh;
		2420	aio_rename "$meta~", $meta;
1618		2421
1619	$exit->slaying ("?random/$md5");	2422	$exit->slaying ("?random/$md5");
1620	$exit->msg (undef);	2423	$exit->msg (undef);
1621	}	2424	}
1622	}	2425	}
…		…
1624	sub cf::object::player::enter_exit {	2427	sub cf::object::player::enter_exit {
1625	my ($self, $exit) = @_;	2428	my ($self, $exit) = @_;
1626		2429
1627	return unless $self->type == cf::PLAYER;	2430	return unless $self->type == cf::PLAYER;
1628		2431
		2432	if ($exit->slaying eq "/!") {
		2433	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2434	# the problem is that $exit might not survive long enough
		2435	# so it needs to be done right now, right here
		2436	cf::sync_job { prepare_random_map $exit };
		2437	}
		2438
		2439	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2440	my $hp = $exit->stats->hp;
		2441	my $sp = $exit->stats->sp;
		2442
1629	$self->enter_link;	2443	$self->enter_link;
1630		2444
		2445	# if exit is damned, update players death & WoR home-position
		2446	$self->contr->savebed ($slaying, $hp, $sp)
		2447	if $exit->flag (FLAG_DAMNED);
		2448
1631	(Coro::async {	2449	(async {
		2450	$self->deactivate_recursive; # just to be sure
1632	unless (eval {	2451	unless (eval {
1633		2452	$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		2453
1640	1;	2454	1;
1641	}) {	2455	}) {
1642	$self->message ("Something went wrong deep within the crossfire server. "	2456	$self->message ("Something went wrong deep within the crossfire server. "
1643	. "I'll try to bring you back to the map you were before. "	2457	. "I'll try to bring you back to the map you were before. "
1644	. "Please report this to the dungeon master",	2458	. "Please report this to the dungeon master!",
1645	cf::NDI_UNIQUE | cf::NDI_RED);	2459	cf::NDI_UNIQUE | cf::NDI_RED);
1646		2460
1647	warn "ERROR in enter_exit: $@";	2461	warn "ERROR in enter_exit: $@";
1648	$self->leave_link;	2462	$self->leave_link;
1649	}	2463	}
1650	})->prio (1);	2464	})->prio (1);
…		…
1663		2477
1664	sub cf::client::send_drawinfo {	2478	sub cf::client::send_drawinfo {
1665	my ($self, $text, $flags) = @_;	2479	my ($self, $text, $flags) = @_;
1666		2480
1667	utf8::encode $text;	2481	utf8::encode $text;
1668	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2482	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1669	}	2483	}
1670		2484
		2485	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2486
		2487	Send a drawinfo or msg packet to the client, formatting the msg for the
		2488	client if neccessary. C<$type> should be a string identifying the type of
		2489	the message, with C<log> being the default. If C<$color> is negative, suppress
		2490	the message unless the client supports the msg packet.
		2491
		2492	=cut
		2493
		2494	sub cf::client::send_msg {
		2495	my ($self, $channel, $msg, $color, @extra) = @_;
		2496
		2497	$msg = $self->pl->expand_cfpod ($msg);
		2498
		2499	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2500
		2501	if (ref $channel) {
		2502	# send meta info to client, if not yet sent
		2503	unless (exists $self->{channel}{$channel->{id}}) {
		2504	$self->{channel}{$channel->{id}} = $channel;
		2505	$self->ext_msg (channel_info => $channel);
		2506	}
		2507
		2508	$channel = $channel->{id};
		2509	}
		2510
		2511	return unless @extra || length $msg;
		2512
		2513	if ($self->can_msg) {
		2514	# default colour, mask it out
		2515	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2516	if $color & cf::NDI_DEF;
		2517
		2518	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2519	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2520	} else {
		2521	if ($color >= 0) {
		2522	# replace some tags by gcfclient-compatible ones
		2523	for ($msg) {
		2524	1 while
		2525	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2526	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2527	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2528	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2529	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2530	}
		2531
		2532	$color &= cf::NDI_COLOR_MASK;
		2533
		2534	utf8::encode $msg;
		2535
		2536	if (0 && $msg =~ /\[/) {
		2537	# COMMAND/INFO
		2538	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2539	} else {
		2540	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2541	$self->send_packet ("drawinfo $color $msg")
		2542	}
		2543	}
		2544	}
		2545	}
		2546
		2547	=item $client->ext_msg ($type, @msg)
		2548
		2549	Sends an ext event to the client.
		2550
		2551	=cut
		2552
		2553	sub cf::client::ext_msg($$@) {
		2554	my ($self, $type, @msg) = @_;
		2555
		2556	my $extcmd = $self->extcmd;
		2557
		2558	if ($extcmd == 2) {
		2559	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2560	} elsif ($extcmd == 1) { # TODO: remove
		2561	push @msg, msgtype => "event_$type";
		2562	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2563	}
		2564	}
		2565
		2566	=item $client->ext_reply ($msgid, @msg)
		2567
		2568	Sends an ext reply to the client.
		2569
		2570	=cut
		2571
		2572	sub cf::client::ext_reply($$@) {
		2573	my ($self, $id, @msg) = @_;
		2574
		2575	if ($self->extcmd == 2) {
		2576	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2577	} elsif ($self->ns->extcmd == 1) {
		2578	#TODO: version 1, remove
		2579	unshift @msg, msgtype => "reply", msgid => $id;
		2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
		2582	}
1671		2583
1672	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
1673		2585
1674	Queues a query to the client, calling the given callback with	2586	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>,	2587	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>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1677		2589
1678	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
1679	reliable at some point in the future.	2591	become reliable at some point in the future.
1680		2592
1681	=cut	2593	=cut
1682		2594
1683	sub cf::client::query {	2595	sub cf::client::query {
1684	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
1692	utf8::encode $text;	2604	utf8::encode $text;
1693	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1694		2606
1695	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
1696	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
1697	}	2611	}
1698		2612
1699	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
1700	on_reply => sub {	2619	on_reply => sub {
1701	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
1702		2621
1703	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
1704	# get handled first	2623	# get handled first
1705	my $queue = delete $ns->{query_queue};	2624	my $queue = delete $ns->{query_queue}
		2625	or return; # be conservative, not sure how that can happen, but we saw a crash here
1706		2626
1707	(shift @$queue)->[1]->($msg);	2627	(shift @$queue)->[1]->($msg);
		2628	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1708		2629
1709	push @{ $ns->{query_queue} }, @$queue;	2630	push @{ $ns->{query_queue} }, @$queue;
1710		2631
1711	if (@{ $ns->{query_queue} } == @$queue) {	2632	if (@{ $ns->{query_queue} } == @$queue) {
1712	if (@$queue) {	2633	if (@$queue) {
…		…
1714	} else {	2635	} else {
1715	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1716	}	2637	}
1717	}	2638	}
1718	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
1719	);	2663	);
1720		2664
1721	=item $client->coro (\&cb)	2665	=item $client->async (\&cb)
1722		2666
1723	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
1724	be automatically cancelled when the client gets destroyed (e.g. on logout,	2668	be automatically cancelled when the client gets destroyed (e.g. on logout,
1725	or loss of connection).	2669	or loss of connection).
1726		2670
1727	=cut	2671	=cut
1728		2672
1729	sub cf::client::coro {	2673	sub cf::client::async {
1730	my ($self, $cb) = @_;	2674	my ($self, $cb) = @_;
1731		2675
1732	my $coro; $coro = async {	2676	my $coro = &Coro::async ($cb);
1733	eval {
1734	$cb->();
1735	};
1736	warn $@ if $@;
1737	};
1738		2677
1739	$coro->on_destroy (sub {	2678	$coro->on_destroy (sub {
1740	delete $self->{_coro}{$coro+0};	2679	delete $self->{_coro}{$coro+0};
1741	});	2680	});
1742		2681
…		…
1769	our $safe = new Safe "safe";	2708	our $safe = new Safe "safe";
1770	our $safe_hole = new Safe::Hole;	2709	our $safe_hole = new Safe::Hole;
1771		2710
1772	$SIG{FPE} = 'IGNORE';	2711	$SIG{FPE} = 'IGNORE';
1773		2712
1774	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2713	$safe->permit_only (Opcode::opset qw(
		2714	:base_core :base_mem :base_orig :base_math
		2715	grepstart grepwhile mapstart mapwhile
		2716	sort time
		2717	));
1775		2718
1776	# here we export the classes and methods available to script code	2719	# here we export the classes and methods available to script code
1777		2720
1778	=pod	2721	=pod
1779		2722
1780	The following fucntions and emthods are available within a safe environment:	2723	The following functions and methods are available within a safe environment:
1781		2724
1782	cf::object contr pay_amount pay_player map	2725	cf::object
		2726	contr pay_amount pay_player map x y force_find force_add
		2727	insert remove name archname title slaying race
		2728
1783	cf::object::player player	2729	cf::object::player
1784	cf::player peaceful	2730	player
1785	cf::map trigger	2731
		2732	cf::player
		2733	peaceful
		2734
		2735	cf::map
		2736	trigger
1786		2737
1787	=cut	2738	=cut
1788		2739
1789	for (	2740	for (
1790	["cf::object" => qw(contr pay_amount pay_player map)],	2741	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2742	insert remove inv name archname title slaying race)],
1791	["cf::object::player" => qw(player)],	2743	["cf::object::player" => qw(player)],
1792	["cf::player" => qw(peaceful)],	2744	["cf::player" => qw(peaceful)],
1793	["cf::map" => qw(trigger)],	2745	["cf::map" => qw(trigger)],
1794	) {	2746	) {
1795	no strict 'refs';	2747	no strict 'refs';
…		…
1866	=back	2818	=back
1867		2819
1868	=cut	2820	=cut
1869		2821
1870	#############################################################################	2822	#############################################################################
		2823	# the server's init and main functions
1871		2824
1872	=head2 EXTENSION DATABASE SUPPORT	2825	sub load_facedata($) {
		2826	my ($path) = @_;
1873		2827
1874	Crossfire maintains a very simple database for extension use. It can	2828	my $enc = JSON::XS->new->utf8->canonical;
1875	currently store anything that can be serialised using Storable, which
1876	excludes objects.
1877		2829
1878	The parameter C<$family> should best start with the name of the extension	2830	warn "loading facedata from $path\n";
1879	using it, it should be unique.
1880		2831
1881	=over 4	2832	my $facedata;
		2833	0 < aio_load $path, $facedata
		2834	or die "$path: $!";
1882		2835
1883	=item $hashref = cf::db_get $family	2836	$facedata = Coro::Storable::thaw $facedata;
1884		2837
1885	Return a hashref for use by the extension C<$family>, which can be	2838	$facedata->{version} == 2
1886	modified. After modifications, you have to call C<cf::db_dirty> or	2839	or cf::cleanup "$path: version mismatch, cannot proceed.";
1887	C<cf::db_sync>.
1888		2840
1889	=item $value = cf::db_get $family => $key	2841	# patch in the exptable
1890		2842	$facedata->{resource}{"res/exp_table"} = {
1891	Returns a single value from the database	2843	type => FT_RSRC,
1892		2844	data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
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	}
1922
1923	my $pid;
1924
1925	sub db_save() {
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	});	2845	};
		2846	cf::cede_to_tick;
1946		2847
1947	sub db_dirty() {
1948	$dirty = 1;
1949	$idle->start;
1950	}	2848	{
		2849	my $faces = $facedata->{faceinfo};
1951		2850
1952	sub db_get($;$) {	2851	while (my ($face, $info) = each %$faces) {
1953	@_ >= 2	2852	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1954	? $DB->{$_[0]}{$_[1]}	2853	cf::face::set_visibility $idx, $info->{visibility};
1955	: ($DB->{$_[0]} ||= { })	2854	cf::face::set_magicmap $idx, $info->{magicmap};
1956	}	2855	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2856	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1957		2857
1958	sub db_put($$;$) {	2858	cf::cede_to_tick;
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	},	2859	}
1972	);
1973	}
1974		2860
1975	#############################################################################	2861	while (my ($face, $info) = each %$faces) {
1976	# the server's main()	2862	next unless $info->{smooth};
		2863	my $idx = cf::face::find $face
		2864	or next;
		2865	if (my $smooth = cf::face::find $info->{smooth}) {
		2866	cf::face::set_smooth $idx, $smooth;
		2867	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2868	} else {
		2869	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2870	}
		2871
		2872	cf::cede_to_tick;
		2873	}
		2874	}
		2875
		2876	{
		2877	my $anims = $facedata->{animinfo};
		2878
		2879	while (my ($anim, $info) = each %$anims) {
		2880	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2881	cf::cede_to_tick;
		2882	}
		2883
		2884	cf::anim::invalidate_all; # d'oh
		2885	}
		2886
		2887	{
		2888	# TODO: for gcfclient pleasure, we should give resources
		2889	# that gcfclient doesn't grok a >10000 face index.
		2890	my $res = $facedata->{resource};
		2891
		2892	my $soundconf = delete $res->{"res/sound.conf"};
		2893
		2894	while (my ($name, $info) = each %$res) {
		2895	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2896	my $data;
		2897
		2898	if ($info->{type} & 1) {
		2899	# prepend meta info
		2900
		2901	my $meta = $enc->encode ({
		2902	name => $name,
		2903	%{ $info->{meta} || {} },
		2904	});
		2905
		2906	$data = pack "(w/a*)*", $meta, $info->{data};
		2907	}
		2908
		2909	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2910	cf::face::set_type $idx, $info->{type};
		2911
		2912	cf::cede_to_tick;
		2913	}
		2914
		2915	if ($soundconf) {
		2916	$soundconf = $enc->decode (delete $soundconf->{data});
		2917
		2918	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2919	my $sound = $soundconf->{compat}[$_]
		2920	or next;
		2921
		2922	my $face = cf::face::find "sound/$sound->[1]";
		2923	cf::sound::set $sound->[0] => $face;
		2924	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2925	}
		2926
		2927	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2928	my $face = cf::face::find "sound/$v";
		2929	cf::sound::set $k => $face;
		2930	}
		2931	}
		2932	}
		2933
		2934	1
		2935	}
		2936
		2937	register_exticmd fx_want => sub {
		2938	my ($ns, $want) = @_;
		2939
		2940	while (my ($k, $v) = each %$want) {
		2941	$ns->fx_want ($k, $v);
		2942	}
		2943	};
		2944
		2945	sub reload_regions {
		2946	load_resource_file "$MAPDIR/regions"
		2947	or die "unable to load regions file\n";
		2948
		2949	for (cf::region::list) {
		2950	$_->{match} = qr/$_->{match}/
		2951	if exists $_->{match};
		2952	}
		2953	}
		2954
		2955	sub reload_facedata {
		2956	load_facedata "$DATADIR/facedata"
		2957	or die "unable to load facedata\n";
		2958	}
		2959
		2960	sub reload_archetypes {
		2961	load_resource_file "$DATADIR/archetypes"
		2962	or die "unable to load archetypes\n";
		2963	#d# NEED to laod twice to resolve forward references
		2964	# this really needs to be done in an extra post-pass
		2965	# (which needs to be synchronous, so solve it differently)
		2966	load_resource_file "$DATADIR/archetypes"
		2967	or die "unable to load archetypes\n";
		2968	}
		2969
		2970	sub reload_treasures {
		2971	load_resource_file "$DATADIR/treasures"
		2972	or die "unable to load treasurelists\n";
		2973	}
		2974
		2975	sub reload_resources {
		2976	warn "reloading resource files...\n";
		2977
		2978	reload_regions;
		2979	reload_facedata;
		2980	#reload_archetypes;#d#
		2981	reload_archetypes;
		2982	reload_treasures;
		2983
		2984	warn "finished reloading resource files\n";
		2985	}
		2986
		2987	sub init {
		2988	reload_resources;
		2989	}
1977		2990
1978	sub cfg_load {	2991	sub cfg_load {
1979	open my $fh, "<:utf8", cf::confdir . "/config"	2992	open my $fh, "<:utf8", "$CONFDIR/config"
1980	or return;	2993	or return;
1981		2994
1982	local $/;	2995	local $/;
1983	*CFG = YAML::Syck::Load <$fh>;	2996	*CFG = YAML::Syck::Load <$fh>;
		2997
		2998	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2999
		3000	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3001	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3002
		3003	if (exists $CFG{mlockall}) {
		3004	eval {
		3005	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3006	and die "WARNING: m(un)lockall failed: $!\n";
		3007	};
		3008	warn $@ if $@;
		3009	}
1984	}	3010	}
1985		3011
1986	sub main {	3012	sub main {
1987	# we must not ever block the main coroutine	3013	# we must not ever block the main coroutine
1988	local $Coro::idle = sub {	3014	local $Coro::idle = sub {
1989	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3015	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990	(Coro::unblock_sub {	3016	(async {
1991	Event::one_event;	3017	Event::one_event;
1992	})->();	3018	})->prio (Coro::PRIO_MAX);
1993	};	3019	};
1994		3020
1995	cfg_load;	3021	cfg_load;
1996	db_load;	3022	db_init;
1997	load_extensions;	3023	load_extensions;
		3024
		3025	$TICK_WATCHER->start;
1998	Event::loop;	3026	Event::loop;
1999	}	3027	}
2000		3028
2001	#############################################################################	3029	#############################################################################
2002	# initialisation	3030	# initialisation and cleanup
2003		3031
		3032	# install some emergency cleanup handlers
		3033	BEGIN {
		3034	for my $signal (qw(INT HUP TERM)) {
		3035	Event->signal (
		3036	reentrant => 0,
		3037	data => WF_AUTOCANCEL,
		3038	signal => $signal,
		3039	prio => 0,
		3040	cb => sub {
		3041	cf::cleanup "SIG$signal";
		3042	},
		3043	);
		3044	}
		3045	}
		3046
		3047	sub write_runtime {
		3048	my $runtime = "$LOCALDIR/runtime";
		3049
		3050	# first touch the runtime file to show we are still running:
		3051	# the fsync below can take a very very long time.
		3052
		3053	IO::AIO::aio_utime $runtime, undef, undef;
		3054
		3055	my $guard = cf::lock_acquire "write_runtime";
		3056
		3057	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3058	or return;
		3059
		3060	my $value = $cf::RUNTIME + 90 + 10;
		3061	# 10 is the runtime save interval, for a monotonic clock
		3062	# 60 allows for the watchdog to kill the server.
		3063
		3064	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3065	and return;
		3066
		3067	# always fsync - this file is important
		3068	aio_fsync $fh
		3069	and return;
		3070
		3071	# touch it again to show we are up-to-date
		3072	aio_utime $fh, undef, undef;
		3073
		3074	close $fh
		3075	or return;
		3076
		3077	aio_rename "$runtime~", $runtime
		3078	and return;
		3079
		3080	warn "runtime file written.\n";
		3081
		3082	1
		3083	}
		3084
		3085	sub emergency_save() {
		3086	my $freeze_guard = cf::freeze_mainloop;
		3087
		3088	warn "enter emergency perl save\n";
		3089
		3090	cf::sync_job {
		3091	# use a peculiar iteration method to avoid tripping on perl
		3092	# refcount bugs in for. also avoids problems with players
		3093	# and maps saved/destroyed asynchronously.
		3094	warn "begin emergency player save\n";
		3095	for my $login (keys %cf::PLAYER) {
		3096	my $pl = $cf::PLAYER{$login} or next;
		3097	$pl->valid or next;
		3098	$pl->save;
		3099	}
		3100	warn "end emergency player save\n";
		3101
		3102	warn "begin emergency map save\n";
		3103	for my $path (keys %cf::MAP) {
		3104	my $map = $cf::MAP{$path} or next;
		3105	$map->valid or next;
		3106	$map->save;
		3107	}
		3108	warn "end emergency map save\n";
		3109
		3110	warn "begin emergency database checkpoint\n";
		3111	BDB::db_env_txn_checkpoint $DB_ENV;
		3112	warn "end emergency database checkpoint\n";
		3113	};
		3114
		3115	warn "leave emergency perl save\n";
		3116	}
		3117
		3118	sub post_cleanup {
		3119	my ($make_core) = @_;
		3120
		3121	warn Carp::longmess "post_cleanup backtrace"
		3122	if $make_core;
		3123	}
		3124
2004	sub reload() {	3125	sub do_reload_perl() {
2005	# can/must only be called in main	3126	# can/must only be called in main
2006	if ($Coro::current != $Coro::main) {	3127	if ($Coro::current != $Coro::main) {
2007	warn "can only reload from main coroutine\n";	3128	warn "can only reload from main coroutine";
2008	return;	3129	return;
2009	}	3130	}
2010		3131
2011	warn "reloading...";	3132	warn "reloading...";
2012		3133
2013	local $FREEZE = 1;	3134	warn "entering sync_job";
		3135
		3136	cf::sync_job {
		3137	cf::write_runtime; # external watchdog should not bark
2014	cf::emergency_save;	3138	cf::emergency_save;
		3139	cf::write_runtime; # external watchdog should not bark
2015		3140
2016	eval {	3141	warn "syncing database to disk";
		3142	BDB::db_env_txn_checkpoint $DB_ENV;
		3143
2017	# if anything goes wrong in here, we should simply crash as we already saved	3144	# if anything goes wrong in here, we should simply crash as we already saved
2018		3145
2019	# cancel all watchers	3146	warn "cancelling all WF_AUTOCANCEL watchers";
2020	for (Event::all_watchers) {	3147	for (Event::all_watchers) {
2021	$_->cancel if $_->data & WF_AUTOCANCEL;	3148	$_->cancel if $_->data & WF_AUTOCANCEL;
2022	}	3149	}
2023		3150
		3151	warn "flushing outstanding aio requests";
		3152	for (;;) {
		3153	BDB::flush;
		3154	IO::AIO::flush;
		3155	Coro::cede;
		3156	last unless IO::AIO::nreqs || BDB::nreqs;
		3157	warn "iterate...";
		3158	}
		3159
		3160	++$RELOAD;
		3161
2024	# cancel all extension coros	3162	warn "cancelling all extension coros";
2025	$_->cancel for values %EXT_CORO;	3163	$_->cancel for values %EXT_CORO;
2026	%EXT_CORO = ();	3164	%EXT_CORO = ();
2027		3165
2028	# unload all extensions	3166	warn "removing commands";
2029	for (@exts) {	3167	%COMMAND = ();
		3168
		3169	warn "removing ext/exti commands";
		3170	%EXTCMD = ();
		3171	%EXTICMD = ();
		3172
		3173	warn "unloading/nuking all extensions";
		3174	for my $pkg (@EXTS) {
2030	warn "unloading <$_>";	3175	warn "... unloading $pkg";
2031	unload_extension $_;	3176
		3177	if (my $cb = $pkg->can ("unload")) {
		3178	eval {
		3179	$cb->($pkg);
		3180	1
		3181	} or warn "$pkg unloaded, but with errors: $@";
2032	}	3182	}
2033		3183
		3184	warn "... nuking $pkg";
		3185	Symbol::delete_package $pkg;
		3186	}
		3187
2034	# unload all modules loaded from $LIBDIR	3188	warn "unloading all perl modules loaded from $LIBDIR";
2035	while (my ($k, $v) = each %INC) {	3189	while (my ($k, $v) = each %INC) {
2036	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3190	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037		3191
2038	warn "removing <$k>";	3192	warn "... unloading $k";
2039	delete $INC{$k};	3193	delete $INC{$k};
2040		3194
2041	$k =~ s/\.pm$//;	3195	$k =~ s/\.pm$//;
2042	$k =~ s/\//::/g;	3196	$k =~ s/\//::/g;
2043		3197
…		…
2046	}	3200	}
2047		3201
2048	Symbol::delete_package $k;	3202	Symbol::delete_package $k;
2049	}	3203	}
2050		3204
2051	# sync database to disk
2052	cf::db_sync;
2053	IO::AIO::flush;
2054
2055	# get rid of safe::, as good as possible	3205	warn "getting rid of safe::, as good as possible";
2056	Symbol::delete_package "safe::$_"	3206	Symbol::delete_package "safe::$_"
2057	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3207	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058		3208
2059	# remove register_script_function callbacks
2060	# TODO
2061
2062	# unload cf.pm "a bit"	3209	warn "unloading cf.pm \"a bit\"";
2063	delete $INC{"cf.pm"};	3210	delete $INC{"cf.pm"};
		3211	delete $INC{"cf/pod.pm"};
2064		3212
2065	# don't, removes xs symbols, too,	3213	# don't, removes xs symbols, too,
2066	# and global variables created in xs	3214	# and global variables created in xs
2067	#Symbol::delete_package __PACKAGE__;	3215	#Symbol::delete_package __PACKAGE__;
2068		3216
2069	# reload cf.pm	3217	warn "unload completed, starting to reload now";
		3218
2070	warn "reloading cf.pm";	3219	warn "reloading cf.pm";
2071	require cf;	3220	require cf;
2072	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3221	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073		3222
2074	# load config and database again	3223	warn "loading config and database again";
2075	cf::cfg_load;	3224	cf::cfg_load;
2076	cf::db_load;
2077		3225
2078	# load extensions
2079	warn "load extensions";	3226	warn "loading extensions";
2080	cf::load_extensions;	3227	cf::load_extensions;
2081		3228
2082	# reattach attachments to objects	3229	warn "reattaching attachments to objects/players";
2083	warn "reattach";	3230	_global_reattach; # objects, sockets
2084	_global_reattach;	3231	warn "reattaching attachments to maps";
2085	};	3232	reattach $_ for values %MAP;
		3233	warn "reattaching attachments to players";
		3234	reattach $_ for values %PLAYER;
2086		3235
2087	if ($@) {	3236	warn "leaving sync_job";
		3237
		3238	1
		3239	} or do {
2088	warn $@;	3240	warn $@;
2089	warn "error while reloading, exiting.";	3241	warn "error while reloading, exiting.";
2090	exit 1;	3242	exit 1;
2091	}	3243	};
2092		3244
2093	warn "reloaded successfully";	3245	warn "reloaded";
2094	};	3246	};
2095		3247
2096	#############################################################################	3248	our $RELOAD_WATCHER; # used only during reload
2097		3249
2098	unless ($LINK_MAP) {	3250	sub reload_perl() {
2099	$LINK_MAP = cf::map::new;	3251	# doing reload synchronously and two reloads happen back-to-back,
		3252	# coro crashes during coro_state_free->destroy here.
2100		3253
2101	$LINK_MAP->width (41);	3254	$RELOAD_WATCHER ||= Event->timer (
2102	$LINK_MAP->height (41);	3255	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,	3256	after => 0,
		3257	data => WF_AUTOCANCEL,
2111	cb => sub {	3258	cb => sub {
2112	$_[0]->w->cancel;	3259	do_reload_perl;
2113		3260	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	});	3261	},
2132		3262	);
2133	$LINK_MAP->{deny_save} = 1;
2134	$LINK_MAP->{deny_reset} = 1;
2135
2136	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137	}	3263	}
2138
2139	register "<global>", __PACKAGE__;
2140		3264
2141	register_command "reload" => sub {	3265	register_command "reload" => sub {
2142	my ($who, $arg) = @_;	3266	my ($who, $arg) = @_;
2143		3267
2144	if ($who->flag (FLAG_WIZ)) {	3268	if ($who->flag (FLAG_WIZ)) {
2145	$who->message ("start of reload.");
2146	reload;
2147	$who->message ("end of reload.");	3269	$who->message ("reloading server.");
		3270	async { reload_perl };
2148	}	3271	}
2149	};	3272	};
2150		3273
2151	unshift @INC, $LIBDIR;	3274	unshift @INC, $LIBDIR;
2152		3275
		3276	my $bug_warning = 0;
		3277
		3278	our @WAIT_FOR_TICK;
		3279	our @WAIT_FOR_TICK_BEGIN;
		3280
		3281	sub wait_for_tick {
		3282	return unless $TICK_WATCHER->is_active;
		3283	return if $Coro::current == $Coro::main;
		3284
		3285	my $signal = new Coro::Signal;
		3286	push @WAIT_FOR_TICK, $signal;
		3287	$signal->wait;
		3288	}
		3289
		3290	sub wait_for_tick_begin {
		3291	return unless $TICK_WATCHER->is_active;
		3292	return if $Coro::current == $Coro::main;
		3293
		3294	my $signal = new Coro::Signal;
		3295	push @WAIT_FOR_TICK_BEGIN, $signal;
		3296	$signal->wait;
		3297	}
		3298
		3299	my $min = 1e6;#d#
		3300	my $avg = 10;
2153	$TICK_WATCHER = Event->timer (	3301	$TICK_WATCHER = Event->timer (
2154	reentrant => 0,	3302	reentrant => 0,
		3303	parked => 1,
2155	prio => 0,	3304	prio => 0,
2156	at => $NEXT_TICK || $TICK,	3305	at => $NEXT_TICK || $TICK,
2157	data => WF_AUTOCANCEL,	3306	data => WF_AUTOCANCEL,
2158	cb => sub {	3307	cb => sub {
2159	unless ($FREEZE) {	3308	if ($Coro::current != $Coro::main) {
		3309	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3310	unless ++$bug_warning > 10;
		3311	return;
		3312	}
		3313
		3314	$NOW = $tick_start = Event::time;
		3315
2160	cf::server_tick; # one server iteration	3316	cf::server_tick; # one server iteration
2161	$RUNTIME += $TICK;	3317
		3318	0 && sync_job {#d#
		3319	for(1..10) {
		3320	my $t = Event::time;
		3321	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3322	or die;
		3323
		3324	$map->width (50);
		3325	$map->height (50);
		3326	$map->alloc;
		3327	$map->_load_objects ("/tmp/x.map", 1);
		3328	my $t = Event::time - $t;
		3329
		3330	#next unless $t < 0.0013;#d#
		3331	if ($t < $min) {
		3332	$min = $t;
		3333	}
		3334	$avg = $avg * 0.99 + $t * 0.01;
		3335	}
		3336	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3337	exit 0;
		3338	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2162	}	3339	};
2163		3340
		3341	$RUNTIME += $TICK;
2164	$NEXT_TICK += $TICK;	3342	$NEXT_TICK += $TICK;
2165		3343
		3344	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3345	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3346	Coro::async_pool {
		3347	write_runtime
		3348	or warn "ERROR: unable to write runtime file: $!";
		3349	};
		3350	}
		3351
		3352	# my $AFTER = Event::time;
		3353	# warn $AFTER - $NOW;#d#
		3354
		3355	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3356	$sig->send;
		3357	}
		3358	while (my $sig = shift @WAIT_FOR_TICK) {
		3359	$sig->send;
		3360	}
		3361
		3362	$NOW = Event::time;
		3363
2166	# if we are delayed by four ticks or more, skip them all	3364	# if we are delayed by four ticks or more, skip them all
2167	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3365	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2168		3366
2169	$TICK_WATCHER->at ($NEXT_TICK);	3367	$TICK_WATCHER->at ($NEXT_TICK);
2170	$TICK_WATCHER->start;	3368	$TICK_WATCHER->start;
		3369
		3370	$LOAD = ($NOW - $tick_start) / $TICK;
		3371	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3372
		3373	_post_tick;
		3374
		3375
2171	},	3376	},
2172	);	3377	);
2173		3378
		3379	{
2174	IO::AIO::max_poll_time $TICK * 0.2;	3380	BDB::max_poll_time $TICK * 0.1;
2175		3381	$BDB_POLL_WATCHER = Event->io (
2176	Event->io (	3382	reentrant => 0,
2177	fd => IO::AIO::poll_fileno,	3383	fd => BDB::poll_fileno,
2178	poll => 'r',	3384	poll => 'r',
2179	prio => 5,	3385	prio => 0,
2180	data => WF_AUTOCANCEL,
2181	cb => \&IO::AIO::poll_cb,
2182	);
2183
2184	Event->timer (
2185	data => WF_AUTOCANCEL,	3386	data => WF_AUTOCANCEL,
2186	after => 0,	3387	cb => \&BDB::poll_cb,
2187	interval => 10,	3388	);
2188	cb => sub {	3389	BDB::min_parallel 8;
2189	(Coro::unblock_sub {	3390
2190	write_runtime	3391	BDB::set_sync_prepare {
2191	or warn "ERROR: unable to write runtime file: $!";	3392	my $status;
		3393	my $current = $Coro::current;
		3394	(
		3395	sub {
		3396	$status = $!;
		3397	$current->ready; undef $current;
		3398	},
		3399	sub {
		3400	Coro::schedule while defined $current;
		3401	$! = $status;
		3402	},
		3403	)
		3404	};
		3405
		3406	unless ($DB_ENV) {
		3407	$DB_ENV = BDB::db_env_create;
		3408
		3409	cf::sync_job {
		3410	eval {
		3411	BDB::db_env_open
		3412	$DB_ENV,
		3413	$BDBDIR,
		3414	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3415	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3416	0666;
		3417
		3418	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3419
		3420	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3421	$DB_ENV->set_lk_detect;
		3422	};
		3423
		3424	cf::cleanup "db_env_open(db): $@" if $@;
2192	})->();	3425	};
2193	},	3426	}
2194	);	3427	}
		3428
		3429	{
		3430	IO::AIO::min_parallel 8;
		3431
		3432	undef $Coro::AIO::WATCHER;
		3433	IO::AIO::max_poll_time $TICK * 0.1;
		3434	$AIO_POLL_WATCHER = Event->io (
		3435	reentrant => 0,
		3436	data => WF_AUTOCANCEL,
		3437	fd => IO::AIO::poll_fileno,
		3438	poll => 'r',
		3439	prio => 6,
		3440	cb => \&IO::AIO::poll_cb,
		3441	);
		3442	}
		3443
		3444	my $_log_backtrace;
		3445
		3446	sub _log_backtrace {
		3447	my ($msg, @addr) = @_;
		3448
		3449	$msg =~ s/\n//;
		3450
		3451	# limit the # of concurrent backtraces
		3452	if ($_log_backtrace < 2) {
		3453	++$_log_backtrace;
		3454	async {
		3455	my @bt = fork_call {
		3456	@addr = map { sprintf "%x", $_ } @addr;
		3457	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3458	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3459	or die "addr2line: $!";
		3460
		3461	my @funcs;
		3462	my @res = <$fh>;
		3463	chomp for @res;
		3464	while (@res) {
		3465	my ($func, $line) = splice @res, 0, 2, ();
		3466	push @funcs, "[$func] $line";
		3467	}
		3468
		3469	@funcs
		3470	};
		3471
		3472	LOG llevInfo, "[ABT] $msg\n";
		3473	LOG llevInfo, "[ABT] $_\n" for @bt;
		3474	--$_log_backtrace;
		3475	};
		3476	} else {
		3477	LOG llevInfo, "[ABT] $msg\n";
		3478	LOG llevInfo, "[ABT] [suppressed]\n";
		3479	}
		3480	}
		3481
		3482	# load additional modules
		3483	use cf::pod;
		3484
		3485	END { cf::emergency_save }
2195		3486
2196	1	3487	1
2197		3488

Diff Legend

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