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

Diff Legend

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