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.118 by root, Mon Jan 1 21:19:52 2007 UTC vs.
Revision 1.278 by root, Mon Jun 11 21:38:14 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.61 ();
		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;
19		24
		25	use BDB ();
		26	use Data::Dumper;
20	use Digest::MD5;	27	use Digest::MD5;
21	use Fcntl;	28	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
24	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
25		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
27		41
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
30		44
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		46
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		48
35	our %COMMAND = ();	49	our %COMMAND = ();
36	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
38		56
		57	our $RELOAD; # number of reloads so far
39	our @EVENT;	58	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		59
42	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	76	our $NEXT_TICK;
45	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
46		82
47	our %CFG;	83	our %CFG;
48		84
49	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	86	our $RUNTIME;
51		87
		88	our %PLAYER; # all users
52	our %MAP; # all maps	89	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
54	our $FREEZE;	91
55	our $RANDOM_MAPS = cf::localdir . "/random";	92	# used to convert map paths into valid unix filenames by replacing / by ∕
56	our %EXT_CORO;	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
57		98
58	binmode STDOUT;	99	binmode STDOUT;
59	binmode STDERR;	100	binmode STDERR;
60		101
61	# read virtual server time, if available	102	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
66	}	107	}
67		108
68	mkdir cf::localdir;	109	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		111
74	# a special map that is always available	112	our $EMERGENCY_POSITION;
75	our $LINK_MAP;
76		113
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	114	sub cf::map::normalise;
78		115
79	#############################################################################	116	#############################################################################
80		117
81	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
82		119
…		…
89	=item $cf::RUNTIME	126	=item $cf::RUNTIME
90		127
91	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
92	every server tick.	129	every server tick.
93		130
94	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95		134
96	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
97	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
98		139
99	=item $cf::NOW	140	=item $cf::NOW
100		141
101	The time of the last (current) server tick.	142	The time of the last (current) server tick.
102		143
103	=item $cf::TICK	144	=item $cf::TICK
104		145
105	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
106		157
107	=item %cf::CFG	158	=item %cf::CFG
108		159
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
110	from wherever your confdir points to.	161	from wherever your confdir points to.
		162
		163	=item cf::wait_for_tick, cf::wait_for_tick_begin
		164
		165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		166	returns directly I<after> the tick processing (and consequently, can only wake one process
		167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
111		168
112	=back	169	=back
113		170
114	=cut	171	=cut
115		172
116	BEGIN {	173	BEGIN {
117	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	175	my $msg = join "", @_;
119	utf8::encode $msg;
120		176
121	$msg .= "\n"	177	$msg .= "\n"
122	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
123		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
124	LOG llevError, "cfperl: $msg";	183	LOG llevError, $msg;
125	};	184	};
126	}	185	}
127		186
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134		194
135	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
136	# within the Safe compartment.	196	# within the Safe compartment.
137	for my $pkg (qw(	197	for my $pkg (qw(
138	cf::global cf::attachable	198	cf::global cf::attachable
…		…
147		207
148	$Event::DIED = sub {	208	$Event::DIED = sub {
149	warn "error in event callback: @_";	209	warn "error in event callback: @_";
150	};	210	};
151		211
152	my %ext_pkg;
153	my @exts;
154	my @hook;
155
156	=head2 UTILITY FUNCTIONS	212	=head2 UTILITY FUNCTIONS
157		213
158	=over 4	214	=over 4
159		215
160	=cut	216	=item dumpval $ref
161		217
		218	=cut
		219
		220	sub dumpval {
		221	eval {
		222	local $SIG{__DIE__};
		223	my $d;
		224	if (1) {
		225	$d = new Data::Dumper([$_[0]], ["*var"]);
		226	$d->Terse(1);
		227	$d->Indent(2);
		228	$d->Quotekeys(0);
		229	$d->Useqq(1);
		230	#$d->Bless(...);
		231	$d->Seen($_[1]) if @_ > 1;
		232	$d = $d->Dump();
		233	}
		234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		235	$d
		236	} || "[unable to dump $_[0]: '$@']";
		237	}
		238
162	use JSON::Syck (); # TODO# replace by JSON::PC once working	239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
163		240
164	=item $ref = cf::from_json $json	241	=item $ref = cf::from_json $json
165		242
166	Converts a JSON string into the corresponding perl data structure.	243	Converts a JSON string into the corresponding perl data structure.
167		244
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	245	=item $json = cf::to_json $ref
176		246
177	Converts a perl data structure into its JSON representation.	247	Converts a perl data structure into its JSON representation.
178		248
179	=cut	249	=item cf::lock_wait $string
180		250
181	sub to_json($) {	251	Wait until the given lock is available. See cf::lock_acquire.
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	252
183	JSON::Syck::Dump $_[0]	253	=item my $lock = cf::lock_acquire $string
		254
		255	Wait until the given lock is available and then acquires it and returns
		256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		257	for example when the coroutine gets canceled), the lock is automatically
		258	returned.
		259
		260	Lock names should begin with a unique identifier (for example, cf::map::find
		261	uses map_find and cf::map::load uses map_load).
		262
		263	=item $locked = cf::lock_active $string
		264
		265	Return true if the lock is currently active, i.e. somebody has locked it.
		266
		267	=cut
		268
		269	our %LOCK;
		270
		271	sub lock_wait($) {
		272	my ($key) = @_;
		273
		274	# wait for lock, if any
		275	while ($LOCK{$key}) {
		276	push @{ $LOCK{$key} }, $Coro::current;
		277	Coro::schedule;
		278	}
184	}	279	}
		280
		281	sub lock_acquire($) {
		282	my ($key) = @_;
		283
		284	# wait, to be sure we are not locked
		285	lock_wait $key;
		286
		287	$LOCK{$key} = [];
		288
		289	Coro::guard {
		290	# wake up all waiters, to be on the safe side
		291	$_->ready for @{ delete $LOCK{$key} };
		292	}
		293	}
		294
		295	sub lock_active($) {
		296	my ($key) = @_;
		297
		298	! ! $LOCK{$key}
		299	}
		300
		301	sub freeze_mainloop {
		302	return unless $TICK_WATCHER->is_active;
		303
		304	my $guard = Coro::guard {
		305	$TICK_WATCHER->start;
		306	};
		307	$TICK_WATCHER->stop;
		308	$guard
		309	}
		310
		311	=item cf::async { BLOCK }
		312
		313	Currently the same as Coro::async_pool, meaning you cannot use
		314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		315	thing you are allowed to do is call C<prio> on it.
		316
		317	=cut
		318
		319	BEGIN { *async = \&Coro::async_pool }
185		320
186	=item cf::sync_job { BLOCK }	321	=item cf::sync_job { BLOCK }
187		322
188	The design of crossfire+ requires that the main coro ($Coro::main) is	323	The design of crossfire+ requires that the main coro ($Coro::main) is
189	always able to handle events or runnable, as crossfire+ is only partly	324	always able to handle events or runnable, as crossfire+ is only partly
…		…
198		333
199	sub sync_job(&) {	334	sub sync_job(&) {
200	my ($job) = @_;	335	my ($job) = @_;
201		336
202	if ($Coro::current == $Coro::main) {	337	if ($Coro::current == $Coro::main) {
		338	my $time = Event::time;
		339
203	# this is the main coro, too bad, we have to block	340	# this is the main coro, too bad, we have to block
204	# till the operation succeeds, freezing the server :/	341	# till the operation succeeds, freezing the server :/
205		342
206	# TODO: use suspend/resume instead	343	# TODO: use suspend/resume instead
207	# (but this is cancel-safe)	344	# (but this is cancel-safe)
208	local $FREEZE = 1;	345	my $freeze_guard = freeze_mainloop;
209		346
210	my $busy = 1;	347	my $busy = 1;
211	my @res;	348	my @res;
212		349
213	(Coro::async {	350	(async {
214	@res = eval { $job->() };	351	@res = eval { $job->() };
215	warn $@ if $@;	352	warn $@ if $@;
216	undef $busy;	353	undef $busy;
217	})->prio (Coro::PRIO_MAX);	354	})->prio (Coro::PRIO_MAX);
218		355
219	while ($busy) {	356	while ($busy) {
220	Coro::cede_notself;	357	Coro::cede or Event::one_event;
221	Event::one_event unless Coro::nready;
222	}	358	}
		359
		360	$time = Event::time - $time;
		361
		362	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		363	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		364
		365	$tick_start += $time; # do not account sync jobs to server load
223		366
224	wantarray ? @res : $res[0]	367	wantarray ? @res : $res[0]
225	} else {	368	} else {
226	# we are in another coroutine, how wonderful, everything just works	369	# we are in another coroutine, how wonderful, everything just works
227		370
228	$job->()	371	$job->()
229	}	372	}
230	}	373	}
231		374
232	=item $coro = cf::coro { BLOCK }	375	=item $coro = cf::async_ext { BLOCK }
233		376
234	Creates and returns a new coro. This coro is automcatially being canceled	377	Like async, but this coro is automatically being canceled when the
235	when the extension calling this is being unloaded.	378	extension calling this is being unloaded.
236		379
237	=cut	380	=cut
238		381
239	sub coro(&) {	382	sub async_ext(&) {
240	my $cb = shift;	383	my $cb = shift;
241		384
242	my $coro; $coro = async {	385	my $coro = &Coro::async ($cb);
243	eval {
244	$cb->();
245	};
246	warn $@ if $@;
247	};
248		386
249	$coro->on_destroy (sub {	387	$coro->on_destroy (sub {
250	delete $EXT_CORO{$coro+0};	388	delete $EXT_CORO{$coro+0};
251	});	389	});
252	$EXT_CORO{$coro+0} = $coro;	390	$EXT_CORO{$coro+0} = $coro;
253		391
254	$coro	392	$coro
255	}	393	}
256		394
257	sub write_runtime {	395	sub write_runtime {
258	my $runtime = cf::localdir . "/runtime";	396	my $runtime = "$LOCALDIR/runtime";
		397
		398	# first touch the runtime file to show we are still running:
		399	# the fsync below can take a very very long time.
		400
		401	IO::AIO::aio_utime $runtime, undef, undef;
		402
		403	my $guard = cf::lock_acquire "write_runtime";
259		404
260	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
261	or return;	406	or return;
262		407
		408	my $value = $cf::RUNTIME + 90 + 10;
263	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	409	# 10 is the runtime save interval, for a monotonic clock
		410	# 60 allows for the watchdog to kill the server.
		411
264	(aio_write $fh, 0, (length $value), $value, 0) <= 0	412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
265	and return;	413	and return;
266		414
		415	# always fsync - this file is important
267	aio_fsync $fh	416	aio_fsync $fh
268	and return;	417	and return;
269		418
		419	# touch it again to show we are up-to-date
		420	aio_utime $fh, undef, undef;
		421
270	close $fh	422	close $fh
271	or return;	423	or return;
272		424
273	aio_rename "$runtime~", $runtime	425	aio_rename "$runtime~", $runtime
274	and return;	426	and return;
275		427
		428	warn "runtime file written.\n";
		429
276	1	430	1
277	}	431	}
278		432
		433	=item cf::datalog type => key => value, ...
		434
		435	Log a datalog packet of the given type with the given key-value pairs.
		436
		437	=cut
		438
		439	sub datalog($@) {
		440	my ($type, %kv) = @_;
		441	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		442	}
		443
279	=back	444	=back
280		445
281	=cut	446	=cut
282
283	#############################################################################
284
285	package cf::path;
286
287	sub new {
288	my ($class, $path, $base) = @_;
289
290	$path = $path->as_string if ref $path;
291
292	my $self = bless { }, $class;
293
294	# {... are special paths that are not touched
295	# ?xxx/... are special absolute paths
296	# ?random/... random maps
297	# /! non-realised random map exit
298	# /... normal maps
299	# ~/... per-player maps without a specific player (DO NOT USE)
300	# ~user/... per-player map of a specific user
301
302	if ($path =~ /^{/) {
303	# fine as it is
304	} elsif ($path =~ s{^\?random/}{}) {
305	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
306	$self->{random} = cf::from_json $data;
307	} else {
308	if ($path =~ s{^~([^/]+)?}{}) {
309	$self->{user_rel} = 1;
310
311	if (defined $1) {
312	$self->{user} = $1;
313	} elsif ($base =~ m{^~([^/]+)/}) {
314	$self->{user} = $1;
315	} else {
316	warn "cannot resolve user-relative path without user <$path,$base>\n";
317	}
318	} elsif ($path =~ /^\//) {
319	# already absolute
320	} else {
321	$base =~ s{[^/]+/?$}{};
322	return $class->new ("$base/$path");
323	}
324
325	for ($path) {
326	redo if s{/\.?/}{/};
327	redo if s{/[^/]+/\.\./}{/};
328	}
329	}
330
331	$self->{path} = $path;
332
333	$self
334	}
335
336	# the name / primary key / in-game path
337	sub as_string {
338	my ($self) = @_;
339
340	$self->{user_rel} ? "~$self->{user}$self->{path}"
341	: $self->{random} ? "?random/$self->{path}"
342	: $self->{path}
343	}
344
345	# the displayed name, this is a one way mapping
346	sub visible_name {
347	my ($self) = @_;
348
349	# if (my $rmp = $self->{random}) {
350	# # todo: be more intelligent about this
351	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
352	# } else {
353	$self->as_string
354	# }
355	}
356
357	# escape the /'s in the path
358	sub _escaped_path {
359	# ∕ is U+2215
360	(my $path = $_[0]{path}) =~ s/\//∕/g;
361	$path
362	}
363
364	# the original (read-only) location
365	sub load_path {
366	my ($self) = @_;
367
368	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
369	}
370
371	# the temporary/swap location
372	sub save_path {
373	my ($self) = @_;
374
375	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
376	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
377	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
378	}
379
380	# the unique path, might be eq to save_path
381	sub uniq_path {
382	my ($self) = @_;
383
384	$self->{user_rel} || $self->{random}
385	? undef
386	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
387	}
388
389	# return random map parameters, or undef
390	sub random_map_params {
391	my ($self) = @_;
392
393	$self->{random}
394	}
395
396	# this is somewhat ugly, but style maps do need special treatment
397	sub is_style_map {
398	$_[0]{path} =~ m{^/styles/}
399	}
400
401	package cf;
402		447
403	#############################################################################	448	#############################################################################
404		449
405	=head2 ATTACHABLE OBJECTS	450	=head2 ATTACHABLE OBJECTS
406		451
…		…
532	our @CB_TYPE = (); # registry for type (cf-object class) based events	577	our @CB_TYPE = (); # registry for type (cf-object class) based events
533	our @CB_MAP = ();	578	our @CB_MAP = ();
534		579
535	my %attachment;	580	my %attachment;
536		581
		582	sub cf::attachable::thawer_merge {
		583	# simply override everything except _meta
		584	local $_[0]{_meta};
		585	%{$_[0]} = %{$_[1]};
		586	}
		587
537	sub _attach_cb($$$$) {	588	sub _attach_cb($$$$) {
538	my ($registry, $event, $prio, $cb) = @_;	589	my ($registry, $event, $prio, $cb) = @_;
539		590
540	use sort 'stable';	591	use sort 'stable';
541		592
…		…
575	$registry = $CB_TYPE[$object_type] ||= [];	626	$registry = $CB_TYPE[$object_type] ||= [];
576		627
577	} elsif ($type eq "subtype") {	628	} elsif ($type eq "subtype") {
578	defined $object_type or Carp::croak "subtype specified without type";	629	defined $object_type or Carp::croak "subtype specified without type";
579	my $object_subtype = shift @arg;	630	my $object_subtype = shift @arg;
580	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	631	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
581		632
582	} elsif ($type eq "package") {	633	} elsif ($type eq "package") {
583	my $pkg = shift @arg;	634	my $pkg = shift @arg;
584		635
585	while (my ($name, $id) = each %cb_id) {	636	while (my ($name, $id) = each %cb_id) {
…		…
626	if (ref $_[0]) {	677	if (ref $_[0]) {
627	_object_attach @_;	678	_object_attach @_;
628	} else {	679	} else {
629	_attach shift->_attach_registry, @_;	680	_attach shift->_attach_registry, @_;
630	}	681	}
		682	_recalc_want;
631	};	683	};
632		684
633	# all those should be optimised	685	# all those should be optimised
634	sub cf::attachable::detach {	686	sub cf::attachable::detach {
635	my ($obj, $name) = @_;	687	my ($obj, $name) = @_;
…		…
638	delete $obj->{_attachment}{$name};	690	delete $obj->{_attachment}{$name};
639	reattach ($obj);	691	reattach ($obj);
640	} else {	692	} else {
641	Carp::croak "cannot, currently, detach class attachments";	693	Carp::croak "cannot, currently, detach class attachments";
642	}	694	}
		695	_recalc_want;
643	};	696	};
644		697
645	sub cf::attachable::attached {	698	sub cf::attachable::attached {
646	my ($obj, $name) = @_;	699	my ($obj, $name) = @_;
647		700
…		…
712	# object support	765	# object support
713		766
714	sub reattach {	767	sub reattach {
715	# basically do the same as instantiate, without calling instantiate	768	# basically do the same as instantiate, without calling instantiate
716	my ($obj) = @_;	769	my ($obj) = @_;
		770
		771	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
717		772
718	my $registry = $obj->registry;	773	my $registry = $obj->registry;
719		774
720	@$registry = ();	775	@$registry = ();
721		776
…		…
768	$filename, length $$rdata, scalar @$objs;	823	$filename, length $$rdata, scalar @$objs;
769		824
770	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
771	chmod SAVE_MODE, $fh;	826	chmod SAVE_MODE, $fh;
772	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
773	aio_fsync $fh;	828	aio_fsync $fh if $cf::USE_FSYNC;
774	close $fh;	829	close $fh;
775		830
776	if (@$objs) {	831	if (@$objs) {
777	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	832	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
778	chmod SAVE_MODE, $fh;	833	chmod SAVE_MODE, $fh;
779	my $data = Storable::nfreeze { version => 1, objs => $objs };	834	my $data = Storable::nfreeze { version => 1, objs => $objs };
780	aio_write $fh, 0, (length $data), $data, 0;	835	aio_write $fh, 0, (length $data), $data, 0;
781	aio_fsync $fh;	836	aio_fsync $fh if $cf::USE_FSYNC;
782	close $fh;	837	close $fh;
783	aio_rename "$filename.pst~", "$filename.pst";	838	aio_rename "$filename.pst~", "$filename.pst";
784	}	839	}
785	} else {	840	} else {
786	aio_unlink "$filename.pst";	841	aio_unlink "$filename.pst";
…		…
818	or return;	873	or return;
819	$av = eval { (Storable::thaw $av)->{objs} };	874	$av = eval { (Storable::thaw $av)->{objs} };
820	}	875	}
821		876
822	warn sprintf "loading %s (%d)\n",	877	warn sprintf "loading %s (%d)\n",
823	$filename, length $data, scalar @{$av || []};#d#	878	$filename, length $data, scalar @{$av || []};
824	return ($data, $av);	879	return ($data, $av);
825	}	880	}
826		881
827	#############################################################################	882	#############################################################################
828	# command handling &c	883	# command handling &c
…		…
853	=cut	908	=cut
854		909
855	sub register_extcmd {	910	sub register_extcmd {
856	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
857		912
858	my $caller = caller;
859	#warn "registering extcmd '$name' to '$caller'";
860
861	$EXTCMD{$name} = [$cb, $caller];	913	$EXTCMD{$name} = $cb;
862	}	914	}
863		915
864	cf::player->attach (	916	cf::player->attach (
865	on_command => sub {	917	on_command => sub {
866	my ($pl, $name, $params) = @_;	918	my ($pl, $name, $params) = @_;
…		…
879		931
880	my $msg = eval { from_json $buf };	932	my $msg = eval { from_json $buf };
881		933
882	if (ref $msg) {	934	if (ref $msg) {
883	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
884	if (my %reply = $cb->[0]->($pl, $msg)) {	936	if (my %reply = $cb->($pl, $msg)) {
885	$pl->ext_reply ($msg->{msgid}, %reply);	937	$pl->ext_reply ($msg->{msgid}, %reply);
886	}	938	}
887	}	939	}
888	} else {	940	} else {
889	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
891		943
892	cf::override;	944	cf::override;
893	},	945	},
894	);	946	);
895		947
896	sub register {
897	my ($base, $pkg) = @_;
898
899	#TODO
900	}
901
902	sub load_extension {	948	sub load_extensions {
		949	cf::sync_job {
		950	my %todo;
		951
		952	for my $path (<$LIBDIR/*.ext>) {
		953	next unless -r $path;
		954
		955	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		956	my $base = $1;
		957	my $pkg = $1;
		958	$pkg =~ s/[^[:word:]]/_/g;
		959	$pkg = "ext::$pkg";
		960
		961	open my $fh, "<:utf8", $path
		962	or die "$path: $!";
		963
		964	my $source = do { local $/; <$fh> };
		965
		966	my %ext = (
		967	path => $path,
		968	base => $base,
		969	pkg => $pkg,
		970	);
		971
		972	$ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }
		973	if $source =~ /^#!.*?perl.*?#\s*(.*)$/;
		974
		975	$ext{source} =
		976	"package $pkg; use strict; use utf8;\n"
		977	. "#line 1 \"$path\"\n{\n"
		978	. $source
		979	. "\n};\n1";
		980
		981	$todo{$base} = \%ext;
		982	}
		983
		984	my %done;
		985	while (%todo) {
		986	my $progress;
		987
		988	while (my ($k, $v) = each %todo) {
		989	for (split /,\s*/, $ext{meta}{depends}) {
		990	goto skip
		991	unless exists $done{$_};
		992	}
		993
		994	warn "... loading '$k' into '$v->{pkg}'\n";
		995
		996	unless (eval $v->{source}) {
		997	my $msg = $@ ? "$v->{path}: $@\n"
		998	: "extension disabled.\n";
		999
		1000	if (exists $v->{meta}{mandatory}) {
		1001	warn $msg;
		1002	warn "mandatory extension failed to load, exiting.\n";
		1003	exit 1;
		1004	}
		1005
		1006	die $msg;
		1007	}
		1008
		1009	$done{$k} = delete $todo{$k};
		1010	push @EXTS, $v->{pkg};
		1011	}
		1012
		1013	skip:
		1014	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1015	unless $progress;
		1016	}
		1017	};
		1018	}
		1019
		1020	#############################################################################
		1021
		1022	=head2 CORE EXTENSIONS
		1023
		1024	Functions and methods that extend core crossfire objects.
		1025
		1026	=cut
		1027
		1028	package cf::player;
		1029
		1030	use Coro::AIO;
		1031
		1032	=head3 cf::player
		1033
		1034	=over 4
		1035
		1036	=item cf::player::find $login
		1037
		1038	Returns the given player object, loading it if necessary (might block).
		1039
		1040	=cut
		1041
		1042	sub playerdir($) {
		1043	"$PLAYERDIR/"
		1044	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1045	}
		1046
		1047	sub path($) {
		1048	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1049
		1050	(playerdir $login) . "/playerdata"
		1051	}
		1052
		1053	sub find_active($) {
		1054	$cf::PLAYER{$_[0]}
		1055	and $cf::PLAYER{$_[0]}->active
		1056	and $cf::PLAYER{$_[0]}
		1057	}
		1058
		1059	sub exists($) {
		1060	my ($login) = @_;
		1061
		1062	$cf::PLAYER{$login}
		1063	or cf::sync_job { !aio_stat path $login }
		1064	}
		1065
		1066	sub find($) {
		1067	return $cf::PLAYER{$_[0]} || do {
		1068	my $login = $_[0];
		1069
		1070	my $guard = cf::lock_acquire "user_find:$login";
		1071
		1072	$cf::PLAYER{$_[0]} || do {
		1073	# rename old playerfiles to new ones
		1074	#TODO: remove when no longer required
		1075	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1076	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1077	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1078	aio_unlink +(playerdir $login) . "/$login.pl";
		1079
		1080	my $pl = load_pl path $login
		1081	or return;
		1082	$cf::PLAYER{$login} = $pl
		1083	}
		1084	}
		1085	}
		1086
		1087	sub save($) {
		1088	my ($pl) = @_;
		1089
		1090	return if $pl->{deny_save};
		1091
		1092	my $path = path $pl;
		1093	my $guard = cf::lock_acquire "user_save:$path";
		1094
		1095	return if $pl->{deny_save};
		1096
		1097	aio_mkdir playerdir $pl, 0770;
		1098	$pl->{last_save} = $cf::RUNTIME;
		1099
		1100	$pl->save_pl ($path);
		1101	Coro::cede;
		1102	}
		1103
		1104	sub new($) {
		1105	my ($login) = @_;
		1106
		1107	my $self = create;
		1108
		1109	$self->ob->name ($login);
		1110	$self->{deny_save} = 1;
		1111
		1112	$cf::PLAYER{$login} = $self;
		1113
		1114	$self
		1115	}
		1116
		1117	=item $pl->quit_character
		1118
		1119	Nukes the player without looking back. If logged in, the connection will
		1120	be destroyed. May block for a long time.
		1121
		1122	=cut
		1123
		1124	sub quit_character {
		1125	my ($pl) = @_;
		1126
		1127	my $name = $pl->ob->name;
		1128
		1129	$pl->{deny_save} = 1;
		1130	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1131
		1132	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1133	$pl->deactivate;
		1134	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1135	$pl->ns->destroy if $pl->ns;
		1136
		1137	my $path = playerdir $pl;
		1138	my $temp = "$path~$cf::RUNTIME~deleting~";
		1139	aio_rename $path, $temp;
		1140	delete $cf::PLAYER{$pl->ob->name};
		1141	$pl->destroy;
		1142
		1143	my $prefix = qr<^~\Q$name\E/>;
		1144
		1145	# nuke player maps
		1146	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1147
		1148	IO::AIO::aio_rmtree $temp;
		1149	}
		1150
		1151	=item $pl->kick
		1152
		1153	Kicks a player out of the game. This destroys the connection.
		1154
		1155	=cut
		1156
		1157	sub kick {
		1158	my ($pl, $kicker) = @_;
		1159
		1160	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1161	$pl->killer ("kicked");
		1162	$pl->ns->destroy;
		1163	}
		1164
		1165	=item cf::player::list_logins
		1166
		1167	Returns am arrayref of all valid playernames in the system, can take a
		1168	while and may block, so not sync_job-capable, ever.
		1169
		1170	=cut
		1171
		1172	sub list_logins {
		1173	my $dirs = aio_readdir $PLAYERDIR
		1174	or return [];
		1175
		1176	my @logins;
		1177
		1178	for my $login (@$dirs) {
		1179	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1180	aio_read $fh, 0, 512, my $buf, 0 or next;
		1181	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1182
		1183	utf8::decode $login;
		1184	push @logins, $login;
		1185	}
		1186
		1187	\@logins
		1188	}
		1189
		1190	=item $player->maps
		1191
		1192	Returns an arrayref of map paths that are private for this
		1193	player. May block.
		1194
		1195	=cut
		1196
		1197	sub maps($) {
		1198	my ($pl) = @_;
		1199
		1200	$pl = ref $pl ? $pl->ob->name : $pl;
		1201
		1202	my $files = aio_readdir playerdir $pl
		1203	or return;
		1204
		1205	my @paths;
		1206
		1207	for (@$files) {
		1208	utf8::decode $_;
		1209	next if /\.(?:pl|pst)$/;
		1210	next unless /^$PATH_SEP/o;
		1211
		1212	push @paths, cf::map::normalise "~$pl/$_";
		1213	}
		1214
		1215	\@paths
		1216	}
		1217
		1218	=item $player->ext_reply ($msgid, %msg)
		1219
		1220	Sends an ext reply to the player.
		1221
		1222	=cut
		1223
		1224	sub ext_reply($$%) {
		1225	my ($self, $id, %msg) = @_;
		1226
		1227	$msg{msgid} = $id;
		1228
		1229	$self->send ("ext " . cf::to_json \%msg);
		1230	}
		1231
		1232	=item $player->ext_event ($type, %msg)
		1233
		1234	Sends an ext event to the client.
		1235
		1236	=cut
		1237
		1238	sub ext_event($$%) {
		1239	my ($self, $type, %msg) = @_;
		1240
		1241	$self->ns->ext_event ($type, %msg);
		1242	}
		1243
		1244	=head3 cf::region
		1245
		1246	=over 4
		1247
		1248	=cut
		1249
		1250	package cf::region;
		1251
		1252	=item cf::region::find_by_path $path
		1253
		1254	Tries to decuce the probable region for a map knowing only its path.
		1255
		1256	=cut
		1257
		1258	sub find_by_path($) {
903	my ($path) = @_;	1259	my ($path) = @_;
904		1260
905	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1261	my ($match, $specificity);
906	my $base = $1;
907	my $pkg = $1;
908	$pkg =~ s/[^[:word:]]/_/g;
909	$pkg = "ext::$pkg";
910		1262
911	warn "loading '$path' into '$pkg'\n";	1263	for my $region (list) {
912		1264	if ($region->match && $path =~ $region->match) {
913	open my $fh, "<:utf8", $path	1265	($match, $specificity) = ($region, $region->specificity)
914	or die "$path: $!";	1266	if $region->specificity > $specificity;
915		1267	}
916	my $source =
917	"package $pkg; use strict; use utf8;\n"
918	. "#line 1 \"$path\"\n{\n"
919	. (do { local $/; <$fh> })
920	. "\n};\n1";
921
922	eval $source
923	or die $@ ? "$path: $@\n"
924	: "extension disabled.\n";
925
926	push @exts, $pkg;
927	$ext_pkg{$base} = $pkg;
928
929	# no strict 'refs';
930	# @{"$pkg\::ISA"} = ext::;
931
932	register $base, $pkg;
933	}
934
935	sub unload_extension {
936	my ($pkg) = @_;
937
938	warn "removing extension $pkg\n";
939
940	# remove hooks
941	#TODO
942	# for my $idx (0 .. $#PLUGIN_EVENT) {
943	# delete $hook[$idx]{$pkg};
944	# }	1268	}
945		1269
946	# remove commands	1270	$match
947	for my $name (keys %COMMAND) {
948	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
949
950	if (@cb) {
951	$COMMAND{$name} = \@cb;
952	} else {
953	delete $COMMAND{$name};
954	}
955	}
956
957	# remove extcmds
958	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
959	delete $EXTCMD{$name};
960	}
961
962	if (my $cb = $pkg->can ("unload")) {
963	eval {
964	$cb->($pkg);
965	1
966	} or warn "$pkg unloaded, but with errors: $@";
967	}
968
969	Symbol::delete_package $pkg;
970	}
971
972	sub load_extensions {
973	for my $ext (<$LIBDIR/*.ext>) {
974	next unless -r $ext;
975	eval {
976	load_extension $ext;
977	1
978	} or warn "$ext not loaded: $@";
979	}
980	}
981
982	#############################################################################
983	# load/save/clean perl data associated with a map
984
985	*cf::mapsupport::on_clean = sub {
986	my ($map) = @_;
987
988	my $path = $map->tmpname;
989	defined $path or return;
990
991	unlink "$path.pst";
992	};
993
994	cf::map->attach (prio => -10000, package => cf::mapsupport::);
995
996	#############################################################################
997	# load/save perl data associated with player->ob objects
998
999	sub all_objects(@) {
1000	@_, map all_objects ($_->inv), @_
1001	}
1002
1003	# TODO: compatibility cruft, remove when no longer needed
1004	cf::player->attach (
1005	on_load => sub {
1006	my ($pl, $path) = @_;
1007
1008	for my $o (all_objects $pl->ob) {
1009	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1010	$o->set_ob_key_value ("_perl_data");
1011
1012	%$o = %{ Storable::thaw pack "H*", $value };
1013	}
1014	}
1015	},
1016	);
1017
1018	#############################################################################
1019
1020	=head2 CORE EXTENSIONS
1021
1022	Functions and methods that extend core crossfire objects.
1023
1024	=head3 cf::player
1025
1026	=over 4
1027
1028	=item cf::player::exists $login
1029
1030	Returns true when the given account exists.
1031
1032	=cut
1033
1034	sub cf::player::exists($) {
1035	cf::player::find $_[0]
1036	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1037	}
1038
1039	=item $player->ext_reply ($msgid, $msgtype, %msg)
1040
1041	Sends an ext reply to the player.
1042
1043	=cut
1044
1045	sub cf::player::ext_reply($$$%) {
1046	my ($self, $id, %msg) = @_;
1047
1048	$msg{msgid} = $id;
1049
1050	$self->send ("ext " . to_json \%msg);
1051	}	1271	}
1052		1272
1053	=back	1273	=back
1054
1055		1274
1056	=head3 cf::map	1275	=head3 cf::map
1057		1276
1058	=over 4	1277	=over 4
1059		1278
…		…
1062	package cf::map;	1281	package cf::map;
1063		1282
1064	use Fcntl;	1283	use Fcntl;
1065	use Coro::AIO;	1284	use Coro::AIO;
1066		1285
		1286	use overload
		1287	'""' => \&as_string,
		1288	fallback => 1;
		1289
1067	our $MAX_RESET = 7200;	1290	our $MAX_RESET = 3600;
1068	our $DEFAULT_RESET = 3600;	1291	our $DEFAULT_RESET = 3000;
1069		1292
1070	sub generate_random_map {	1293	sub generate_random_map {
1071	my ($path, $rmp) = @_;	1294	my ($self, $rmp) = @_;
1072
1073	# mit "rum" bekleckern, nicht	1295	# mit "rum" bekleckern, nicht
1074	cf::map::_create_random_map	1296	$self->_create_random_map (
1075	$path,
1076	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1297	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1077	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1298	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1078	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1299	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1079	$rmp->{exit_on_final_map},	1300	$rmp->{exit_on_final_map},
1080	$rmp->{xsize}, $rmp->{ysize},	1301	$rmp->{xsize}, $rmp->{ysize},
1081	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1302	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1082	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1303	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1083	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1304	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1084	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1305	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1085	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1306	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1086	(cf::region::find $rmp->{region})	1307	(cf::region::find $rmp->{region}), $rmp->{custom}
		1308	)
		1309	}
		1310
		1311	=item cf::map->register ($regex, $prio)
		1312
		1313	Register a handler for the map path matching the given regex at the
		1314	givne priority (higher is better, built-in handlers have priority 0, the
		1315	default).
		1316
		1317	=cut
		1318
		1319	sub register {
		1320	my (undef, $regex, $prio) = @_;
		1321	my $pkg = caller;
		1322
		1323	no strict;
		1324	push @{"$pkg\::ISA"}, __PACKAGE__;
		1325
		1326	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1327	}
		1328
		1329	# also paths starting with '/'
		1330	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1331
		1332	sub thawer_merge {
		1333	my ($self, $merge) = @_;
		1334
		1335	# we have to keep some variables in memory intact
		1336	local $self->{path};
		1337	local $self->{load_path};
		1338
		1339	$self->SUPER::thawer_merge ($merge);
		1340	}
		1341
		1342	sub normalise {
		1343	my ($path, $base) = @_;
		1344
		1345	$path = "$path"; # make sure its a string
		1346
		1347	$path =~ s/\.map$//;
		1348
		1349	# map plan:
		1350	#
		1351	# /! non-realised random map exit (special hack!)
		1352	# {... are special paths that are not being touched
		1353	# ?xxx/... are special absolute paths
		1354	# ?random/... random maps
		1355	# /... normal maps
		1356	# ~user/... per-player map of a specific user
		1357
		1358	$path =~ s/$PATH_SEP/\//go;
		1359
		1360	# treat it as relative path if it starts with
		1361	# something that looks reasonable
		1362	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1363	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1364
		1365	$base =~ s{[^/]+/?$}{};
		1366	$path = "$base/$path";
		1367	}
		1368
		1369	for ($path) {
		1370	redo if s{//}{/};
		1371	redo if s{/\.?/}{/};
		1372	redo if s{/[^/]+/\.\./}{/};
		1373	}
		1374
		1375	$path
		1376	}
		1377
		1378	sub new_from_path {
		1379	my (undef, $path, $base) = @_;
		1380
		1381	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1382
		1383	$path = normalise $path, $base;
		1384
		1385	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1386	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1387	my $self = bless cf::map::new, $pkg;
		1388	$self->{path} = $path; $self->path ($path);
		1389	$self->init; # pass $1 etc.
		1390	return $self;
		1391	}
		1392	}
		1393
		1394	Carp::carp "unable to resolve path '$path' (base '$base').";
		1395	()
		1396	}
		1397
		1398	sub init {
		1399	my ($self) = @_;
		1400
		1401	$self
		1402	}
		1403
		1404	sub as_string {
		1405	my ($self) = @_;
		1406
		1407	"$self->{path}"
		1408	}
		1409
		1410	# the displayed name, this is a one way mapping
		1411	sub visible_name {
		1412	&as_string
		1413	}
		1414
		1415	# the original (read-only) location
		1416	sub load_path {
		1417	my ($self) = @_;
		1418
		1419	"$MAPDIR/$self->{path}.map"
		1420	}
		1421
		1422	# the temporary/swap location
		1423	sub save_path {
		1424	my ($self) = @_;
		1425
		1426	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1427	"$TMPDIR/$path.map"
		1428	}
		1429
		1430	# the unique path, undef == no special unique path
		1431	sub uniq_path {
		1432	my ($self) = @_;
		1433
		1434	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1435	"$UNIQUEDIR/$path"
1087	}	1436	}
1088		1437
1089	# and all this just because we cannot iterate over	1438	# and all this just because we cannot iterate over
1090	# all maps in C++...	1439	# all maps in C++...
1091	sub change_all_map_light {	1440	sub change_all_map_light {
1092	my ($change) = @_;	1441	my ($change) = @_;
1093		1442
1094	$_->change_map_light ($change) for values %cf::MAP;	1443	$_->change_map_light ($change)
		1444	for grep $_->outdoor, values %cf::MAP;
1095	}	1445	}
1096		1446
		1447	sub decay_objects {
		1448	my ($self) = @_;
		1449
		1450	return if $self->{deny_reset};
		1451
		1452	$self->do_decay_objects;
		1453	}
		1454
		1455	sub unlink_save {
		1456	my ($self) = @_;
		1457
		1458	utf8::encode (my $save = $self->save_path);
		1459	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1460	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1461	}
		1462
1097	sub try_load_header($) {	1463	sub load_header_from($) {
1098	my ($path) = @_;	1464	my ($self, $path) = @_;
1099		1465
1100	utf8::encode $path;	1466	utf8::encode $path;
1101	aio_open $path, O_RDONLY, 0	1467	#aio_open $path, O_RDONLY, 0
		1468	# or return;
		1469
		1470	$self->_load_header ($path)
1102	or return;	1471	or return;
1103		1472
1104	my $map = cf::map::new	1473	$self->{load_path} = $path;
		1474
		1475	1
		1476	}
		1477
		1478	sub load_header_orig {
		1479	my ($self) = @_;
		1480
		1481	$self->load_header_from ($self->load_path)
		1482	}
		1483
		1484	sub load_header_temp {
		1485	my ($self) = @_;
		1486
		1487	$self->load_header_from ($self->save_path)
		1488	}
		1489
		1490	sub prepare_temp {
		1491	my ($self) = @_;
		1492
		1493	$self->last_access ((delete $self->{last_access})
		1494	|| $cf::RUNTIME); #d#
		1495	# safety
		1496	$self->{instantiate_time} = $cf::RUNTIME
		1497	if $self->{instantiate_time} > $cf::RUNTIME;
		1498	}
		1499
		1500	sub prepare_orig {
		1501	my ($self) = @_;
		1502
		1503	$self->{load_original} = 1;
		1504	$self->{instantiate_time} = $cf::RUNTIME;
		1505	$self->last_access ($cf::RUNTIME);
		1506	$self->instantiate;
		1507	}
		1508
		1509	sub load_header {
		1510	my ($self) = @_;
		1511
		1512	if ($self->load_header_temp) {
		1513	$self->prepare_temp;
		1514	} else {
		1515	$self->load_header_orig
1105	or return;	1516	or return;
		1517	$self->prepare_orig;
		1518	}
1106		1519
1107	$map->load_header ($path)	1520	$self->{deny_reset} = 1
1108	or return;	1521	if $self->no_reset;
1109		1522
1110	$map->{load_path} = $path;	1523	$self->default_region (cf::region::find_by_path $self->{path})
		1524	unless $self->default_region;
1111		1525
1112	$map	1526	1
1113	}	1527	}
1114		1528
		1529	sub find;
1115	sub find_map {	1530	sub find {
1116	my ($path, $origin) = @_;	1531	my ($path, $origin) = @_;
1117		1532
1118	#warn "find_map<$path,$origin>\n";#d#
1119
1120	$path = new cf::path $path, $origin && $origin->path;	1533	$path = normalise $path, $origin && $origin->path;
1121	my $key = $path->as_string;
1122		1534
		1535	cf::lock_wait "map_find:$path";
		1536
1123	$cf::MAP{$key} || do {	1537	$cf::MAP{$path} || do {
1124	# do it the slow way	1538	my $guard = cf::lock_acquire "map_find:$path";
1125	my $map = try_load_header $path->save_path;	1539	my $map = new_from_path cf::map $path
1126
1127	if ($map) {
1128	# safety
1129	$map->{instantiate_time} = $cf::RUNTIME
1130	if $map->{instantiate_time} > $cf::RUNTIME;
1131	} else {
1132	if (my $rmp = $path->random_map_params) {
1133	$map = generate_random_map $key, $rmp;
1134	} else {
1135	$map = try_load_header $path->load_path;
1136	}
1137
1138	$map or return;	1540	or return;
1139		1541
1140	$map->{load_original} = 1;
1141	$map->{instantiate_time} = $cf::RUNTIME;
1142	$map->instantiate;
1143
1144	# per-player maps become, after loading, normal maps
1145	$map->per_player (0) if $path->{user_rel};
1146	}
1147	#Coro::Timer::sleep 1;#d#
1148
1149	$map->path ($key);
1150	$map->{path} = $path;
1151	$map->{last_save} = $cf::RUNTIME;	1542	$map->{last_save} = $cf::RUNTIME;
1152	$map->last_access ($cf::RUNTIME);
1153		1543
1154	if ($map->should_reset) {	1544	$map->load_header
		1545	or return;
		1546
		1547	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1548	# doing this can freeze the server in a sync job, obviously
		1549	#$cf::WAIT_FOR_TICK->wait;
1155	$map->reset;	1550	$map->reset;
1156	$map = find_map $path;	1551	undef $guard;
		1552	return find $path;
1157	}	1553	}
1158		1554
1159	$cf::MAP{$key} = $map	1555	$cf::MAP{$path} = $map
1160	}	1556	}
1161	}	1557	}
		1558
		1559	sub pre_load { }
		1560	sub post_load { }
1162		1561
1163	sub load {	1562	sub load {
1164	my ($self) = @_;	1563	my ($self) = @_;
1165		1564
1166	return if $self->in_memory != cf::MAP_SWAPPED;	1565	local $self->{deny_reset} = 1; # loading can take a long time
1167
1168	$self->in_memory (cf::MAP_LOADING);
1169		1566
1170	my $path = $self->{path};	1567	my $path = $self->{path};
1171		1568
		1569	{
		1570	my $guard = cf::lock_acquire "map_load:$path";
		1571
		1572	return if $self->in_memory != cf::MAP_SWAPPED;
		1573
		1574	$self->in_memory (cf::MAP_LOADING);
		1575
1172	$self->alloc;	1576	$self->alloc;
		1577
		1578	$self->pre_load;
		1579	Coro::cede;
		1580
1173	$self->load_objects ($self->{load_path}, 1)	1581	$self->_load_objects ($self->{load_path}, 1)
1174	or return;	1582	or return;
1175		1583
1176	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1584	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1177	if delete $self->{load_original};	1585	if delete $self->{load_original};
1178		1586
1179	if (my $uniq = $path->uniq_path) {	1587	if (my $uniq = $self->uniq_path) {
1180	utf8::encode $uniq;	1588	utf8::encode $uniq;
1181	if (aio_open $uniq, O_RDONLY, 0) {	1589	if (aio_open $uniq, O_RDONLY, 0) {
1182	$self->clear_unique_items;	1590	$self->clear_unique_items;
1183	$self->load_objects ($uniq, 0);	1591	$self->_load_objects ($uniq, 0);
1184	}	1592	}
1185	}	1593	}
1186		1594
		1595	Coro::cede;
1187	# now do the right thing for maps	1596	# now do the right thing for maps
1188	$self->link_multipart_objects;	1597	$self->link_multipart_objects;
1189
1190	if ($self->{path}->is_style_map) {
1191	$self->{deny_save} = 1;
1192	$self->{deny_reset} = 1;
1193	} else {
1194	$self->fix_auto_apply;
1195	$self->decay_objects;
1196	$self->update_buttons;
1197	$self->set_darkness_map;
1198	$self->difficulty ($self->estimate_difficulty)	1598	$self->difficulty ($self->estimate_difficulty)
1199	unless $self->difficulty;	1599	unless $self->difficulty;
		1600	Coro::cede;
		1601
		1602	unless ($self->{deny_activate}) {
		1603	$self->decay_objects;
		1604	$self->fix_auto_apply;
		1605	$self->update_buttons;
		1606	Coro::cede;
		1607	$self->set_darkness_map;
		1608	Coro::cede;
1200	$self->activate;	1609	$self->activate;
1201	}	1610	}
1202		1611
1203	$self->in_memory (cf::MAP_IN_MEMORY);	1612	$self->in_memory (cf::MAP_IN_MEMORY);
1204	}	1613	}
1205		1614
1206	sub load_map_sync {	1615	$self->post_load;
		1616	}
		1617
		1618	sub customise_for {
		1619	my ($self, $ob) = @_;
		1620
		1621	return find "~" . $ob->name . "/" . $self->{path}
		1622	if $self->per_player;
		1623
		1624	# return find "?party/" . $ob->name . "/" . $self->{path}
		1625	# if $self->per_party;
		1626
		1627	$self
		1628	}
		1629
		1630	# find and load all maps in the 3x3 area around a map
		1631	sub load_diag {
		1632	my ($map) = @_;
		1633
		1634	my @diag; # diagonal neighbours
		1635
		1636	for (0 .. 3) {
		1637	my $neigh = $map->tile_path ($_)
		1638	or next;
		1639	$neigh = find $neigh, $map
		1640	or next;
		1641	$neigh->load;
		1642
		1643	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1644	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1645	}
		1646
		1647	for (@diag) {
		1648	my $neigh = find @$_
		1649	or next;
		1650	$neigh->load;
		1651	}
		1652	}
		1653
		1654	sub find_sync {
1207	my ($path, $origin) = @_;	1655	my ($path, $origin) = @_;
1208		1656
1209	#warn "load_map_sync<$path, $origin>\n";#d#	1657	cf::sync_job { find $path, $origin }
		1658	}
1210		1659
1211	cf::sync_job {	1660	sub do_load_sync {
1212	my $map = cf::map::find_map $path, $origin	1661	my ($map) = @_;
1213	or return;	1662
		1663	cf::sync_job { $map->load };
		1664	}
		1665
		1666	our %MAP_PREFETCH;
		1667	our $MAP_PREFETCHER = undef;
		1668
		1669	sub find_async {
		1670	my ($path, $origin) = @_;
		1671
		1672	$path = normalise $path, $origin && $origin->{path};
		1673
		1674	if (my $map = $cf::MAP{$path}) {
		1675	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1676	}
		1677
		1678	undef $MAP_PREFETCH{$path};
		1679	$MAP_PREFETCHER ||= cf::async {
		1680	while (%MAP_PREFETCH) {
		1681	for my $path (keys %MAP_PREFETCH) {
		1682	my $map = find $path
		1683	or next;
1214	$map->load;	1684	$map->load;
1215	$map	1685
		1686	delete $MAP_PREFETCH{$path};
		1687	}
		1688	}
		1689	undef $MAP_PREFETCHER;
1216	}	1690	};
		1691	$MAP_PREFETCHER->prio (6);
		1692
		1693	()
1217	}	1694	}
1218		1695
1219	sub save {	1696	sub save {
1220	my ($self) = @_;	1697	my ($self) = @_;
1221		1698
		1699	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1700
1222	$self->{last_save} = $cf::RUNTIME;	1701	$self->{last_save} = $cf::RUNTIME;
1223		1702
1224	return unless $self->dirty;	1703	return unless $self->dirty;
1225		1704
1226	my $save = $self->{path}->save_path; utf8::encode $save;	1705	my $save = $self->save_path; utf8::encode $save;
1227	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1706	my $uniq = $self->uniq_path; utf8::encode $uniq;
1228		1707
1229	$self->{load_path} = $save;	1708	$self->{load_path} = $save;
1230		1709
1231	return if $self->{deny_save};	1710	return if $self->{deny_save};
1232		1711
		1712	local $self->{last_access} = $self->last_access;#d#
		1713
		1714	cf::async {
		1715	$_->contr->save for $self->players;
		1716	};
		1717
1233	if ($uniq) {	1718	if ($uniq) {
1234	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1719	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1235	$self->save_objects ($uniq, cf::IO_UNIQUES);	1720	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1236	} else {	1721	} else {
1237	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1722	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1238	}	1723	}
1239	}	1724	}
1240		1725
1241	sub swap_out {	1726	sub swap_out {
1242	my ($self) = @_;	1727	my ($self) = @_;
		1728
		1729	# save first because save cedes
		1730	$self->save;
		1731
		1732	my $lock = cf::lock_acquire "map_data:" . $self->path;
1243		1733
1244	return if $self->players;	1734	return if $self->players;
1245	return if $self->in_memory != cf::MAP_IN_MEMORY;	1735	return if $self->in_memory != cf::MAP_IN_MEMORY;
1246	return if $self->{deny_save};	1736	return if $self->{deny_save};
1247		1737
1248	$self->save;
1249	$self->clear;	1738	$self->clear;
1250	$self->in_memory (cf::MAP_SWAPPED);	1739	$self->in_memory (cf::MAP_SWAPPED);
1251	}	1740	}
1252		1741
1253	sub reset_at {	1742	sub reset_at {
1254	my ($self) = @_;	1743	my ($self) = @_;
1255		1744
1256	# TODO: safety, remove and allow resettable per-player maps	1745	# TODO: safety, remove and allow resettable per-player maps
1257	return 1e99 if $self->{path}{user_rel};
1258	return 1e99 if $self->{deny_reset};	1746	return 1e99 if $self->{deny_reset};
1259		1747
1260	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1748	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1261	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1749	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1262		1750
…		…
1267	my ($self) = @_;	1755	my ($self) = @_;
1268		1756
1269	$self->reset_at <= $cf::RUNTIME	1757	$self->reset_at <= $cf::RUNTIME
1270	}	1758	}
1271		1759
1272	sub unlink_save {
1273	my ($self) = @_;
1274
1275	utf8::encode (my $save = $self->{path}->save_path);
1276	aioreq_pri 3; IO::AIO::aio_unlink $save;
1277	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1278	}
1279
1280	sub rename {
1281	my ($self, $new_path) = @_;
1282
1283	$self->unlink_save;
1284
1285	delete $cf::MAP{$self->path};
1286	$self->{path} = new cf::path $new_path;
1287	$self->path ($self->{path}->as_string);
1288	$cf::MAP{$self->path} = $self;
1289
1290	$self->save;
1291	}
1292
1293	sub reset {	1760	sub reset {
1294	my ($self) = @_;	1761	my ($self) = @_;
1295		1762
		1763	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1764
1296	return if $self->players;	1765	return if $self->players;
1297	return if $self->{path}{user_rel};#d#
1298		1766
1299	warn "resetting map ", $self->path;#d#	1767	warn "resetting map ", $self->path;
		1768
		1769	$self->in_memory (cf::MAP_SWAPPED);
		1770
		1771	# need to save uniques path
		1772	unless ($self->{deny_save}) {
		1773	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1774
		1775	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1776	if $uniq;
		1777	}
1300		1778
1301	delete $cf::MAP{$self->path};	1779	delete $cf::MAP{$self->path};
		1780
		1781	$self->clear;
1302		1782
1303	$_->clear_links_to ($self) for values %cf::MAP;	1783	$_->clear_links_to ($self) for values %cf::MAP;
1304		1784
1305	$self->unlink_save;	1785	$self->unlink_save;
1306	$self->destroy;	1786	$self->destroy;
…		…
1309	my $nuke_counter = "aaaa";	1789	my $nuke_counter = "aaaa";
1310		1790
1311	sub nuke {	1791	sub nuke {
1312	my ($self) = @_;	1792	my ($self) = @_;
1313		1793
		1794	delete $cf::MAP{$self->path};
		1795
		1796	$self->unlink_save;
		1797
		1798	bless $self, "cf::map";
		1799	delete $self->{deny_reset};
1314	$self->{deny_save} = 1;	1800	$self->{deny_save} = 1;
1315	$self->reset_timeout (1);	1801	$self->reset_timeout (1);
1316	$self->rename ("{nuke}/" . ($nuke_counter++));	1802	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1803
		1804	$cf::MAP{$self->path} = $self;
		1805
1317	$self->reset; # polite request, might not happen	1806	$self->reset; # polite request, might not happen
1318	}	1807	}
1319		1808
1320	sub customise_for {	1809	=item $maps = cf::map::tmp_maps
1321	my ($map, $ob) = @_;
1322		1810
1323	if ($map->per_player) {	1811	Returns an arrayref with all map paths of currently instantiated and saved
1324	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	1812	maps. May block.
		1813
		1814	=cut
		1815
		1816	sub tmp_maps() {
1325	}	1817	[
1326		1818	map {
1327	$map	1819	utf8::decode $_;
		1820	/\.map$/
		1821	? normalise $_
		1822	: ()
		1823	} @{ aio_readdir $TMPDIR or [] }
		1824	]
1328	}	1825	}
1329		1826
1330	sub emergency_save {	1827	=item $maps = cf::map::random_maps
1331	local $cf::FREEZE = 1;
1332		1828
1333	warn "enter emergency map save\n";	1829	Returns an arrayref with all map paths of currently instantiated and saved
		1830	random maps. May block.
1334		1831
1335	cf::sync_job {	1832	=cut
1336	warn "begin emergency map save\n";
1337	$_->save for values %cf::MAP;
1338	};
1339		1833
1340	warn "end emergency map save\n";	1834	sub random_maps() {
		1835	[
		1836	map {
		1837	utf8::decode $_;
		1838	/\.map$/
		1839	? normalise "?random/$_"
		1840	: ()
		1841	} @{ aio_readdir $RANDOMDIR or [] }
		1842	]
		1843	}
		1844
		1845	=item cf::map::unique_maps
		1846
		1847	Returns an arrayref of paths of all shared maps that have
		1848	instantiated unique items. May block.
		1849
		1850	=cut
		1851
		1852	sub unique_maps() {
		1853	[
		1854	map {
		1855	utf8::decode $_;
		1856	/\.map$/
		1857	? normalise $_
		1858	: ()
		1859	} @{ aio_readdir $UNIQUEDIR or [] }
		1860	]
1341	}	1861	}
1342		1862
1343	package cf;	1863	package cf;
1344		1864
1345	=back	1865	=back
1346		1866
		1867	=head3 cf::object
		1868
		1869	=cut
		1870
		1871	package cf::object;
		1872
		1873	=over 4
		1874
		1875	=item $ob->inv_recursive
		1876
		1877	Returns the inventory of the object _and_ their inventories, recursively.
		1878
		1879	=cut
		1880
		1881	sub inv_recursive_;
		1882	sub inv_recursive_ {
		1883	map { $_, inv_recursive_ $_->inv } @_
		1884	}
		1885
		1886	sub inv_recursive {
		1887	inv_recursive_ inv $_[0]
		1888	}
		1889
		1890	package cf;
		1891
		1892	=back
1347		1893
1348	=head3 cf::object::player	1894	=head3 cf::object::player
1349		1895
1350	=over 4	1896	=over 4
1351		1897
…		…
1391		1937
1392	=item $player_object->enter_link	1938	=item $player_object->enter_link
1393		1939
1394	Freezes the player and moves him/her to a special map (C<{link}>).	1940	Freezes the player and moves him/her to a special map (C<{link}>).
1395		1941
1396	The player should be reaosnably safe there for short amounts of time. You	1942	The player should be reasonably safe there for short amounts of time. You
1397	I<MUST> call C<leave_link> as soon as possible, though.	1943	I<MUST> call C<leave_link> as soon as possible, though.
1398		1944
		1945	Will never block.
		1946
1399	=item $player_object->leave_link ($map, $x, $y)	1947	=item $player_object->leave_link ($map, $x, $y)
1400		1948
1401	Moves the player out of the specila link map onto the given map. If the	1949	Moves the player out of the special C<{link}> map onto the specified
1402	map is not valid (or omitted), the player will be moved back to the	1950	map. If the map is not valid (or omitted), the player will be moved back
1403	location he/she was before the call to C<enter_link>, or, if that fails,	1951	to the location he/she was before the call to C<enter_link>, or, if that
1404	to the emergency map position.	1952	fails, to the emergency map position.
1405		1953
1406	Might block.	1954	Might block.
1407		1955
1408	=cut	1956	=cut
		1957
		1958	sub link_map {
		1959	unless ($LINK_MAP) {
		1960	$LINK_MAP = cf::map::find "{link}"
		1961	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1962	$LINK_MAP->load;
		1963	}
		1964
		1965	$LINK_MAP
		1966	}
1409		1967
1410	sub cf::object::player::enter_link {	1968	sub cf::object::player::enter_link {
1411	my ($self) = @_;	1969	my ($self) = @_;
1412		1970
1413	return if $self->map == $LINK_MAP;
1414
1415	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1416	if $self->map;
1417
1418	$self->enter_map ($LINK_MAP, 20, 20);
1419	$self->deactivate_recursive;	1971	$self->deactivate_recursive;
		1972
		1973	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1974
		1975	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1976	if $self->map && $self->map->{path} ne "{link}";
		1977
		1978	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1420	}	1979	}
1421		1980
1422	sub cf::object::player::leave_link {	1981	sub cf::object::player::leave_link {
1423	my ($self, $map, $x, $y) = @_;	1982	my ($self, $map, $x, $y) = @_;
		1983
		1984	return unless $self->contr->active;
1424		1985
1425	my $link_pos = delete $self->{_link_pos};	1986	my $link_pos = delete $self->{_link_pos};
1426		1987
1427	unless ($map) {	1988	unless ($map) {
1428	# restore original map position	1989	# restore original map position
1429	($map, $x, $y) = @{ $link_pos || [] };	1990	($map, $x, $y) = @{ $link_pos || [] };
1430	$map = cf::map::find_map $map;	1991	$map = cf::map::find $map;
1431		1992
1432	unless ($map) {	1993	unless ($map) {
1433	($map, $x, $y) = @$EMERGENCY_POSITION;	1994	($map, $x, $y) = @$EMERGENCY_POSITION;
1434	$map = cf::map::find_map $map	1995	$map = cf::map::find $map
1435	or die "FATAL: cannot load emergency map\n";	1996	or die "FATAL: cannot load emergency map\n";
1436	}	1997	}
1437	}	1998	}
1438		1999
1439	($x, $y) = (-1, -1)	2000	($x, $y) = (-1, -1)
…		…
1442	# use -1 or undef as default coordinates, not 0, 0	2003	# use -1 or undef as default coordinates, not 0, 0
1443	($x, $y) = ($map->enter_x, $map->enter_y)	2004	($x, $y) = ($map->enter_x, $map->enter_y)
1444	if $x <=0 && $y <= 0;	2005	if $x <=0 && $y <= 0;
1445		2006
1446	$map->load;	2007	$map->load;
		2008	$map->load_diag;
1447		2009
		2010	return unless $self->contr->active;
1448	$self->activate_recursive;	2011	$self->activate_recursive;
		2012
		2013	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1449	$self->enter_map ($map, $x, $y);	2014	$self->enter_map ($map, $x, $y);
1450	}	2015	}
1451		2016
1452	=item $player_object->goto_map ($path, $x, $y)	2017	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1453		2018
1454	=cut	2019	Moves the player to the given map-path and coordinates by first freezing
		2020	her, loading and preparing them map, calling the provided $check callback
		2021	that has to return the map if sucecssful, and then unfreezes the player on
		2022	the new (success) or old (failed) map position.
1455		2023
		2024	=cut
		2025
		2026	our $GOTOGEN;
		2027
1456	sub cf::object::player::goto_map {	2028	sub cf::object::player::goto {
1457	my ($self, $path, $x, $y) = @_;	2029	my ($self, $path, $x, $y, $check) = @_;
		2030
		2031	# do generation counting so two concurrent goto's will be executed in-order
		2032	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1458		2033
1459	$self->enter_link;	2034	$self->enter_link;
1460		2035
1461	(Coro::async {	2036	(async {
1462	$path = new cf::path $path;	2037	my $map = eval {
1463
1464	my $map = cf::map::find_map $path->as_string;	2038	my $map = cf::map::find $path;
1465	$map = $map->customise_for ($self) if $map;
1466		2039
1467	warn "entering ", $map->path, " at ($x, $y)\n"
1468	if $map;	2040	if ($map) {
1469		2041	$map = $map->customise_for ($self);
		2042	$map = $check->($map) if $check && $map;
		2043	} else {
1470	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2044	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2045	}
1471		2046
		2047	$map
		2048	};
		2049
		2050	if ($@) {
		2051	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2052	LOG llevError | logBacktrace, Carp::longmess $@;
		2053	}
		2054
		2055	if ($gen == $self->{_goto_generation}) {
		2056	delete $self->{_goto_generation};
1472	$self->leave_link ($map, $x, $y);	2057	$self->leave_link ($map, $x, $y);
		2058	}
1473	})->prio (1);	2059	})->prio (1);
1474	}	2060	}
1475		2061
1476	=item $player_object->enter_exit ($exit_object)	2062	=item $player_object->enter_exit ($exit_object)
1477		2063
…		…
1479		2065
1480	sub parse_random_map_params {	2066	sub parse_random_map_params {
1481	my ($spec) = @_;	2067	my ($spec) = @_;
1482		2068
1483	my $rmp = { # defaults	2069	my $rmp = { # defaults
1484	xsize => 10,	2070	xsize => (cf::rndm 15, 40),
1485	ysize => 10,	2071	ysize => (cf::rndm 15, 40),
		2072	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2073	#layout => string,
1486	};	2074	};
1487		2075
1488	for (split /\n/, $spec) {	2076	for (split /\n/, $spec) {
1489	my ($k, $v) = split /\s+/, $_, 2;	2077	my ($k, $v) = split /\s+/, $_, 2;
1490		2078
…		…
1494	$rmp	2082	$rmp
1495	}	2083	}
1496		2084
1497	sub prepare_random_map {	2085	sub prepare_random_map {
1498	my ($exit) = @_;	2086	my ($exit) = @_;
		2087
		2088	my $guard = cf::lock_acquire "exit_prepare:$exit";
1499		2089
1500	# all this does is basically replace the /! path by	2090	# all this does is basically replace the /! path by
1501	# a new random map path (?random/...) with a seed	2091	# a new random map path (?random/...) with a seed
1502	# that depends on the exit object	2092	# that depends on the exit object
1503		2093
1504	my $rmp = parse_random_map_params $exit->msg;	2094	my $rmp = parse_random_map_params $exit->msg;
1505		2095
1506	if ($exit->map) {	2096	if ($exit->map) {
1507	$rmp->{region} = $exit->map->region_name;	2097	$rmp->{region} = $exit->region->name;
1508	$rmp->{origin_map} = $exit->map->path;	2098	$rmp->{origin_map} = $exit->map->path;
1509	$rmp->{origin_x} = $exit->x;	2099	$rmp->{origin_x} = $exit->x;
1510	$rmp->{origin_y} = $exit->y;	2100	$rmp->{origin_y} = $exit->y;
1511	}	2101	}
1512		2102
1513	$rmp->{random_seed} ||= $exit->random_seed;	2103	$rmp->{random_seed} ||= $exit->random_seed;
1514		2104
1515	my $data = cf::to_json $rmp;	2105	my $data = cf::to_json $rmp;
1516	my $md5 = Digest::MD5::md5_hex $data;	2106	my $md5 = Digest::MD5::md5_hex $data;
		2107	my $meta = "$RANDOMDIR/$md5.meta";
1517		2108
1518	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2109	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1519	aio_write $fh, 0, (length $data), $data, 0;	2110	aio_write $fh, 0, (length $data), $data, 0;
		2111	undef $fh;
		2112	aio_rename "$meta~", $meta;
1520		2113
1521	$exit->slaying ("?random/$md5");	2114	$exit->slaying ("?random/$md5");
1522	$exit->msg (undef);	2115	$exit->msg (undef);
1523	}	2116	}
1524	}	2117	}
…		…
1526	sub cf::object::player::enter_exit {	2119	sub cf::object::player::enter_exit {
1527	my ($self, $exit) = @_;	2120	my ($self, $exit) = @_;
1528		2121
1529	return unless $self->type == cf::PLAYER;	2122	return unless $self->type == cf::PLAYER;
1530		2123
		2124	if ($exit->slaying eq "/!") {
		2125	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2126	# the problem is that $exit might not survive long enough
		2127	# so it needs to be done right now, right here
		2128	cf::sync_job { prepare_random_map $exit };
		2129	}
		2130
		2131	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2132	my $hp = $exit->stats->hp;
		2133	my $sp = $exit->stats->sp;
		2134
1531	$self->enter_link;	2135	$self->enter_link;
1532		2136
1533	(Coro::async {	2137	(async {
		2138	$self->deactivate_recursive; # just to be sure
1534	unless (eval {	2139	unless (eval {
1535		2140	$self->goto ($slaying, $hp, $sp);
1536	prepare_random_map $exit
1537	if $exit->slaying eq "/!";
1538
1539	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1540	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1541		2141
1542	1;	2142	1;
1543	}) {	2143	}) {
1544	$self->message ("Something went wrong deep within the crossfire server. "	2144	$self->message ("Something went wrong deep within the crossfire server. "
1545	. "I'll try to bring you back to the map you were before. "	2145	. "I'll try to bring you back to the map you were before. "
1546	. "Please report this to the dungeon master",	2146	. "Please report this to the dungeon master!",
1547	cf::NDI_UNIQUE | cf::NDI_RED);	2147	cf::NDI_UNIQUE | cf::NDI_RED);
1548		2148
1549	warn "ERROR in enter_exit: $@";	2149	warn "ERROR in enter_exit: $@";
1550	$self->leave_link;	2150	$self->leave_link;
1551	}	2151	}
1552	})->prio (1);	2152	})->prio (1);
…		…
1565		2165
1566	sub cf::client::send_drawinfo {	2166	sub cf::client::send_drawinfo {
1567	my ($self, $text, $flags) = @_;	2167	my ($self, $text, $flags) = @_;
1568		2168
1569	utf8::encode $text;	2169	utf8::encode $text;
1570	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2170	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1571	}	2171	}
1572		2172
		2173	=item $client->ext_event ($type, %msg)
		2174
		2175	Sends an exti event to the client.
		2176
		2177	=cut
		2178
		2179	sub cf::client::ext_event($$%) {
		2180	my ($self, $type, %msg) = @_;
		2181
		2182	$msg{msgtype} = "event_$type";
		2183	$self->send_packet ("ext " . cf::to_json \%msg);
		2184	}
1573		2185
1574	=item $success = $client->query ($flags, "text", \&cb)	2186	=item $success = $client->query ($flags, "text", \&cb)
1575		2187
1576	Queues a query to the client, calling the given callback with	2188	Queues a query to the client, calling the given callback with
1577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2189	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1602	on_reply => sub {	2214	on_reply => sub {
1603	my ($ns, $msg) = @_;	2215	my ($ns, $msg) = @_;
1604		2216
1605	# this weird shuffling is so that direct followup queries	2217	# this weird shuffling is so that direct followup queries
1606	# get handled first	2218	# get handled first
1607	my $queue = delete $ns->{query_queue};	2219	my $queue = delete $ns->{query_queue}
		2220	or return; # be conservative, not sure how that can happen, but we saw a crash here
1608		2221
1609	(shift @$queue)->[1]->($msg);	2222	(shift @$queue)->[1]->($msg);
		2223	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1610		2224
1611	push @{ $ns->{query_queue} }, @$queue;	2225	push @{ $ns->{query_queue} }, @$queue;
1612		2226
1613	if (@{ $ns->{query_queue} } == @$queue) {	2227	if (@{ $ns->{query_queue} } == @$queue) {
1614	if (@$queue) {	2228	if (@$queue) {
…		…
1618	}	2232	}
1619	}	2233	}
1620	},	2234	},
1621	);	2235	);
1622		2236
1623	=item $client->coro (\&cb)	2237	=item $client->async (\&cb)
1624		2238
1625	Create a new coroutine, running the specified callback. The coroutine will	2239	Create a new coroutine, running the specified callback. The coroutine will
1626	be automatically cancelled when the client gets destroyed (e.g. on logout,	2240	be automatically cancelled when the client gets destroyed (e.g. on logout,
1627	or loss of connection).	2241	or loss of connection).
1628		2242
1629	=cut	2243	=cut
1630		2244
1631	sub cf::client::coro {	2245	sub cf::client::async {
1632	my ($self, $cb) = @_;	2246	my ($self, $cb) = @_;
1633		2247
1634	my $coro; $coro = async {	2248	my $coro = &Coro::async ($cb);
1635	eval {
1636	$cb->();
1637	};
1638	warn $@ if $@;
1639	};
1640		2249
1641	$coro->on_destroy (sub {	2250	$coro->on_destroy (sub {
1642	delete $self->{_coro}{$coro+0};	2251	delete $self->{_coro}{$coro+0};
1643	});	2252	});
1644		2253
…		…
1677		2286
1678	# here we export the classes and methods available to script code	2287	# here we export the classes and methods available to script code
1679		2288
1680	=pod	2289	=pod
1681		2290
1682	The following fucntions and emthods are available within a safe environment:	2291	The following functions and methods are available within a safe environment:
1683		2292
1684	cf::object contr pay_amount pay_player map	2293	cf::object contr pay_amount pay_player map
1685	cf::object::player player	2294	cf::object::player player
1686	cf::player peaceful	2295	cf::player peaceful
1687	cf::map trigger	2296	cf::map trigger
…		…
1772	#############################################################################	2381	#############################################################################
1773		2382
1774	=head2 EXTENSION DATABASE SUPPORT	2383	=head2 EXTENSION DATABASE SUPPORT
1775		2384
1776	Crossfire maintains a very simple database for extension use. It can	2385	Crossfire maintains a very simple database for extension use. It can
1777	currently store anything that can be serialised using Storable, which	2386	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1778	excludes objects.	2387	convert to/from binary).
1779		2388
1780	The parameter C<$family> should best start with the name of the extension	2389	The parameter C<$family> should best start with the name of the extension
1781	using it, it should be unique.	2390	using it, it should be unique.
1782		2391
1783	=over 4	2392	=over 4
1784		2393
1785	=item $hashref = cf::db_get $family
1786
1787	Return a hashref for use by the extension C<$family>, which can be
1788	modified. After modifications, you have to call C<cf::db_dirty> or
1789	C<cf::db_sync>.
1790
1791	=item $value = cf::db_get $family => $key	2394	=item $value = cf::db_get $family => $key
1792		2395
1793	Returns a single value from the database	2396	Returns a single value from the database.
1794
1795	=item cf::db_put $family => $hashref
1796
1797	Stores the given family hashref into the database. Updates are delayed, if
1798	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1799		2397
1800	=item cf::db_put $family => $key => $value	2398	=item cf::db_put $family => $key => $value
1801		2399
1802	Stores the given C<$value> in the family hash. Updates are delayed, if you	2400	Stores the given C<$value> in the family.
1803	want the data to be synced to disk immediately, use C<cf::db_sync>.
1804
1805	=item cf::db_dirty
1806
1807	Marks the database as dirty, to be updated at a later time.
1808
1809	=item cf::db_sync
1810
1811	Immediately write the database to disk I<if it is dirty>.
1812		2401
1813	=cut	2402	=cut
1814		2403
1815	our $DB;	2404	our $DB;
1816		2405
1817	{	2406	sub db_init {
1818	my $path = cf::localdir . "/database.pst";	2407	unless ($DB) {
		2408	$DB = BDB::db_create $DB_ENV;
1819		2409
1820	sub db_load() {	2410	cf::sync_job {
1821	warn "loading database $path\n";#d# remove later	2411	eval {
1822	$DB = stat $path ? Storable::retrieve $path : { };	2412	$DB->set_flags (BDB::CHKSUM);
1823	}
1824		2413
1825	my $pid;	2414	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1826		2415	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1827	sub db_save() {	2416	cf::cleanup "db_open(db): $!" if $!;
1828	warn "saving database $path\n";#d# remove later	2417	};
1829	waitpid $pid, 0 if $pid;	2418	cf::cleanup "db_open(db): $@" if $@;
1830	if (0 == ($pid = fork)) {
1831	$DB->{_meta}{version} = 1;
1832	Storable::nstore $DB, "$path~";
1833	rename "$path~", $path;
1834	cf::_exit 0 if defined $pid;
1835	}	2419	};
1836	}
1837
1838	my $dirty;
1839
1840	sub db_sync() {
1841	db_save if $dirty;
1842	undef $dirty;
1843	}
1844
1845	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1846	db_sync;
1847	});	2420	}
		2421	}
1848		2422
1849	sub db_dirty() {
1850	$dirty = 1;
1851	$idle->start;
1852	}
1853
1854	sub db_get($;$) {	2423	sub db_get($$) {
1855	@_ >= 2	2424	my $key = "$_[0]/$_[1]";
1856	? $DB->{$_[0]}{$_[1]}
1857	: ($DB->{$_[0]} ||= { })
1858	}
1859		2425
		2426	cf::sync_job {
		2427	BDB::db_get $DB, undef, $key, my $data;
		2428
		2429	$! ? ()
		2430	: $data
		2431	}
		2432	}
		2433
1860	sub db_put($$;$) {	2434	sub db_put($$$) {
1861	if (@_ >= 3) {	2435	BDB::dbreq_pri 4;
1862	$DB->{$_[0]}{$_[1]} = $_[2];	2436	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1863	} else {	2437	}
1864	$DB->{$_[0]} = $_[1];
1865	}
1866	db_dirty;
1867	}
1868		2438
1869	cf::global->attach (	2439	=item cf::cache $id => [$paths...], $processversion => $process
1870	prio => 10000,	2440
1871	on_cleanup => sub {	2441	Generic caching function that returns the value of the resource $id,
1872	db_sync;	2442	caching and regenerating as required.
		2443
		2444	This function can block.
		2445
		2446	=cut
		2447
		2448	sub cache {
		2449	my ($id, $src, $processversion, $process) = @_;
		2450
		2451	my $meta =
		2452	join "\x00",
		2453	$processversion,
		2454	map {
		2455	aio_stat $_
		2456	and Carp::croak "$_: $!";
		2457
		2458	($_, (stat _)[7,9])
		2459	} @$src;
		2460
		2461	my $dbmeta = db_get cache => "$id/meta";
		2462	if ($dbmeta ne $meta) {
		2463	# changed, we may need to process
		2464
		2465	my @data;
		2466	my $md5;
		2467
		2468	for (0 .. $#$src) {
		2469	0 <= aio_load $src->[$_], $data[$_]
		2470	or Carp::croak "$src->[$_]: $!";
1873	},	2471	}
1874	);	2472
		2473	# if processing is expensive, check
		2474	# checksum first
		2475	if (1) {
		2476	$md5 =
		2477	join "\x00",
		2478	$processversion,
		2479	map {
		2480	Coro::cede;
		2481	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2482	} 0.. $#$src;
		2483
		2484
		2485	my $dbmd5 = db_get cache => "$id/md5";
		2486	if ($dbmd5 eq $md5) {
		2487	db_put cache => "$id/meta", $meta;
		2488
		2489	return db_get cache => "$id/data";
		2490	}
		2491	}
		2492
		2493	my $t1 = Time::HiRes::time;
		2494	my $data = $process->(\@data);
		2495	my $t2 = Time::HiRes::time;
		2496
		2497	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2498
		2499	db_put cache => "$id/data", $data;
		2500	db_put cache => "$id/md5" , $md5;
		2501	db_put cache => "$id/meta", $meta;
		2502
		2503	return $data;
		2504	}
		2505
		2506	db_get cache => "$id/data"
		2507	}
		2508
		2509	=item fork_call { }, $args
		2510
		2511	Executes the given code block with the given arguments in a seperate
		2512	process, returning the results. Everything must be serialisable with
		2513	Coro::Storable. May, of course, block. Note that the executed sub may
		2514	never block itself or use any form of Event handling.
		2515
		2516	=cut
		2517
		2518	sub fork_call(&@) {
		2519	my ($cb, @args) = @_;
		2520
		2521	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2522	# or die "socketpair: $!";
		2523	pipe my $fh1, my $fh2
		2524	or die "pipe: $!";
		2525
		2526	if (my $pid = fork) {
		2527	close $fh2;
		2528
		2529	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2530	$res = Coro::Storable::thaw $res;
		2531
		2532	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2533
		2534	die $$res unless "ARRAY" eq ref $res;
		2535
		2536	return wantarray ? @$res : $res->[-1];
		2537	} else {
		2538	reset_signals;
		2539	local $SIG{__WARN__};
		2540	local $SIG{__DIE__};
		2541	eval {
		2542	close $fh1;
		2543
		2544	my @res = eval { $cb->(@args) };
		2545	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2546	};
		2547
		2548	warn $@ if $@;
		2549	_exit 0;
		2550	}
1875	}	2551	}
1876		2552
1877	#############################################################################	2553	#############################################################################
1878	# the server's main()	2554	# the server's init and main functions
		2555
		2556	sub load_facedata($) {
		2557	my ($path) = @_;
		2558
		2559	warn "loading facedata from $path\n";
		2560
		2561	my $facedata;
		2562	0 < aio_load $path, $facedata
		2563	or die "$path: $!";
		2564
		2565	$facedata = Coro::Storable::thaw $facedata;
		2566
		2567	$facedata->{version} == 2
		2568	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2569
		2570	{
		2571	my $faces = $facedata->{faceinfo};
		2572
		2573	while (my ($face, $info) = each %$faces) {
		2574	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2575	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2576	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2577	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2578	Coro::cede;
		2579	}
		2580
		2581	while (my ($face, $info) = each %$faces) {
		2582	next unless $info->{smooth};
		2583	my $idx = cf::face::find $face
		2584	or next;
		2585	if (my $smooth = cf::face::find $info->{smooth}) {
		2586	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2587	} else {
		2588	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2589	}
		2590	Coro::cede;
		2591	}
		2592	}
		2593
		2594	{
		2595	my $anims = $facedata->{animinfo};
		2596
		2597	while (my ($anim, $info) = each %$anims) {
		2598	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2599	Coro::cede;
		2600	}
		2601
		2602	cf::anim::invalidate_all; # d'oh
		2603	}
		2604
		2605	1
		2606	}
		2607
		2608	sub reload_regions {
		2609	load_resource_file "$MAPDIR/regions"
		2610	or die "unable to load regions file\n";
		2611	}
		2612
		2613	sub reload_facedata {
		2614	load_facedata "$DATADIR/facedata"
		2615	or die "unable to load facedata\n";
		2616	}
		2617
		2618	sub reload_archetypes {
		2619	load_resource_file "$DATADIR/archetypes"
		2620	or die "unable to load archetypes\n";
		2621	}
		2622
		2623	sub reload_treasures {
		2624	load_resource_file "$DATADIR/treasures"
		2625	or die "unable to load treasurelists\n";
		2626	}
		2627
		2628	sub reload_resources {
		2629	warn "reloading resource files...\n";
		2630
		2631	reload_regions;
		2632	reload_facedata;
		2633	#reload_archetypes;#d#
		2634	reload_archetypes;
		2635	reload_treasures;
		2636
		2637	warn "finished reloading resource files\n";
		2638	}
		2639
		2640	sub init {
		2641	reload_resources;
		2642	}
1879		2643
1880	sub cfg_load {	2644	sub cfg_load {
1881	open my $fh, "<:utf8", cf::confdir . "/config"	2645	open my $fh, "<:utf8", "$CONFDIR/config"
1882	or return;	2646	or return;
1883		2647
1884	local $/;	2648	local $/;
1885	*CFG = YAML::Syck::Load <$fh>;	2649	*CFG = YAML::Syck::Load <$fh>;
		2650
		2651	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2652
		2653	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2654	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2655
		2656	if (exists $CFG{mlockall}) {
		2657	eval {
		2658	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2659	and die "WARNING: m(un)lockall failed: $!\n";
		2660	};
		2661	warn $@ if $@;
		2662	}
1886	}	2663	}
1887		2664
1888	sub main {	2665	sub main {
1889	# we must not ever block the main coroutine	2666	# we must not ever block the main coroutine
1890	local $Coro::idle = sub {	2667	local $Coro::idle = sub {
1891	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2668	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1892	(Coro::unblock_sub {	2669	(async {
1893	Event::one_event;	2670	Event::one_event;
1894	})->();	2671	})->prio (Coro::PRIO_MAX);
1895	};	2672	};
1896		2673
1897	cfg_load;	2674	cfg_load;
1898	db_load;	2675	db_init;
1899	load_extensions;	2676	load_extensions;
		2677
		2678	$TICK_WATCHER->start;
1900	Event::loop;	2679	Event::loop;
1901	}	2680	}
1902		2681
1903	#############################################################################	2682	#############################################################################
1904	# initialisation	2683	# initialisation and cleanup
1905		2684
		2685	# install some emergency cleanup handlers
		2686	BEGIN {
		2687	for my $signal (qw(INT HUP TERM)) {
		2688	Event->signal (
		2689	reentrant => 0,
		2690	data => WF_AUTOCANCEL,
		2691	signal => $signal,
		2692	prio => 0,
		2693	cb => sub {
		2694	cf::cleanup "SIG$signal";
		2695	},
		2696	);
		2697	}
		2698	}
		2699
		2700	sub emergency_save() {
		2701	my $freeze_guard = cf::freeze_mainloop;
		2702
		2703	warn "enter emergency perl save\n";
		2704
		2705	cf::sync_job {
		2706	# use a peculiar iteration method to avoid tripping on perl
		2707	# refcount bugs in for. also avoids problems with players
		2708	# and maps saved/destroyed asynchronously.
		2709	warn "begin emergency player save\n";
		2710	for my $login (keys %cf::PLAYER) {
		2711	my $pl = $cf::PLAYER{$login} or next;
		2712	$pl->valid or next;
		2713	$pl->save;
		2714	}
		2715	warn "end emergency player save\n";
		2716
		2717	warn "begin emergency map save\n";
		2718	for my $path (keys %cf::MAP) {
		2719	my $map = $cf::MAP{$path} or next;
		2720	$map->valid or next;
		2721	$map->save;
		2722	}
		2723	warn "end emergency map save\n";
		2724
		2725	warn "begin emergency database checkpoint\n";
		2726	BDB::db_env_txn_checkpoint $DB_ENV;
		2727	warn "end emergency database checkpoint\n";
		2728	};
		2729
		2730	warn "leave emergency perl save\n";
		2731	}
		2732
		2733	sub post_cleanup {
		2734	my ($make_core) = @_;
		2735
		2736	warn Carp::longmess "post_cleanup backtrace"
		2737	if $make_core;
		2738	}
		2739
1906	sub reload() {	2740	sub do_reload_perl() {
1907	# can/must only be called in main	2741	# can/must only be called in main
1908	if ($Coro::current != $Coro::main) {	2742	if ($Coro::current != $Coro::main) {
1909	warn "can only reload from main coroutine\n";	2743	warn "can only reload from main coroutine";
1910	return;	2744	return;
1911	}	2745	}
1912		2746
1913	warn "reloading...";	2747	warn "reloading...";
1914		2748
1915	local $FREEZE = 1;	2749	warn "entering sync_job";
		2750
		2751	cf::sync_job {
		2752	cf::write_runtime; # external watchdog should not bark
1916	cf::emergency_save;	2753	cf::emergency_save;
		2754	cf::write_runtime; # external watchdog should not bark
1917		2755
1918	eval {	2756	warn "syncing database to disk";
		2757	BDB::db_env_txn_checkpoint $DB_ENV;
		2758
1919	# if anything goes wrong in here, we should simply crash as we already saved	2759	# if anything goes wrong in here, we should simply crash as we already saved
1920		2760
1921	# cancel all watchers	2761	warn "cancelling all WF_AUTOCANCEL watchers";
1922	for (Event::all_watchers) {	2762	for (Event::all_watchers) {
1923	$_->cancel if $_->data & WF_AUTOCANCEL;	2763	$_->cancel if $_->data & WF_AUTOCANCEL;
1924	}	2764	}
1925		2765
		2766	warn "flushing outstanding aio requests";
		2767	for (;;) {
		2768	BDB::flush;
		2769	IO::AIO::flush;
		2770	Coro::cede;
		2771	last unless IO::AIO::nreqs || BDB::nreqs;
		2772	warn "iterate...";
		2773	}
		2774
		2775	++$RELOAD;
		2776
1926	# cancel all extension coros	2777	warn "cancelling all extension coros";
1927	$_->cancel for values %EXT_CORO;	2778	$_->cancel for values %EXT_CORO;
1928	%EXT_CORO = ();	2779	%EXT_CORO = ();
1929		2780
1930	# unload all extensions	2781	warn "removing commands";
1931	for (@exts) {	2782	%COMMAND = ();
		2783
		2784	warn "removing ext commands";
		2785	%EXTCMD = ();
		2786
		2787	warn "unloading/nuking all extensions";
		2788	for my $pkg (@EXTS) {
1932	warn "unloading <$_>";	2789	warn "... unloading $pkg";
1933	unload_extension $_;	2790
		2791	if (my $cb = $pkg->can ("unload")) {
		2792	eval {
		2793	$cb->($pkg);
		2794	1
		2795	} or warn "$pkg unloaded, but with errors: $@";
1934	}	2796	}
1935		2797
		2798	warn "... nuking $pkg";
		2799	Symbol::delete_package $pkg;
		2800	}
		2801
1936	# unload all modules loaded from $LIBDIR	2802	warn "unloading all perl modules loaded from $LIBDIR";
1937	while (my ($k, $v) = each %INC) {	2803	while (my ($k, $v) = each %INC) {
1938	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2804	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1939		2805
1940	warn "removing <$k>";	2806	warn "... unloading $k";
1941	delete $INC{$k};	2807	delete $INC{$k};
1942		2808
1943	$k =~ s/\.pm$//;	2809	$k =~ s/\.pm$//;
1944	$k =~ s/\//::/g;	2810	$k =~ s/\//::/g;
1945		2811
…		…
1948	}	2814	}
1949		2815
1950	Symbol::delete_package $k;	2816	Symbol::delete_package $k;
1951	}	2817	}
1952		2818
1953	# sync database to disk
1954	cf::db_sync;
1955	IO::AIO::flush;
1956
1957	# get rid of safe::, as good as possible	2819	warn "getting rid of safe::, as good as possible";
1958	Symbol::delete_package "safe::$_"	2820	Symbol::delete_package "safe::$_"
1959	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2821	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1960		2822
1961	# remove register_script_function callbacks
1962	# TODO
1963
1964	# unload cf.pm "a bit"	2823	warn "unloading cf.pm \"a bit\"";
1965	delete $INC{"cf.pm"};	2824	delete $INC{"cf.pm"};
		2825	delete $INC{"cf/pod.pm"};
1966		2826
1967	# don't, removes xs symbols, too,	2827	# don't, removes xs symbols, too,
1968	# and global variables created in xs	2828	# and global variables created in xs
1969	#Symbol::delete_package __PACKAGE__;	2829	#Symbol::delete_package __PACKAGE__;
1970		2830
1971	# reload cf.pm	2831	warn "unload completed, starting to reload now";
		2832
1972	warn "reloading cf.pm";	2833	warn "reloading cf.pm";
1973	require cf;	2834	require cf;
1974	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1975		2836
1976	# load config and database again	2837	warn "loading config and database again";
1977	cf::cfg_load;	2838	cf::cfg_load;
1978	cf::db_load;
1979		2839
1980	# load extensions
1981	warn "load extensions";	2840	warn "loading extensions";
1982	cf::load_extensions;	2841	cf::load_extensions;
1983		2842
1984	# reattach attachments to objects	2843	warn "reattaching attachments to objects/players";
1985	warn "reattach";	2844	_global_reattach; # objects, sockets
1986	_global_reattach;	2845	warn "reattaching attachments to maps";
1987	};	2846	reattach $_ for values %MAP;
		2847	warn "reattaching attachments to players";
		2848	reattach $_ for values %PLAYER;
1988		2849
1989	if ($@) {	2850	warn "leaving sync_job";
		2851
		2852	1
		2853	} or do {
1990	warn $@;	2854	warn $@;
1991	warn "error while reloading, exiting.";	2855	warn "error while reloading, exiting.";
1992	exit 1;	2856	exit 1;
1993	}	2857	};
1994		2858
1995	warn "reloaded successfully";	2859	warn "reloaded";
1996	};	2860	};
1997		2861
1998	#############################################################################	2862	our $RELOAD_WATCHER; # used only during reload
1999		2863
2000	unless ($LINK_MAP) {	2864	sub reload_perl() {
2001	$LINK_MAP = cf::map::new;	2865	# doing reload synchronously and two reloads happen back-to-back,
		2866	# coro crashes during coro_state_free->destroy here.
2002		2867
2003	$LINK_MAP->width (41);	2868	$RELOAD_WATCHER ||= Event->timer (
2004	$LINK_MAP->height (41);	2869	reentrant => 0,
2005	$LINK_MAP->alloc;
2006	$LINK_MAP->path ("{link}");
2007	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2008	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2009
2010	# dirty hack because... archetypes are not yet loaded
2011	Event->timer (
2012	after => 2,	2870	after => 0,
		2871	data => WF_AUTOCANCEL,
2013	cb => sub {	2872	cb => sub {
2014	$_[0]->w->cancel;	2873	do_reload_perl;
2015		2874	undef $RELOAD_WATCHER;
2016	# provide some exits "home"
2017	my $exit = cf::object::new "exit";
2018
2019	$exit->slaying ($EMERGENCY_POSITION->[0]);
2020	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2021	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2022
2023	$LINK_MAP->insert ($exit->clone, 19, 19);
2024	$LINK_MAP->insert ($exit->clone, 19, 20);
2025	$LINK_MAP->insert ($exit->clone, 19, 21);
2026	$LINK_MAP->insert ($exit->clone, 20, 19);
2027	$LINK_MAP->insert ($exit->clone, 20, 21);
2028	$LINK_MAP->insert ($exit->clone, 21, 19);
2029	$LINK_MAP->insert ($exit->clone, 21, 20);
2030	$LINK_MAP->insert ($exit->clone, 21, 21);
2031
2032	$exit->destroy;
2033	});	2875	},
2034		2876	);
2035	$LINK_MAP->{deny_save} = 1;
2036	$LINK_MAP->{deny_reset} = 1;
2037
2038	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2039	}	2877	}
2040
2041	register "<global>", __PACKAGE__;
2042		2878
2043	register_command "reload" => sub {	2879	register_command "reload" => sub {
2044	my ($who, $arg) = @_;	2880	my ($who, $arg) = @_;
2045		2881
2046	if ($who->flag (FLAG_WIZ)) {	2882	if ($who->flag (FLAG_WIZ)) {
2047	$who->message ("start of reload.");
2048	reload;
2049	$who->message ("end of reload.");	2883	$who->message ("reloading server.");
		2884	async { reload_perl };
2050	}	2885	}
2051	};	2886	};
2052		2887
2053	unshift @INC, $LIBDIR;	2888	unshift @INC, $LIBDIR;
2054		2889
		2890	my $bug_warning = 0;
		2891
		2892	our @WAIT_FOR_TICK;
		2893	our @WAIT_FOR_TICK_BEGIN;
		2894
		2895	sub wait_for_tick {
		2896	return unless $TICK_WATCHER->is_active;
		2897	return if $Coro::current == $Coro::main;
		2898
		2899	my $signal = new Coro::Signal;
		2900	push @WAIT_FOR_TICK, $signal;
		2901	$signal->wait;
		2902	}
		2903
		2904	sub wait_for_tick_begin {
		2905	return unless $TICK_WATCHER->is_active;
		2906	return if $Coro::current == $Coro::main;
		2907
		2908	my $signal = new Coro::Signal;
		2909	push @WAIT_FOR_TICK_BEGIN, $signal;
		2910	$signal->wait;
		2911	}
		2912
		2913	my $min = 1e6;#d#
		2914	my $avg = 10;
2055	$TICK_WATCHER = Event->timer (	2915	$TICK_WATCHER = Event->timer (
2056	reentrant => 0,	2916	reentrant => 0,
		2917	parked => 1,
2057	prio => 0,	2918	prio => 0,
2058	at => $NEXT_TICK || $TICK,	2919	at => $NEXT_TICK || $TICK,
2059	data => WF_AUTOCANCEL,	2920	data => WF_AUTOCANCEL,
2060	cb => sub {	2921	cb => sub {
2061	unless ($FREEZE) {	2922	if ($Coro::current != $Coro::main) {
		2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2924	unless ++$bug_warning > 10;
		2925	return;
		2926	}
		2927
		2928	$NOW = $tick_start = Event::time;
		2929
2062	cf::server_tick; # one server iteration	2930	cf::server_tick; # one server iteration
2063	$RUNTIME += $TICK;	2931
		2932	0 && sync_job {#d#
		2933	for(1..10) {
		2934	my $t = Event::time;
		2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2936	or die;
		2937
		2938	$map->width (50);
		2939	$map->height (50);
		2940	$map->alloc;
		2941	$map->_load_objects ("/tmp/x.map", 1);
		2942	my $t = Event::time - $t;
		2943
		2944	#next unless $t < 0.0013;#d#
		2945	if ($t < $min) {
		2946	$min = $t;
		2947	}
		2948	$avg = $avg * 0.99 + $t * 0.01;
		2949	}
		2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2951	exit 0;
		2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2064	}	2953	};
2065		2954
		2955	$RUNTIME += $TICK;
2066	$NEXT_TICK += $TICK;	2956	$NEXT_TICK += $TICK;
2067		2957
		2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2959	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2960	Coro::async_pool {
		2961	write_runtime
		2962	or warn "ERROR: unable to write runtime file: $!";
		2963	};
		2964	}
		2965
		2966	# my $AFTER = Event::time;
		2967	# warn $AFTER - $NOW;#d#
		2968
		2969	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2970	$sig->send;
		2971	}
		2972	while (my $sig = shift @WAIT_FOR_TICK) {
		2973	$sig->send;
		2974	}
		2975
		2976	$NOW = Event::time;
		2977
2068	# if we are delayed by four ticks or more, skip them all	2978	# if we are delayed by four ticks or more, skip them all
2069	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2979	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2070		2980
2071	$TICK_WATCHER->at ($NEXT_TICK);	2981	$TICK_WATCHER->at ($NEXT_TICK);
2072	$TICK_WATCHER->start;	2982	$TICK_WATCHER->start;
		2983
		2984	$LOAD = ($NOW - $tick_start) / $TICK;
		2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2986
		2987	_post_tick;
		2988
		2989
2073	},	2990	},
2074	);	2991	);
2075		2992
		2993	{
2076	IO::AIO::max_poll_time $TICK * 0.2;	2994	BDB::max_poll_time $TICK * 0.1;
2077		2995	$BDB_POLL_WATCHER = Event->io (
2078	Event->io (	2996	reentrant => 0,
2079	fd => IO::AIO::poll_fileno,	2997	fd => BDB::poll_fileno,
2080	poll => 'r',	2998	poll => 'r',
2081	prio => 5,	2999	prio => 0,
2082	data => WF_AUTOCANCEL,
2083	cb => \&IO::AIO::poll_cb,
2084	);
2085
2086	Event->timer (
2087	data => WF_AUTOCANCEL,	3000	data => WF_AUTOCANCEL,
2088	after => 0,	3001	cb => \&BDB::poll_cb,
2089	interval => 10,	3002	);
2090	cb => sub {	3003	BDB::min_parallel 8;
2091	(Coro::unblock_sub {	3004
2092	write_runtime	3005	BDB::set_sync_prepare {
2093	or warn "ERROR: unable to write runtime file: $!";	3006	my $status;
		3007	my $current = $Coro::current;
		3008	(
		3009	sub {
		3010	$status = $!;
		3011	$current->ready; undef $current;
		3012	},
		3013	sub {
		3014	Coro::schedule while defined $current;
		3015	$! = $status;
		3016	},
		3017	)
		3018	};
		3019
		3020	unless ($DB_ENV) {
		3021	$DB_ENV = BDB::db_env_create;
		3022
		3023	cf::sync_job {
		3024	eval {
		3025	BDB::db_env_open
		3026	$DB_ENV,
		3027	$BDBDIR,
		3028	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3030	0666;
		3031
		3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3033
		3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3035	$DB_ENV->set_lk_detect;
		3036	};
		3037
		3038	cf::cleanup "db_env_open(db): $@" if $@;
2094	})->();	3039	};
2095	},	3040	}
2096	);	3041	}
		3042
		3043	{
		3044	IO::AIO::min_parallel 8;
		3045
		3046	undef $Coro::AIO::WATCHER;
		3047	IO::AIO::max_poll_time $TICK * 0.1;
		3048	$AIO_POLL_WATCHER = Event->io (
		3049	reentrant => 0,
		3050	data => WF_AUTOCANCEL,
		3051	fd => IO::AIO::poll_fileno,
		3052	poll => 'r',
		3053	prio => 6,
		3054	cb => \&IO::AIO::poll_cb,
		3055	);
		3056	}
		3057
		3058	my $_log_backtrace;
		3059
		3060	sub _log_backtrace {
		3061	my ($msg, @addr) = @_;
		3062
		3063	$msg =~ s/\n//;
		3064
		3065	# limit the # of concurrent backtraces
		3066	if ($_log_backtrace < 2) {
		3067	++$_log_backtrace;
		3068	async {
		3069	my @bt = fork_call {
		3070	@addr = map { sprintf "%x", $_ } @addr;
		3071	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3072	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3073	or die "addr2line: $!";
		3074
		3075	my @funcs;
		3076	my @res = <$fh>;
		3077	chomp for @res;
		3078	while (@res) {
		3079	my ($func, $line) = splice @res, 0, 2, ();
		3080	push @funcs, "[$func] $line";
		3081	}
		3082
		3083	@funcs
		3084	};
		3085
		3086	LOG llevInfo, "[ABT] $msg\n";
		3087	LOG llevInfo, "[ABT] $_\n" for @bt;
		3088	--$_log_backtrace;
		3089	};
		3090	} else {
		3091	LOG llevInfo, "[ABT] $msg\n";
		3092	LOG llevInfo, "[ABT] [suppressed]\n";
		3093	}
		3094	}
		3095
		3096	# load additional modules
		3097	use cf::pod;
		3098
		3099	END { cf::emergency_save }
2097		3100
2098	1	3101	1
2099		3102

Diff Legend

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