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.121 by root, Tue Jan 2 11:11:52 2007 UTC vs.
Revision 1.334 by root, Mon Aug 20 22:09:04 2007 UTC

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

Diff Legend

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