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.117 by root, Mon Jan 1 17:50:26 2007 UTC vs.
Revision 1.279 by root, Mon Jun 11 22:16:53 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3;	15	use Coro 3.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";
…		…
817	(aio_load "$filename.pst", $av) >= 0	872	(aio_load "$filename.pst", $av) >= 0
818	or return;	873	or return;
819	$av = eval { (Storable::thaw $av)->{objs} };	874	$av = eval { (Storable::thaw $av)->{objs} };
820	}	875	}
821		876
		877	warn sprintf "loading %s (%d)\n",
		878	$filename, length $data, scalar @{$av || []};
822	return ($data, $av);	879	return ($data, $av);
823	}	880	}
824		881
825	#############################################################################	882	#############################################################################
826	# command handling &c	883	# command handling &c
…		…
851	=cut	908	=cut
852		909
853	sub register_extcmd {	910	sub register_extcmd {
854	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
855		912
856	my $caller = caller;
857	#warn "registering extcmd '$name' to '$caller'";
858
859	$EXTCMD{$name} = [$cb, $caller];	913	$EXTCMD{$name} = $cb;
860	}	914	}
861		915
862	cf::player->attach (	916	cf::player->attach (
863	on_command => sub {	917	on_command => sub {
864	my ($pl, $name, $params) = @_;	918	my ($pl, $name, $params) = @_;
…		…
877		931
878	my $msg = eval { from_json $buf };	932	my $msg = eval { from_json $buf };
879		933
880	if (ref $msg) {	934	if (ref $msg) {
881	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
882	if (my %reply = $cb->[0]->($pl, $msg)) {	936	if (my %reply = $cb->($pl, $msg)) {
883	$pl->ext_reply ($msg->{msgid}, %reply);	937	$pl->ext_reply ($msg->{msgid}, %reply);
884	}	938	}
885	}	939	}
886	} else {	940	} else {
887	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
889		943
890	cf::override;	944	cf::override;
891	},	945	},
892	);	946	);
893		947
894	sub register {
895	my ($base, $pkg) = @_;
896
897	#TODO
898	}
899
900	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)[0, 1] } split /\s+/, $1 }
		973	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		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*/, $v->{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	: "$v->{base}: extension inactive.\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	warn $msg;
		1007	}
		1008
		1009	$done{$k} = delete $todo{$k};
		1010	push @EXTS, $v->{pkg};
		1011	$progress = 1;
		1012	}
		1013
		1014	skip:
		1015	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1016	unless $progress;
		1017	}
		1018	};
		1019	}
		1020
		1021	#############################################################################
		1022
		1023	=head2 CORE EXTENSIONS
		1024
		1025	Functions and methods that extend core crossfire objects.
		1026
		1027	=cut
		1028
		1029	package cf::player;
		1030
		1031	use Coro::AIO;
		1032
		1033	=head3 cf::player
		1034
		1035	=over 4
		1036
		1037	=item cf::player::find $login
		1038
		1039	Returns the given player object, loading it if necessary (might block).
		1040
		1041	=cut
		1042
		1043	sub playerdir($) {
		1044	"$PLAYERDIR/"
		1045	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1046	}
		1047
		1048	sub path($) {
		1049	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1050
		1051	(playerdir $login) . "/playerdata"
		1052	}
		1053
		1054	sub find_active($) {
		1055	$cf::PLAYER{$_[0]}
		1056	and $cf::PLAYER{$_[0]}->active
		1057	and $cf::PLAYER{$_[0]}
		1058	}
		1059
		1060	sub exists($) {
		1061	my ($login) = @_;
		1062
		1063	$cf::PLAYER{$login}
		1064	or cf::sync_job { !aio_stat path $login }
		1065	}
		1066
		1067	sub find($) {
		1068	return $cf::PLAYER{$_[0]} || do {
		1069	my $login = $_[0];
		1070
		1071	my $guard = cf::lock_acquire "user_find:$login";
		1072
		1073	$cf::PLAYER{$_[0]} || do {
		1074	# rename old playerfiles to new ones
		1075	#TODO: remove when no longer required
		1076	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1077	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1078	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1079	aio_unlink +(playerdir $login) . "/$login.pl";
		1080
		1081	my $pl = load_pl path $login
		1082	or return;
		1083	$cf::PLAYER{$login} = $pl
		1084	}
		1085	}
		1086	}
		1087
		1088	sub save($) {
		1089	my ($pl) = @_;
		1090
		1091	return if $pl->{deny_save};
		1092
		1093	my $path = path $pl;
		1094	my $guard = cf::lock_acquire "user_save:$path";
		1095
		1096	return if $pl->{deny_save};
		1097
		1098	aio_mkdir playerdir $pl, 0770;
		1099	$pl->{last_save} = $cf::RUNTIME;
		1100
		1101	$pl->save_pl ($path);
		1102	Coro::cede;
		1103	}
		1104
		1105	sub new($) {
		1106	my ($login) = @_;
		1107
		1108	my $self = create;
		1109
		1110	$self->ob->name ($login);
		1111	$self->{deny_save} = 1;
		1112
		1113	$cf::PLAYER{$login} = $self;
		1114
		1115	$self
		1116	}
		1117
		1118	=item $pl->quit_character
		1119
		1120	Nukes the player without looking back. If logged in, the connection will
		1121	be destroyed. May block for a long time.
		1122
		1123	=cut
		1124
		1125	sub quit_character {
		1126	my ($pl) = @_;
		1127
		1128	my $name = $pl->ob->name;
		1129
		1130	$pl->{deny_save} = 1;
		1131	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1132
		1133	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1134	$pl->deactivate;
		1135	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1136	$pl->ns->destroy if $pl->ns;
		1137
		1138	my $path = playerdir $pl;
		1139	my $temp = "$path~$cf::RUNTIME~deleting~";
		1140	aio_rename $path, $temp;
		1141	delete $cf::PLAYER{$pl->ob->name};
		1142	$pl->destroy;
		1143
		1144	my $prefix = qr<^~\Q$name\E/>;
		1145
		1146	# nuke player maps
		1147	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1148
		1149	IO::AIO::aio_rmtree $temp;
		1150	}
		1151
		1152	=item $pl->kick
		1153
		1154	Kicks a player out of the game. This destroys the connection.
		1155
		1156	=cut
		1157
		1158	sub kick {
		1159	my ($pl, $kicker) = @_;
		1160
		1161	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1162	$pl->killer ("kicked");
		1163	$pl->ns->destroy;
		1164	}
		1165
		1166	=item cf::player::list_logins
		1167
		1168	Returns am arrayref of all valid playernames in the system, can take a
		1169	while and may block, so not sync_job-capable, ever.
		1170
		1171	=cut
		1172
		1173	sub list_logins {
		1174	my $dirs = aio_readdir $PLAYERDIR
		1175	or return [];
		1176
		1177	my @logins;
		1178
		1179	for my $login (@$dirs) {
		1180	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1181	aio_read $fh, 0, 512, my $buf, 0 or next;
		1182	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1183
		1184	utf8::decode $login;
		1185	push @logins, $login;
		1186	}
		1187
		1188	\@logins
		1189	}
		1190
		1191	=item $player->maps
		1192
		1193	Returns an arrayref of map paths that are private for this
		1194	player. May block.
		1195
		1196	=cut
		1197
		1198	sub maps($) {
		1199	my ($pl) = @_;
		1200
		1201	$pl = ref $pl ? $pl->ob->name : $pl;
		1202
		1203	my $files = aio_readdir playerdir $pl
		1204	or return;
		1205
		1206	my @paths;
		1207
		1208	for (@$files) {
		1209	utf8::decode $_;
		1210	next if /\.(?:pl|pst)$/;
		1211	next unless /^$PATH_SEP/o;
		1212
		1213	push @paths, cf::map::normalise "~$pl/$_";
		1214	}
		1215
		1216	\@paths
		1217	}
		1218
		1219	=item $player->ext_reply ($msgid, %msg)
		1220
		1221	Sends an ext reply to the player.
		1222
		1223	=cut
		1224
		1225	sub ext_reply($$%) {
		1226	my ($self, $id, %msg) = @_;
		1227
		1228	$msg{msgid} = $id;
		1229
		1230	$self->send ("ext " . cf::to_json \%msg);
		1231	}
		1232
		1233	=item $player->ext_event ($type, %msg)
		1234
		1235	Sends an ext event to the client.
		1236
		1237	=cut
		1238
		1239	sub ext_event($$%) {
		1240	my ($self, $type, %msg) = @_;
		1241
		1242	$self->ns->ext_event ($type, %msg);
		1243	}
		1244
		1245	=head3 cf::region
		1246
		1247	=over 4
		1248
		1249	=cut
		1250
		1251	package cf::region;
		1252
		1253	=item cf::region::find_by_path $path
		1254
		1255	Tries to decuce the probable region for a map knowing only its path.
		1256
		1257	=cut
		1258
		1259	sub find_by_path($) {
901	my ($path) = @_;	1260	my ($path) = @_;
902		1261
903	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1262	my ($match, $specificity);
904	my $base = $1;
905	my $pkg = $1;
906	$pkg =~ s/[^[:word:]]/_/g;
907	$pkg = "ext::$pkg";
908		1263
909	warn "loading '$path' into '$pkg'\n";	1264	for my $region (list) {
910		1265	if ($region->match && $path =~ $region->match) {
911	open my $fh, "<:utf8", $path	1266	($match, $specificity) = ($region, $region->specificity)
912	or die "$path: $!";	1267	if $region->specificity > $specificity;
913		1268	}
914	my $source =
915	"package $pkg; use strict; use utf8;\n"
916	. "#line 1 \"$path\"\n{\n"
917	. (do { local $/; <$fh> })
918	. "\n};\n1";
919
920	eval $source
921	or die $@ ? "$path: $@\n"
922	: "extension disabled.\n";
923
924	push @exts, $pkg;
925	$ext_pkg{$base} = $pkg;
926
927	# no strict 'refs';
928	# @{"$pkg\::ISA"} = ext::;
929
930	register $base, $pkg;
931	}
932
933	sub unload_extension {
934	my ($pkg) = @_;
935
936	warn "removing extension $pkg\n";
937
938	# remove hooks
939	#TODO
940	# for my $idx (0 .. $#PLUGIN_EVENT) {
941	# delete $hook[$idx]{$pkg};
942	# }	1269	}
943		1270
944	# remove commands	1271	$match
945	for my $name (keys %COMMAND) {
946	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
947
948	if (@cb) {
949	$COMMAND{$name} = \@cb;
950	} else {
951	delete $COMMAND{$name};
952	}
953	}
954
955	# remove extcmds
956	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
957	delete $EXTCMD{$name};
958	}
959
960	if (my $cb = $pkg->can ("unload")) {
961	eval {
962	$cb->($pkg);
963	1
964	} or warn "$pkg unloaded, but with errors: $@";
965	}
966
967	Symbol::delete_package $pkg;
968	}
969
970	sub load_extensions {
971	for my $ext (<$LIBDIR/*.ext>) {
972	next unless -r $ext;
973	eval {
974	load_extension $ext;
975	1
976	} or warn "$ext not loaded: $@";
977	}
978	}
979
980	#############################################################################
981	# load/save/clean perl data associated with a map
982
983	*cf::mapsupport::on_clean = sub {
984	my ($map) = @_;
985
986	my $path = $map->tmpname;
987	defined $path or return;
988
989	unlink "$path.pst";
990	};
991
992	cf::map->attach (prio => -10000, package => cf::mapsupport::);
993
994	#############################################################################
995	# load/save perl data associated with player->ob objects
996
997	sub all_objects(@) {
998	@_, map all_objects ($_->inv), @_
999	}
1000
1001	# TODO: compatibility cruft, remove when no longer needed
1002	cf::player->attach (
1003	on_load => sub {
1004	my ($pl, $path) = @_;
1005
1006	for my $o (all_objects $pl->ob) {
1007	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1008	$o->set_ob_key_value ("_perl_data");
1009
1010	%$o = %{ Storable::thaw pack "H*", $value };
1011	}
1012	}
1013	},
1014	);
1015
1016	#############################################################################
1017
1018	=head2 CORE EXTENSIONS
1019
1020	Functions and methods that extend core crossfire objects.
1021
1022	=head3 cf::player
1023
1024	=over 4
1025
1026	=item cf::player::exists $login
1027
1028	Returns true when the given account exists.
1029
1030	=cut
1031
1032	sub cf::player::exists($) {
1033	cf::player::find $_[0]
1034	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1035	}
1036
1037	=item $player->ext_reply ($msgid, $msgtype, %msg)
1038
1039	Sends an ext reply to the player.
1040
1041	=cut
1042
1043	sub cf::player::ext_reply($$$%) {
1044	my ($self, $id, %msg) = @_;
1045
1046	$msg{msgid} = $id;
1047
1048	$self->send ("ext " . to_json \%msg);
1049	}	1272	}
1050		1273
1051	=back	1274	=back
1052
1053		1275
1054	=head3 cf::map	1276	=head3 cf::map
1055		1277
1056	=over 4	1278	=over 4
1057		1279
…		…
1060	package cf::map;	1282	package cf::map;
1061		1283
1062	use Fcntl;	1284	use Fcntl;
1063	use Coro::AIO;	1285	use Coro::AIO;
1064		1286
		1287	use overload
		1288	'""' => \&as_string,
		1289	fallback => 1;
		1290
1065	our $MAX_RESET = 7200;	1291	our $MAX_RESET = 3600;
1066	our $DEFAULT_RESET = 3600;	1292	our $DEFAULT_RESET = 3000;
1067		1293
1068	sub generate_random_map {	1294	sub generate_random_map {
1069	my ($path, $rmp) = @_;	1295	my ($self, $rmp) = @_;
1070
1071	# mit "rum" bekleckern, nicht	1296	# mit "rum" bekleckern, nicht
1072	cf::map::_create_random_map	1297	$self->_create_random_map (
1073	$path,
1074	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1298	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1075	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1299	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1076	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1300	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1077	$rmp->{exit_on_final_map},	1301	$rmp->{exit_on_final_map},
1078	$rmp->{xsize}, $rmp->{ysize},	1302	$rmp->{xsize}, $rmp->{ysize},
1079	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1303	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1080	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1304	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1081	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1305	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1082	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1306	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1083	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1307	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1084	(cf::region::find $rmp->{region})	1308	(cf::region::find $rmp->{region}), $rmp->{custom}
		1309	)
		1310	}
		1311
		1312	=item cf::map->register ($regex, $prio)
		1313
		1314	Register a handler for the map path matching the given regex at the
		1315	givne priority (higher is better, built-in handlers have priority 0, the
		1316	default).
		1317
		1318	=cut
		1319
		1320	sub register {
		1321	my (undef, $regex, $prio) = @_;
		1322	my $pkg = caller;
		1323
		1324	no strict;
		1325	push @{"$pkg\::ISA"}, __PACKAGE__;
		1326
		1327	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1328	}
		1329
		1330	# also paths starting with '/'
		1331	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1332
		1333	sub thawer_merge {
		1334	my ($self, $merge) = @_;
		1335
		1336	# we have to keep some variables in memory intact
		1337	local $self->{path};
		1338	local $self->{load_path};
		1339
		1340	$self->SUPER::thawer_merge ($merge);
		1341	}
		1342
		1343	sub normalise {
		1344	my ($path, $base) = @_;
		1345
		1346	$path = "$path"; # make sure its a string
		1347
		1348	$path =~ s/\.map$//;
		1349
		1350	# map plan:
		1351	#
		1352	# /! non-realised random map exit (special hack!)
		1353	# {... are special paths that are not being touched
		1354	# ?xxx/... are special absolute paths
		1355	# ?random/... random maps
		1356	# /... normal maps
		1357	# ~user/... per-player map of a specific user
		1358
		1359	$path =~ s/$PATH_SEP/\//go;
		1360
		1361	# treat it as relative path if it starts with
		1362	# something that looks reasonable
		1363	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1364	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1365
		1366	$base =~ s{[^/]+/?$}{};
		1367	$path = "$base/$path";
		1368	}
		1369
		1370	for ($path) {
		1371	redo if s{//}{/};
		1372	redo if s{/\.?/}{/};
		1373	redo if s{/[^/]+/\.\./}{/};
		1374	}
		1375
		1376	$path
		1377	}
		1378
		1379	sub new_from_path {
		1380	my (undef, $path, $base) = @_;
		1381
		1382	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1383
		1384	$path = normalise $path, $base;
		1385
		1386	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1387	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1388	my $self = bless cf::map::new, $pkg;
		1389	$self->{path} = $path; $self->path ($path);
		1390	$self->init; # pass $1 etc.
		1391	return $self;
		1392	}
		1393	}
		1394
		1395	Carp::carp "unable to resolve path '$path' (base '$base').";
		1396	()
		1397	}
		1398
		1399	sub init {
		1400	my ($self) = @_;
		1401
		1402	$self
		1403	}
		1404
		1405	sub as_string {
		1406	my ($self) = @_;
		1407
		1408	"$self->{path}"
		1409	}
		1410
		1411	# the displayed name, this is a one way mapping
		1412	sub visible_name {
		1413	&as_string
		1414	}
		1415
		1416	# the original (read-only) location
		1417	sub load_path {
		1418	my ($self) = @_;
		1419
		1420	"$MAPDIR/$self->{path}.map"
		1421	}
		1422
		1423	# the temporary/swap location
		1424	sub save_path {
		1425	my ($self) = @_;
		1426
		1427	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1428	"$TMPDIR/$path.map"
		1429	}
		1430
		1431	# the unique path, undef == no special unique path
		1432	sub uniq_path {
		1433	my ($self) = @_;
		1434
		1435	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1436	"$UNIQUEDIR/$path"
1085	}	1437	}
1086		1438
1087	# and all this just because we cannot iterate over	1439	# and all this just because we cannot iterate over
1088	# all maps in C++...	1440	# all maps in C++...
1089	sub change_all_map_light {	1441	sub change_all_map_light {
1090	my ($change) = @_;	1442	my ($change) = @_;
1091		1443
1092	$_->change_map_light ($change) for values %cf::MAP;	1444	$_->change_map_light ($change)
		1445	for grep $_->outdoor, values %cf::MAP;
1093	}	1446	}
1094		1447
		1448	sub decay_objects {
		1449	my ($self) = @_;
		1450
		1451	return if $self->{deny_reset};
		1452
		1453	$self->do_decay_objects;
		1454	}
		1455
		1456	sub unlink_save {
		1457	my ($self) = @_;
		1458
		1459	utf8::encode (my $save = $self->save_path);
		1460	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1461	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1462	}
		1463
1095	sub try_load_header($) {	1464	sub load_header_from($) {
1096	my ($path) = @_;	1465	my ($self, $path) = @_;
1097		1466
1098	utf8::encode $path;	1467	utf8::encode $path;
1099	aio_open $path, O_RDONLY, 0	1468	#aio_open $path, O_RDONLY, 0
		1469	# or return;
		1470
		1471	$self->_load_header ($path)
1100	or return;	1472	or return;
1101		1473
1102	my $map = cf::map::new	1474	$self->{load_path} = $path;
		1475
		1476	1
		1477	}
		1478
		1479	sub load_header_orig {
		1480	my ($self) = @_;
		1481
		1482	$self->load_header_from ($self->load_path)
		1483	}
		1484
		1485	sub load_header_temp {
		1486	my ($self) = @_;
		1487
		1488	$self->load_header_from ($self->save_path)
		1489	}
		1490
		1491	sub prepare_temp {
		1492	my ($self) = @_;
		1493
		1494	$self->last_access ((delete $self->{last_access})
		1495	|| $cf::RUNTIME); #d#
		1496	# safety
		1497	$self->{instantiate_time} = $cf::RUNTIME
		1498	if $self->{instantiate_time} > $cf::RUNTIME;
		1499	}
		1500
		1501	sub prepare_orig {
		1502	my ($self) = @_;
		1503
		1504	$self->{load_original} = 1;
		1505	$self->{instantiate_time} = $cf::RUNTIME;
		1506	$self->last_access ($cf::RUNTIME);
		1507	$self->instantiate;
		1508	}
		1509
		1510	sub load_header {
		1511	my ($self) = @_;
		1512
		1513	if ($self->load_header_temp) {
		1514	$self->prepare_temp;
		1515	} else {
		1516	$self->load_header_orig
1103	or return;	1517	or return;
		1518	$self->prepare_orig;
		1519	}
1104		1520
1105	$map->load_header ($path)	1521	$self->{deny_reset} = 1
1106	or return;	1522	if $self->no_reset;
1107		1523
1108	$map->{load_path} = $path;	1524	$self->default_region (cf::region::find_by_path $self->{path})
		1525	unless $self->default_region;
1109		1526
1110	$map	1527	1
1111	}	1528	}
1112		1529
		1530	sub find;
1113	sub find_map {	1531	sub find {
1114	my ($path, $origin) = @_;	1532	my ($path, $origin) = @_;
1115		1533
1116	#warn "find_map<$path,$origin>\n";#d#
1117
1118	$path = new cf::path $path, $origin && $origin->path;	1534	$path = normalise $path, $origin && $origin->path;
1119	my $key = $path->as_string;
1120		1535
		1536	cf::lock_wait "map_find:$path";
		1537
1121	$cf::MAP{$key} || do {	1538	$cf::MAP{$path} || do {
1122	# do it the slow way	1539	my $guard = cf::lock_acquire "map_find:$path";
1123	my $map = try_load_header $path->save_path;	1540	my $map = new_from_path cf::map $path
1124
1125	if ($map) {
1126	# safety
1127	$map->{instantiate_time} = $cf::RUNTIME
1128	if $map->{instantiate_time} > $cf::RUNTIME;
1129	} else {
1130	if (my $rmp = $path->random_map_params) {
1131	$map = generate_random_map $key, $rmp;
1132	} else {
1133	$map = try_load_header $path->load_path;
1134	}
1135
1136	$map or return;	1541	or return;
1137		1542
1138	$map->{load_original} = 1;
1139	$map->{instantiate_time} = $cf::RUNTIME;
1140	$map->instantiate;
1141
1142	# per-player maps become, after loading, normal maps
1143	$map->per_player (0) if $path->{user_rel};
1144	}
1145
1146	$map->path ($key);
1147	$map->{path} = $path;
1148	$map->{last_save} = $cf::RUNTIME;	1543	$map->{last_save} = $cf::RUNTIME;
1149	$map->last_access ($cf::RUNTIME);
1150		1544
1151	if ($map->should_reset) {	1545	$map->load_header
		1546	or return;
		1547
		1548	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1549	# doing this can freeze the server in a sync job, obviously
		1550	#$cf::WAIT_FOR_TICK->wait;
1152	$map->reset;	1551	$map->reset;
1153	$map = find_map $path;	1552	undef $guard;
		1553	return find $path;
1154	}	1554	}
1155		1555
1156	$cf::MAP{$key} = $map	1556	$cf::MAP{$path} = $map
1157	}	1557	}
1158	}	1558	}
		1559
		1560	sub pre_load { }
		1561	sub post_load { }
1159		1562
1160	sub load {	1563	sub load {
1161	my ($self) = @_;	1564	my ($self) = @_;
1162		1565
1163	return if $self->in_memory != cf::MAP_SWAPPED;	1566	local $self->{deny_reset} = 1; # loading can take a long time
1164
1165	$self->in_memory (cf::MAP_LOADING);
1166		1567
1167	my $path = $self->{path};	1568	my $path = $self->{path};
1168		1569
		1570	{
		1571	my $guard = cf::lock_acquire "map_load:$path";
		1572
		1573	return if $self->in_memory != cf::MAP_SWAPPED;
		1574
		1575	$self->in_memory (cf::MAP_LOADING);
		1576
1169	$self->alloc;	1577	$self->alloc;
		1578
		1579	$self->pre_load;
		1580	Coro::cede;
		1581
1170	$self->load_objects ($self->{load_path}, 1)	1582	$self->_load_objects ($self->{load_path}, 1)
1171	or return;	1583	or return;
1172		1584
1173	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1585	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1174	if delete $self->{load_original};	1586	if delete $self->{load_original};
1175		1587
1176	if (my $uniq = $path->uniq_path) {	1588	if (my $uniq = $self->uniq_path) {
1177	utf8::encode $uniq;	1589	utf8::encode $uniq;
1178	if (aio_open $uniq, O_RDONLY, 0) {	1590	if (aio_open $uniq, O_RDONLY, 0) {
1179	$self->clear_unique_items;	1591	$self->clear_unique_items;
1180	$self->load_objects ($uniq, 0);	1592	$self->_load_objects ($uniq, 0);
1181	}	1593	}
1182	}	1594	}
1183		1595
		1596	Coro::cede;
1184	# now do the right thing for maps	1597	# now do the right thing for maps
1185	$self->link_multipart_objects;	1598	$self->link_multipart_objects;
1186
1187	if ($self->{path}->is_style_map) {
1188	$self->{deny_save} = 1;
1189	$self->{deny_reset} = 1;
1190	} else {
1191	$self->fix_auto_apply;
1192	$self->decay_objects;
1193	$self->update_buttons;
1194	$self->set_darkness_map;
1195	$self->difficulty ($self->estimate_difficulty)	1599	$self->difficulty ($self->estimate_difficulty)
1196	unless $self->difficulty;	1600	unless $self->difficulty;
		1601	Coro::cede;
		1602
		1603	unless ($self->{deny_activate}) {
		1604	$self->decay_objects;
		1605	$self->fix_auto_apply;
		1606	$self->update_buttons;
		1607	Coro::cede;
		1608	$self->set_darkness_map;
		1609	Coro::cede;
1197	$self->activate;	1610	$self->activate;
1198	}	1611	}
1199		1612
1200	$self->in_memory (cf::MAP_IN_MEMORY);	1613	$self->in_memory (cf::MAP_IN_MEMORY);
1201	}	1614	}
1202		1615
1203	sub load_map_sync {	1616	$self->post_load;
		1617	}
		1618
		1619	sub customise_for {
		1620	my ($self, $ob) = @_;
		1621
		1622	return find "~" . $ob->name . "/" . $self->{path}
		1623	if $self->per_player;
		1624
		1625	# return find "?party/" . $ob->name . "/" . $self->{path}
		1626	# if $self->per_party;
		1627
		1628	$self
		1629	}
		1630
		1631	# find and load all maps in the 3x3 area around a map
		1632	sub load_diag {
		1633	my ($map) = @_;
		1634
		1635	my @diag; # diagonal neighbours
		1636
		1637	for (0 .. 3) {
		1638	my $neigh = $map->tile_path ($_)
		1639	or next;
		1640	$neigh = find $neigh, $map
		1641	or next;
		1642	$neigh->load;
		1643
		1644	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1645	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1646	}
		1647
		1648	for (@diag) {
		1649	my $neigh = find @$_
		1650	or next;
		1651	$neigh->load;
		1652	}
		1653	}
		1654
		1655	sub find_sync {
1204	my ($path, $origin) = @_;	1656	my ($path, $origin) = @_;
1205		1657
1206	#warn "load_map_sync<$path, $origin>\n";#d#	1658	cf::sync_job { find $path, $origin }
		1659	}
1207		1660
1208	cf::sync_job {	1661	sub do_load_sync {
1209	my $map = cf::map::find_map $path, $origin	1662	my ($map) = @_;
1210	or return;	1663
		1664	cf::sync_job { $map->load };
		1665	}
		1666
		1667	our %MAP_PREFETCH;
		1668	our $MAP_PREFETCHER = undef;
		1669
		1670	sub find_async {
		1671	my ($path, $origin) = @_;
		1672
		1673	$path = normalise $path, $origin && $origin->{path};
		1674
		1675	if (my $map = $cf::MAP{$path}) {
		1676	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1677	}
		1678
		1679	undef $MAP_PREFETCH{$path};
		1680	$MAP_PREFETCHER ||= cf::async {
		1681	while (%MAP_PREFETCH) {
		1682	for my $path (keys %MAP_PREFETCH) {
		1683	my $map = find $path
		1684	or next;
1211	$map->load;	1685	$map->load;
1212	$map	1686
		1687	delete $MAP_PREFETCH{$path};
		1688	}
		1689	}
		1690	undef $MAP_PREFETCHER;
1213	}	1691	};
		1692	$MAP_PREFETCHER->prio (6);
		1693
		1694	()
1214	}	1695	}
1215		1696
1216	sub save {	1697	sub save {
1217	my ($self) = @_;	1698	my ($self) = @_;
1218		1699
		1700	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1701
1219	$self->{last_save} = $cf::RUNTIME;	1702	$self->{last_save} = $cf::RUNTIME;
1220		1703
1221	return unless $self->dirty;	1704	return unless $self->dirty;
1222		1705
1223	my $save = $self->{path}->save_path; utf8::encode $save;	1706	my $save = $self->save_path; utf8::encode $save;
1224	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1707	my $uniq = $self->uniq_path; utf8::encode $uniq;
1225		1708
1226	$self->{load_path} = $save;	1709	$self->{load_path} = $save;
1227		1710
1228	return if $self->{deny_save};	1711	return if $self->{deny_save};
1229		1712
		1713	local $self->{last_access} = $self->last_access;#d#
		1714
		1715	cf::async {
		1716	$_->contr->save for $self->players;
		1717	};
		1718
1230	if ($uniq) {	1719	if ($uniq) {
1231	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1720	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1232	$self->save_objects ($uniq, cf::IO_UNIQUES);	1721	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1233	} else {	1722	} else {
1234	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1723	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1235	}	1724	}
1236	}	1725	}
1237		1726
1238	sub swap_out {	1727	sub swap_out {
1239	my ($self) = @_;	1728	my ($self) = @_;
		1729
		1730	# save first because save cedes
		1731	$self->save;
		1732
		1733	my $lock = cf::lock_acquire "map_data:" . $self->path;
1240		1734
1241	return if $self->players;	1735	return if $self->players;
1242	return if $self->in_memory != cf::MAP_IN_MEMORY;	1736	return if $self->in_memory != cf::MAP_IN_MEMORY;
1243	return if $self->{deny_save};	1737	return if $self->{deny_save};
1244		1738
1245	$self->save;
1246	$self->clear;	1739	$self->clear;
1247	$self->in_memory (cf::MAP_SWAPPED);	1740	$self->in_memory (cf::MAP_SWAPPED);
1248	}	1741	}
1249		1742
1250	sub reset_at {	1743	sub reset_at {
1251	my ($self) = @_;	1744	my ($self) = @_;
1252		1745
1253	# TODO: safety, remove and allow resettable per-player maps	1746	# TODO: safety, remove and allow resettable per-player maps
1254	return 1e99 if $self->{path}{user_rel};
1255	return 1e99 if $self->{deny_reset};	1747	return 1e99 if $self->{deny_reset};
1256		1748
1257	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1749	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1258	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1750	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1259		1751
…		…
1264	my ($self) = @_;	1756	my ($self) = @_;
1265		1757
1266	$self->reset_at <= $cf::RUNTIME	1758	$self->reset_at <= $cf::RUNTIME
1267	}	1759	}
1268		1760
1269	sub unlink_save {
1270	my ($self) = @_;
1271
1272	utf8::encode (my $save = $self->{path}->save_path);
1273	aioreq_pri 3; IO::AIO::aio_unlink $save;
1274	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1275	}
1276
1277	sub rename {
1278	my ($self, $new_path) = @_;
1279
1280	$self->unlink_save;
1281
1282	delete $cf::MAP{$self->path};
1283	$self->{path} = new cf::path $new_path;
1284	$self->path ($self->{path}->as_string);
1285	$cf::MAP{$self->path} = $self;
1286
1287	$self->save;
1288	}
1289
1290	sub reset {	1761	sub reset {
1291	my ($self) = @_;	1762	my ($self) = @_;
1292		1763
		1764	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1765
1293	return if $self->players;	1766	return if $self->players;
1294	return if $self->{path}{user_rel};#d#
1295		1767
1296	warn "resetting map ", $self->path;#d#	1768	warn "resetting map ", $self->path;
		1769
		1770	$self->in_memory (cf::MAP_SWAPPED);
		1771
		1772	# need to save uniques path
		1773	unless ($self->{deny_save}) {
		1774	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1775
		1776	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1777	if $uniq;
		1778	}
1297		1779
1298	delete $cf::MAP{$self->path};	1780	delete $cf::MAP{$self->path};
		1781
		1782	$self->clear;
1299		1783
1300	$_->clear_links_to ($self) for values %cf::MAP;	1784	$_->clear_links_to ($self) for values %cf::MAP;
1301		1785
1302	$self->unlink_save;	1786	$self->unlink_save;
1303	$self->destroy;	1787	$self->destroy;
…		…
1306	my $nuke_counter = "aaaa";	1790	my $nuke_counter = "aaaa";
1307		1791
1308	sub nuke {	1792	sub nuke {
1309	my ($self) = @_;	1793	my ($self) = @_;
1310		1794
		1795	delete $cf::MAP{$self->path};
		1796
		1797	$self->unlink_save;
		1798
		1799	bless $self, "cf::map";
		1800	delete $self->{deny_reset};
1311	$self->{deny_save} = 1;	1801	$self->{deny_save} = 1;
1312	$self->reset_timeout (1);	1802	$self->reset_timeout (1);
1313	$self->rename ("{nuke}/" . ($nuke_counter++));	1803	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1804
		1805	$cf::MAP{$self->path} = $self;
		1806
1314	$self->reset; # polite request, might not happen	1807	$self->reset; # polite request, might not happen
1315	}	1808	}
1316		1809
1317	sub customise_for {	1810	=item $maps = cf::map::tmp_maps
1318	my ($map, $ob) = @_;
1319		1811
1320	if ($map->per_player) {	1812	Returns an arrayref with all map paths of currently instantiated and saved
1321	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	1813	maps. May block.
		1814
		1815	=cut
		1816
		1817	sub tmp_maps() {
1322	}	1818	[
1323		1819	map {
1324	$map	1820	utf8::decode $_;
		1821	/\.map$/
		1822	? normalise $_
		1823	: ()
		1824	} @{ aio_readdir $TMPDIR or [] }
		1825	]
1325	}	1826	}
1326		1827
1327	sub emergency_save {	1828	=item $maps = cf::map::random_maps
1328	local $cf::FREEZE = 1;
1329		1829
1330	warn "enter emergency map save\n";	1830	Returns an arrayref with all map paths of currently instantiated and saved
		1831	random maps. May block.
1331		1832
1332	cf::sync_job {	1833	=cut
1333	warn "begin emergency map save\n";
1334	$_->save for values %cf::MAP;
1335	};
1336		1834
1337	warn "end emergency map save\n";	1835	sub random_maps() {
		1836	[
		1837	map {
		1838	utf8::decode $_;
		1839	/\.map$/
		1840	? normalise "?random/$_"
		1841	: ()
		1842	} @{ aio_readdir $RANDOMDIR or [] }
		1843	]
		1844	}
		1845
		1846	=item cf::map::unique_maps
		1847
		1848	Returns an arrayref of paths of all shared maps that have
		1849	instantiated unique items. May block.
		1850
		1851	=cut
		1852
		1853	sub unique_maps() {
		1854	[
		1855	map {
		1856	utf8::decode $_;
		1857	/\.map$/
		1858	? normalise $_
		1859	: ()
		1860	} @{ aio_readdir $UNIQUEDIR or [] }
		1861	]
1338	}	1862	}
1339		1863
1340	package cf;	1864	package cf;
1341		1865
1342	=back	1866	=back
1343		1867
		1868	=head3 cf::object
		1869
		1870	=cut
		1871
		1872	package cf::object;
		1873
		1874	=over 4
		1875
		1876	=item $ob->inv_recursive
		1877
		1878	Returns the inventory of the object _and_ their inventories, recursively.
		1879
		1880	=cut
		1881
		1882	sub inv_recursive_;
		1883	sub inv_recursive_ {
		1884	map { $_, inv_recursive_ $_->inv } @_
		1885	}
		1886
		1887	sub inv_recursive {
		1888	inv_recursive_ inv $_[0]
		1889	}
		1890
		1891	package cf;
		1892
		1893	=back
1344		1894
1345	=head3 cf::object::player	1895	=head3 cf::object::player
1346		1896
1347	=over 4	1897	=over 4
1348		1898
…		…
1388		1938
1389	=item $player_object->enter_link	1939	=item $player_object->enter_link
1390		1940
1391	Freezes the player and moves him/her to a special map (C<{link}>).	1941	Freezes the player and moves him/her to a special map (C<{link}>).
1392		1942
1393	The player should be reaosnably safe there for short amounts of time. You	1943	The player should be reasonably safe there for short amounts of time. You
1394	I<MUST> call C<leave_link> as soon as possible, though.	1944	I<MUST> call C<leave_link> as soon as possible, though.
1395		1945
		1946	Will never block.
		1947
1396	=item $player_object->leave_link ($map, $x, $y)	1948	=item $player_object->leave_link ($map, $x, $y)
1397		1949
1398	Moves the player out of the specila link map onto the given map. If the	1950	Moves the player out of the special C<{link}> map onto the specified
1399	map is not valid (or omitted), the player will be moved back to the	1951	map. If the map is not valid (or omitted), the player will be moved back
1400	location he/she was before the call to C<enter_link>, or, if that fails,	1952	to the location he/she was before the call to C<enter_link>, or, if that
1401	to the emergency map position.	1953	fails, to the emergency map position.
1402		1954
1403	Might block.	1955	Might block.
1404		1956
1405	=cut	1957	=cut
		1958
		1959	sub link_map {
		1960	unless ($LINK_MAP) {
		1961	$LINK_MAP = cf::map::find "{link}"
		1962	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1963	$LINK_MAP->load;
		1964	}
		1965
		1966	$LINK_MAP
		1967	}
1406		1968
1407	sub cf::object::player::enter_link {	1969	sub cf::object::player::enter_link {
1408	my ($self) = @_;	1970	my ($self) = @_;
1409		1971
1410	return if $self->map == $LINK_MAP;
1411
1412	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1413	if $self->map;
1414
1415	$self->enter_map ($LINK_MAP, 20, 20);
1416	$self->deactivate_recursive;	1972	$self->deactivate_recursive;
		1973
		1974	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1975
		1976	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1977	if $self->map && $self->map->{path} ne "{link}";
		1978
		1979	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1417	}	1980	}
1418		1981
1419	sub cf::object::player::leave_link {	1982	sub cf::object::player::leave_link {
1420	my ($self, $map, $x, $y) = @_;	1983	my ($self, $map, $x, $y) = @_;
		1984
		1985	return unless $self->contr->active;
1421		1986
1422	my $link_pos = delete $self->{_link_pos};	1987	my $link_pos = delete $self->{_link_pos};
1423		1988
1424	unless ($map) {	1989	unless ($map) {
1425	# restore original map position	1990	# restore original map position
1426	($map, $x, $y) = @{ $link_pos || [] };	1991	($map, $x, $y) = @{ $link_pos || [] };
1427	$map = cf::map::find_map $map;	1992	$map = cf::map::find $map;
1428		1993
1429	unless ($map) {	1994	unless ($map) {
1430	($map, $x, $y) = @$EMERGENCY_POSITION;	1995	($map, $x, $y) = @$EMERGENCY_POSITION;
1431	$map = cf::map::find_map $map	1996	$map = cf::map::find $map
1432	or die "FATAL: cannot load emergency map\n";	1997	or die "FATAL: cannot load emergency map\n";
1433	}	1998	}
1434	}	1999	}
1435		2000
1436	($x, $y) = (-1, -1)	2001	($x, $y) = (-1, -1)
…		…
1439	# use -1 or undef as default coordinates, not 0, 0	2004	# use -1 or undef as default coordinates, not 0, 0
1440	($x, $y) = ($map->enter_x, $map->enter_y)	2005	($x, $y) = ($map->enter_x, $map->enter_y)
1441	if $x <=0 && $y <= 0;	2006	if $x <=0 && $y <= 0;
1442		2007
1443	$map->load;	2008	$map->load;
		2009	$map->load_diag;
1444		2010
		2011	return unless $self->contr->active;
1445	$self->activate_recursive;	2012	$self->activate_recursive;
		2013
		2014	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1446	$self->enter_map ($map, $x, $y);	2015	$self->enter_map ($map, $x, $y);
1447	}	2016	}
1448		2017
1449	=item $player_object->goto_map ($map, $x, $y)	2018	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1450		2019
1451	=cut	2020	Moves the player to the given map-path and coordinates by first freezing
		2021	her, loading and preparing them map, calling the provided $check callback
		2022	that has to return the map if sucecssful, and then unfreezes the player on
		2023	the new (success) or old (failed) map position.
1452		2024
		2025	=cut
		2026
		2027	our $GOTOGEN;
		2028
1453	sub cf::object::player::goto_map {	2029	sub cf::object::player::goto {
1454	my ($self, $path, $x, $y) = @_;	2030	my ($self, $path, $x, $y, $check) = @_;
		2031
		2032	# do generation counting so two concurrent goto's will be executed in-order
		2033	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1455		2034
1456	$self->enter_link;	2035	$self->enter_link;
1457		2036
1458	(Coro::async {	2037	(async {
1459	$path = new cf::path $path;	2038	my $map = eval {
1460
1461	my $map = cf::map::find_map $path->as_string;	2039	my $map = cf::map::find $path;
1462	$map = $map->customise_for ($self) if $map;
1463		2040
1464	warn "entering ", $map->path, " at ($x, $y)\n"
1465	if $map;	2041	if ($map) {
1466		2042	$map = $map->customise_for ($self);
		2043	$map = $check->($map) if $check && $map;
		2044	} else {
1467	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2045	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2046	}
1468		2047
		2048	$map
		2049	};
		2050
		2051	if ($@) {
		2052	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2053	LOG llevError | logBacktrace, Carp::longmess $@;
		2054	}
		2055
		2056	if ($gen == $self->{_goto_generation}) {
		2057	delete $self->{_goto_generation};
1469	$self->leave_link ($map, $x, $y);	2058	$self->leave_link ($map, $x, $y);
		2059	}
1470	})->prio (1);	2060	})->prio (1);
1471	}	2061	}
1472		2062
1473	=item $player_object->enter_exit ($exit_object)	2063	=item $player_object->enter_exit ($exit_object)
1474		2064
…		…
1476		2066
1477	sub parse_random_map_params {	2067	sub parse_random_map_params {
1478	my ($spec) = @_;	2068	my ($spec) = @_;
1479		2069
1480	my $rmp = { # defaults	2070	my $rmp = { # defaults
1481	xsize => 10,	2071	xsize => (cf::rndm 15, 40),
1482	ysize => 10,	2072	ysize => (cf::rndm 15, 40),
		2073	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2074	#layout => string,
1483	};	2075	};
1484		2076
1485	for (split /\n/, $spec) {	2077	for (split /\n/, $spec) {
1486	my ($k, $v) = split /\s+/, $_, 2;	2078	my ($k, $v) = split /\s+/, $_, 2;
1487		2079
…		…
1491	$rmp	2083	$rmp
1492	}	2084	}
1493		2085
1494	sub prepare_random_map {	2086	sub prepare_random_map {
1495	my ($exit) = @_;	2087	my ($exit) = @_;
		2088
		2089	my $guard = cf::lock_acquire "exit_prepare:$exit";
1496		2090
1497	# all this does is basically replace the /! path by	2091	# all this does is basically replace the /! path by
1498	# a new random map path (?random/...) with a seed	2092	# a new random map path (?random/...) with a seed
1499	# that depends on the exit object	2093	# that depends on the exit object
1500		2094
1501	my $rmp = parse_random_map_params $exit->msg;	2095	my $rmp = parse_random_map_params $exit->msg;
1502		2096
1503	if ($exit->map) {	2097	if ($exit->map) {
1504	$rmp->{region} = $exit->map->region_name;	2098	$rmp->{region} = $exit->region->name;
1505	$rmp->{origin_map} = $exit->map->path;	2099	$rmp->{origin_map} = $exit->map->path;
1506	$rmp->{origin_x} = $exit->x;	2100	$rmp->{origin_x} = $exit->x;
1507	$rmp->{origin_y} = $exit->y;	2101	$rmp->{origin_y} = $exit->y;
1508	}	2102	}
1509		2103
1510	$rmp->{random_seed} ||= $exit->random_seed;	2104	$rmp->{random_seed} ||= $exit->random_seed;
1511		2105
1512	my $data = cf::to_json $rmp;	2106	my $data = cf::to_json $rmp;
1513	my $md5 = Digest::MD5::md5_hex $data;	2107	my $md5 = Digest::MD5::md5_hex $data;
		2108	my $meta = "$RANDOMDIR/$md5.meta";
1514		2109
1515	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2110	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1516	aio_write $fh, 0, (length $data), $data, 0;	2111	aio_write $fh, 0, (length $data), $data, 0;
		2112	undef $fh;
		2113	aio_rename "$meta~", $meta;
1517		2114
1518	$exit->slaying ("?random/$md5");	2115	$exit->slaying ("?random/$md5");
1519	$exit->msg (undef);	2116	$exit->msg (undef);
1520	}	2117	}
1521	}	2118	}
…		…
1523	sub cf::object::player::enter_exit {	2120	sub cf::object::player::enter_exit {
1524	my ($self, $exit) = @_;	2121	my ($self, $exit) = @_;
1525		2122
1526	return unless $self->type == cf::PLAYER;	2123	return unless $self->type == cf::PLAYER;
1527		2124
		2125	if ($exit->slaying eq "/!") {
		2126	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2127	# the problem is that $exit might not survive long enough
		2128	# so it needs to be done right now, right here
		2129	cf::sync_job { prepare_random_map $exit };
		2130	}
		2131
		2132	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2133	my $hp = $exit->stats->hp;
		2134	my $sp = $exit->stats->sp;
		2135
1528	$self->enter_link;	2136	$self->enter_link;
1529		2137
1530	(Coro::async {	2138	(async {
		2139	$self->deactivate_recursive; # just to be sure
1531	unless (eval {	2140	unless (eval {
1532		2141	$self->goto ($slaying, $hp, $sp);
1533	prepare_random_map $exit
1534	if $exit->slaying eq "/!";
1535
1536	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1537	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1538		2142
1539	1;	2143	1;
1540	}) {	2144	}) {
1541	$self->message ("Something went wrong deep within the crossfire server. "	2145	$self->message ("Something went wrong deep within the crossfire server. "
1542	. "I'll try to bring you back to the map you were before. "	2146	. "I'll try to bring you back to the map you were before. "
1543	. "Please report this to the dungeon master",	2147	. "Please report this to the dungeon master!",
1544	cf::NDI_UNIQUE | cf::NDI_RED);	2148	cf::NDI_UNIQUE | cf::NDI_RED);
1545		2149
1546	warn "ERROR in enter_exit: $@";	2150	warn "ERROR in enter_exit: $@";
1547	$self->leave_link;	2151	$self->leave_link;
1548	}	2152	}
1549	})->prio (1);	2153	})->prio (1);
…		…
1562		2166
1563	sub cf::client::send_drawinfo {	2167	sub cf::client::send_drawinfo {
1564	my ($self, $text, $flags) = @_;	2168	my ($self, $text, $flags) = @_;
1565		2169
1566	utf8::encode $text;	2170	utf8::encode $text;
1567	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2171	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1568	}	2172	}
1569		2173
		2174	=item $client->ext_event ($type, %msg)
		2175
		2176	Sends an exti event to the client.
		2177
		2178	=cut
		2179
		2180	sub cf::client::ext_event($$%) {
		2181	my ($self, $type, %msg) = @_;
		2182
		2183	$msg{msgtype} = "event_$type";
		2184	$self->send_packet ("ext " . cf::to_json \%msg);
		2185	}
1570		2186
1571	=item $success = $client->query ($flags, "text", \&cb)	2187	=item $success = $client->query ($flags, "text", \&cb)
1572		2188
1573	Queues a query to the client, calling the given callback with	2189	Queues a query to the client, calling the given callback with
1574	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2190	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1599	on_reply => sub {	2215	on_reply => sub {
1600	my ($ns, $msg) = @_;	2216	my ($ns, $msg) = @_;
1601		2217
1602	# this weird shuffling is so that direct followup queries	2218	# this weird shuffling is so that direct followup queries
1603	# get handled first	2219	# get handled first
1604	my $queue = delete $ns->{query_queue};	2220	my $queue = delete $ns->{query_queue}
		2221	or return; # be conservative, not sure how that can happen, but we saw a crash here
1605		2222
1606	(shift @$queue)->[1]->($msg);	2223	(shift @$queue)->[1]->($msg);
		2224	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1607		2225
1608	push @{ $ns->{query_queue} }, @$queue;	2226	push @{ $ns->{query_queue} }, @$queue;
1609		2227
1610	if (@{ $ns->{query_queue} } == @$queue) {	2228	if (@{ $ns->{query_queue} } == @$queue) {
1611	if (@$queue) {	2229	if (@$queue) {
…		…
1615	}	2233	}
1616	}	2234	}
1617	},	2235	},
1618	);	2236	);
1619		2237
1620	=item $client->coro (\&cb)	2238	=item $client->async (\&cb)
1621		2239
1622	Create a new coroutine, running the specified callback. The coroutine will	2240	Create a new coroutine, running the specified callback. The coroutine will
1623	be automatically cancelled when the client gets destroyed (e.g. on logout,	2241	be automatically cancelled when the client gets destroyed (e.g. on logout,
1624	or loss of connection).	2242	or loss of connection).
1625		2243
1626	=cut	2244	=cut
1627		2245
1628	sub cf::client::coro {	2246	sub cf::client::async {
1629	my ($self, $cb) = @_;	2247	my ($self, $cb) = @_;
1630		2248
1631	my $coro; $coro = async {	2249	my $coro = &Coro::async ($cb);
1632	eval {
1633	$cb->();
1634	};
1635	warn $@ if $@;
1636	};
1637		2250
1638	$coro->on_destroy (sub {	2251	$coro->on_destroy (sub {
1639	delete $self->{_coro}{$coro+0};	2252	delete $self->{_coro}{$coro+0};
1640	});	2253	});
1641		2254
…		…
1674		2287
1675	# here we export the classes and methods available to script code	2288	# here we export the classes and methods available to script code
1676		2289
1677	=pod	2290	=pod
1678		2291
1679	The following fucntions and emthods are available within a safe environment:	2292	The following functions and methods are available within a safe environment:
1680		2293
1681	cf::object contr pay_amount pay_player map	2294	cf::object contr pay_amount pay_player map
1682	cf::object::player player	2295	cf::object::player player
1683	cf::player peaceful	2296	cf::player peaceful
1684	cf::map trigger	2297	cf::map trigger
…		…
1769	#############################################################################	2382	#############################################################################
1770		2383
1771	=head2 EXTENSION DATABASE SUPPORT	2384	=head2 EXTENSION DATABASE SUPPORT
1772		2385
1773	Crossfire maintains a very simple database for extension use. It can	2386	Crossfire maintains a very simple database for extension use. It can
1774	currently store anything that can be serialised using Storable, which	2387	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1775	excludes objects.	2388	convert to/from binary).
1776		2389
1777	The parameter C<$family> should best start with the name of the extension	2390	The parameter C<$family> should best start with the name of the extension
1778	using it, it should be unique.	2391	using it, it should be unique.
1779		2392
1780	=over 4	2393	=over 4
1781		2394
1782	=item $hashref = cf::db_get $family
1783
1784	Return a hashref for use by the extension C<$family>, which can be
1785	modified. After modifications, you have to call C<cf::db_dirty> or
1786	C<cf::db_sync>.
1787
1788	=item $value = cf::db_get $family => $key	2395	=item $value = cf::db_get $family => $key
1789		2396
1790	Returns a single value from the database	2397	Returns a single value from the database.
1791
1792	=item cf::db_put $family => $hashref
1793
1794	Stores the given family hashref into the database. Updates are delayed, if
1795	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1796		2398
1797	=item cf::db_put $family => $key => $value	2399	=item cf::db_put $family => $key => $value
1798		2400
1799	Stores the given C<$value> in the family hash. Updates are delayed, if you	2401	Stores the given C<$value> in the family.
1800	want the data to be synced to disk immediately, use C<cf::db_sync>.
1801
1802	=item cf::db_dirty
1803
1804	Marks the database as dirty, to be updated at a later time.
1805
1806	=item cf::db_sync
1807
1808	Immediately write the database to disk I<if it is dirty>.
1809		2402
1810	=cut	2403	=cut
1811		2404
1812	our $DB;	2405	our $DB;
1813		2406
1814	{	2407	sub db_init {
1815	my $path = cf::localdir . "/database.pst";	2408	unless ($DB) {
		2409	$DB = BDB::db_create $DB_ENV;
1816		2410
1817	sub db_load() {	2411	cf::sync_job {
1818	warn "loading database $path\n";#d# remove later	2412	eval {
1819	$DB = stat $path ? Storable::retrieve $path : { };	2413	$DB->set_flags (BDB::CHKSUM);
1820	}
1821		2414
1822	my $pid;	2415	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1823		2416	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1824	sub db_save() {	2417	cf::cleanup "db_open(db): $!" if $!;
1825	warn "saving database $path\n";#d# remove later	2418	};
1826	waitpid $pid, 0 if $pid;	2419	cf::cleanup "db_open(db): $@" if $@;
1827	if (0 == ($pid = fork)) {
1828	$DB->{_meta}{version} = 1;
1829	Storable::nstore $DB, "$path~";
1830	rename "$path~", $path;
1831	cf::_exit 0 if defined $pid;
1832	}	2420	};
1833	}
1834
1835	my $dirty;
1836
1837	sub db_sync() {
1838	db_save if $dirty;
1839	undef $dirty;
1840	}
1841
1842	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1843	db_sync;
1844	});	2421	}
		2422	}
1845		2423
1846	sub db_dirty() {
1847	$dirty = 1;
1848	$idle->start;
1849	}
1850
1851	sub db_get($;$) {	2424	sub db_get($$) {
1852	@_ >= 2	2425	my $key = "$_[0]/$_[1]";
1853	? $DB->{$_[0]}{$_[1]}
1854	: ($DB->{$_[0]} ||= { })
1855	}
1856		2426
		2427	cf::sync_job {
		2428	BDB::db_get $DB, undef, $key, my $data;
		2429
		2430	$! ? ()
		2431	: $data
		2432	}
		2433	}
		2434
1857	sub db_put($$;$) {	2435	sub db_put($$$) {
1858	if (@_ >= 3) {	2436	BDB::dbreq_pri 4;
1859	$DB->{$_[0]}{$_[1]} = $_[2];	2437	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1860	} else {	2438	}
1861	$DB->{$_[0]} = $_[1];
1862	}
1863	db_dirty;
1864	}
1865		2439
1866	cf::global->attach (	2440	=item cf::cache $id => [$paths...], $processversion => $process
1867	prio => 10000,	2441
1868	on_cleanup => sub {	2442	Generic caching function that returns the value of the resource $id,
1869	db_sync;	2443	caching and regenerating as required.
		2444
		2445	This function can block.
		2446
		2447	=cut
		2448
		2449	sub cache {
		2450	my ($id, $src, $processversion, $process) = @_;
		2451
		2452	my $meta =
		2453	join "\x00",
		2454	$processversion,
		2455	map {
		2456	aio_stat $_
		2457	and Carp::croak "$_: $!";
		2458
		2459	($_, (stat _)[7,9])
		2460	} @$src;
		2461
		2462	my $dbmeta = db_get cache => "$id/meta";
		2463	if ($dbmeta ne $meta) {
		2464	# changed, we may need to process
		2465
		2466	my @data;
		2467	my $md5;
		2468
		2469	for (0 .. $#$src) {
		2470	0 <= aio_load $src->[$_], $data[$_]
		2471	or Carp::croak "$src->[$_]: $!";
1870	},	2472	}
1871	);	2473
		2474	# if processing is expensive, check
		2475	# checksum first
		2476	if (1) {
		2477	$md5 =
		2478	join "\x00",
		2479	$processversion,
		2480	map {
		2481	Coro::cede;
		2482	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2483	} 0.. $#$src;
		2484
		2485
		2486	my $dbmd5 = db_get cache => "$id/md5";
		2487	if ($dbmd5 eq $md5) {
		2488	db_put cache => "$id/meta", $meta;
		2489
		2490	return db_get cache => "$id/data";
		2491	}
		2492	}
		2493
		2494	my $t1 = Time::HiRes::time;
		2495	my $data = $process->(\@data);
		2496	my $t2 = Time::HiRes::time;
		2497
		2498	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2499
		2500	db_put cache => "$id/data", $data;
		2501	db_put cache => "$id/md5" , $md5;
		2502	db_put cache => "$id/meta", $meta;
		2503
		2504	return $data;
		2505	}
		2506
		2507	db_get cache => "$id/data"
		2508	}
		2509
		2510	=item fork_call { }, $args
		2511
		2512	Executes the given code block with the given arguments in a seperate
		2513	process, returning the results. Everything must be serialisable with
		2514	Coro::Storable. May, of course, block. Note that the executed sub may
		2515	never block itself or use any form of Event handling.
		2516
		2517	=cut
		2518
		2519	sub fork_call(&@) {
		2520	my ($cb, @args) = @_;
		2521
		2522	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2523	# or die "socketpair: $!";
		2524	pipe my $fh1, my $fh2
		2525	or die "pipe: $!";
		2526
		2527	if (my $pid = fork) {
		2528	close $fh2;
		2529
		2530	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2531	$res = Coro::Storable::thaw $res;
		2532
		2533	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2534
		2535	die $$res unless "ARRAY" eq ref $res;
		2536
		2537	return wantarray ? @$res : $res->[-1];
		2538	} else {
		2539	reset_signals;
		2540	local $SIG{__WARN__};
		2541	local $SIG{__DIE__};
		2542	eval {
		2543	close $fh1;
		2544
		2545	my @res = eval { $cb->(@args) };
		2546	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2547	};
		2548
		2549	warn $@ if $@;
		2550	_exit 0;
		2551	}
1872	}	2552	}
1873		2553
1874	#############################################################################	2554	#############################################################################
1875	# the server's main()	2555	# the server's init and main functions
		2556
		2557	sub load_facedata($) {
		2558	my ($path) = @_;
		2559
		2560	warn "loading facedata from $path\n";
		2561
		2562	my $facedata;
		2563	0 < aio_load $path, $facedata
		2564	or die "$path: $!";
		2565
		2566	$facedata = Coro::Storable::thaw $facedata;
		2567
		2568	$facedata->{version} == 2
		2569	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2570
		2571	{
		2572	my $faces = $facedata->{faceinfo};
		2573
		2574	while (my ($face, $info) = each %$faces) {
		2575	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2576	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2577	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2578	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2579	Coro::cede;
		2580	}
		2581
		2582	while (my ($face, $info) = each %$faces) {
		2583	next unless $info->{smooth};
		2584	my $idx = cf::face::find $face
		2585	or next;
		2586	if (my $smooth = cf::face::find $info->{smooth}) {
		2587	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2588	} else {
		2589	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2590	}
		2591	Coro::cede;
		2592	}
		2593	}
		2594
		2595	{
		2596	my $anims = $facedata->{animinfo};
		2597
		2598	while (my ($anim, $info) = each %$anims) {
		2599	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2600	Coro::cede;
		2601	}
		2602
		2603	cf::anim::invalidate_all; # d'oh
		2604	}
		2605
		2606	1
		2607	}
		2608
		2609	sub reload_regions {
		2610	load_resource_file "$MAPDIR/regions"
		2611	or die "unable to load regions file\n";
		2612	}
		2613
		2614	sub reload_facedata {
		2615	load_facedata "$DATADIR/facedata"
		2616	or die "unable to load facedata\n";
		2617	}
		2618
		2619	sub reload_archetypes {
		2620	load_resource_file "$DATADIR/archetypes"
		2621	or die "unable to load archetypes\n";
		2622	}
		2623
		2624	sub reload_treasures {
		2625	load_resource_file "$DATADIR/treasures"
		2626	or die "unable to load treasurelists\n";
		2627	}
		2628
		2629	sub reload_resources {
		2630	warn "reloading resource files...\n";
		2631
		2632	reload_regions;
		2633	reload_facedata;
		2634	#reload_archetypes;#d#
		2635	reload_archetypes;
		2636	reload_treasures;
		2637
		2638	warn "finished reloading resource files\n";
		2639	}
		2640
		2641	sub init {
		2642	reload_resources;
		2643	}
1876		2644
1877	sub cfg_load {	2645	sub cfg_load {
1878	open my $fh, "<:utf8", cf::confdir . "/config"	2646	open my $fh, "<:utf8", "$CONFDIR/config"
1879	or return;	2647	or return;
1880		2648
1881	local $/;	2649	local $/;
1882	*CFG = YAML::Syck::Load <$fh>;	2650	*CFG = YAML::Syck::Load <$fh>;
		2651
		2652	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2653
		2654	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2655	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2656
		2657	if (exists $CFG{mlockall}) {
		2658	eval {
		2659	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2660	and die "WARNING: m(un)lockall failed: $!\n";
		2661	};
		2662	warn $@ if $@;
		2663	}
1883	}	2664	}
1884		2665
1885	sub main {	2666	sub main {
1886	# we must not ever block the main coroutine	2667	# we must not ever block the main coroutine
1887	local $Coro::idle = sub {	2668	local $Coro::idle = sub {
1888	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2669	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1889	(Coro::unblock_sub {	2670	(async {
1890	Event::one_event;	2671	Event::one_event;
1891	})->();	2672	})->prio (Coro::PRIO_MAX);
1892	};	2673	};
1893		2674
1894	cfg_load;	2675	cfg_load;
1895	db_load;	2676	db_init;
1896	load_extensions;	2677	load_extensions;
		2678
		2679	$TICK_WATCHER->start;
1897	Event::loop;	2680	Event::loop;
1898	}	2681	}
1899		2682
1900	#############################################################################	2683	#############################################################################
1901	# initialisation	2684	# initialisation and cleanup
1902		2685
		2686	# install some emergency cleanup handlers
		2687	BEGIN {
		2688	for my $signal (qw(INT HUP TERM)) {
		2689	Event->signal (
		2690	reentrant => 0,
		2691	data => WF_AUTOCANCEL,
		2692	signal => $signal,
		2693	prio => 0,
		2694	cb => sub {
		2695	cf::cleanup "SIG$signal";
		2696	},
		2697	);
		2698	}
		2699	}
		2700
		2701	sub emergency_save() {
		2702	my $freeze_guard = cf::freeze_mainloop;
		2703
		2704	warn "enter emergency perl save\n";
		2705
		2706	cf::sync_job {
		2707	# use a peculiar iteration method to avoid tripping on perl
		2708	# refcount bugs in for. also avoids problems with players
		2709	# and maps saved/destroyed asynchronously.
		2710	warn "begin emergency player save\n";
		2711	for my $login (keys %cf::PLAYER) {
		2712	my $pl = $cf::PLAYER{$login} or next;
		2713	$pl->valid or next;
		2714	$pl->save;
		2715	}
		2716	warn "end emergency player save\n";
		2717
		2718	warn "begin emergency map save\n";
		2719	for my $path (keys %cf::MAP) {
		2720	my $map = $cf::MAP{$path} or next;
		2721	$map->valid or next;
		2722	$map->save;
		2723	}
		2724	warn "end emergency map save\n";
		2725
		2726	warn "begin emergency database checkpoint\n";
		2727	BDB::db_env_txn_checkpoint $DB_ENV;
		2728	warn "end emergency database checkpoint\n";
		2729	};
		2730
		2731	warn "leave emergency perl save\n";
		2732	}
		2733
		2734	sub post_cleanup {
		2735	my ($make_core) = @_;
		2736
		2737	warn Carp::longmess "post_cleanup backtrace"
		2738	if $make_core;
		2739	}
		2740
1903	sub reload() {	2741	sub do_reload_perl() {
1904	# can/must only be called in main	2742	# can/must only be called in main
1905	if ($Coro::current != $Coro::main) {	2743	if ($Coro::current != $Coro::main) {
1906	warn "can only reload from main coroutine\n";	2744	warn "can only reload from main coroutine";
1907	return;	2745	return;
1908	}	2746	}
1909		2747
1910	warn "reloading...";	2748	warn "reloading...";
1911		2749
1912	local $FREEZE = 1;	2750	warn "entering sync_job";
		2751
		2752	cf::sync_job {
		2753	cf::write_runtime; # external watchdog should not bark
1913	cf::emergency_save;	2754	cf::emergency_save;
		2755	cf::write_runtime; # external watchdog should not bark
1914		2756
1915	eval {	2757	warn "syncing database to disk";
		2758	BDB::db_env_txn_checkpoint $DB_ENV;
		2759
1916	# if anything goes wrong in here, we should simply crash as we already saved	2760	# if anything goes wrong in here, we should simply crash as we already saved
1917		2761
1918	# cancel all watchers	2762	warn "cancelling all WF_AUTOCANCEL watchers";
1919	for (Event::all_watchers) {	2763	for (Event::all_watchers) {
1920	$_->cancel if $_->data & WF_AUTOCANCEL;	2764	$_->cancel if $_->data & WF_AUTOCANCEL;
1921	}	2765	}
1922		2766
		2767	warn "flushing outstanding aio requests";
		2768	for (;;) {
		2769	BDB::flush;
		2770	IO::AIO::flush;
		2771	Coro::cede;
		2772	last unless IO::AIO::nreqs || BDB::nreqs;
		2773	warn "iterate...";
		2774	}
		2775
		2776	++$RELOAD;
		2777
1923	# cancel all extension coros	2778	warn "cancelling all extension coros";
1924	$_->cancel for values %EXT_CORO;	2779	$_->cancel for values %EXT_CORO;
1925	%EXT_CORO = ();	2780	%EXT_CORO = ();
1926		2781
1927	# unload all extensions	2782	warn "removing commands";
1928	for (@exts) {	2783	%COMMAND = ();
		2784
		2785	warn "removing ext commands";
		2786	%EXTCMD = ();
		2787
		2788	warn "unloading/nuking all extensions";
		2789	for my $pkg (@EXTS) {
1929	warn "unloading <$_>";	2790	warn "... unloading $pkg";
1930	unload_extension $_;	2791
		2792	if (my $cb = $pkg->can ("unload")) {
		2793	eval {
		2794	$cb->($pkg);
		2795	1
		2796	} or warn "$pkg unloaded, but with errors: $@";
1931	}	2797	}
1932		2798
		2799	warn "... nuking $pkg";
		2800	Symbol::delete_package $pkg;
		2801	}
		2802
1933	# unload all modules loaded from $LIBDIR	2803	warn "unloading all perl modules loaded from $LIBDIR";
1934	while (my ($k, $v) = each %INC) {	2804	while (my ($k, $v) = each %INC) {
1935	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2805	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1936		2806
1937	warn "removing <$k>";	2807	warn "... unloading $k";
1938	delete $INC{$k};	2808	delete $INC{$k};
1939		2809
1940	$k =~ s/\.pm$//;	2810	$k =~ s/\.pm$//;
1941	$k =~ s/\//::/g;	2811	$k =~ s/\//::/g;
1942		2812
…		…
1945	}	2815	}
1946		2816
1947	Symbol::delete_package $k;	2817	Symbol::delete_package $k;
1948	}	2818	}
1949		2819
1950	# sync database to disk
1951	cf::db_sync;
1952	IO::AIO::flush;
1953
1954	# get rid of safe::, as good as possible	2820	warn "getting rid of safe::, as good as possible";
1955	Symbol::delete_package "safe::$_"	2821	Symbol::delete_package "safe::$_"
1956	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2822	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1957		2823
1958	# remove register_script_function callbacks
1959	# TODO
1960
1961	# unload cf.pm "a bit"	2824	warn "unloading cf.pm \"a bit\"";
1962	delete $INC{"cf.pm"};	2825	delete $INC{"cf.pm"};
		2826	delete $INC{"cf/pod.pm"};
1963		2827
1964	# don't, removes xs symbols, too,	2828	# don't, removes xs symbols, too,
1965	# and global variables created in xs	2829	# and global variables created in xs
1966	#Symbol::delete_package __PACKAGE__;	2830	#Symbol::delete_package __PACKAGE__;
1967		2831
1968	# reload cf.pm	2832	warn "unload completed, starting to reload now";
		2833
1969	warn "reloading cf.pm";	2834	warn "reloading cf.pm";
1970	require cf;	2835	require cf;
1971	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2836	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1972		2837
1973	# load config and database again	2838	warn "loading config and database again";
1974	cf::cfg_load;	2839	cf::cfg_load;
1975	cf::db_load;
1976		2840
1977	# load extensions
1978	warn "load extensions";	2841	warn "loading extensions";
1979	cf::load_extensions;	2842	cf::load_extensions;
1980		2843
1981	# reattach attachments to objects	2844	warn "reattaching attachments to objects/players";
1982	warn "reattach";	2845	_global_reattach; # objects, sockets
1983	_global_reattach;	2846	warn "reattaching attachments to maps";
1984	};	2847	reattach $_ for values %MAP;
		2848	warn "reattaching attachments to players";
		2849	reattach $_ for values %PLAYER;
1985		2850
1986	if ($@) {	2851	warn "leaving sync_job";
		2852
		2853	1
		2854	} or do {
1987	warn $@;	2855	warn $@;
1988	warn "error while reloading, exiting.";	2856	warn "error while reloading, exiting.";
1989	exit 1;	2857	exit 1;
1990	}	2858	};
1991		2859
1992	warn "reloaded successfully";	2860	warn "reloaded";
1993	};	2861	};
1994		2862
1995	#############################################################################	2863	our $RELOAD_WATCHER; # used only during reload
1996		2864
1997	unless ($LINK_MAP) {	2865	sub reload_perl() {
1998	$LINK_MAP = cf::map::new;	2866	# doing reload synchronously and two reloads happen back-to-back,
		2867	# coro crashes during coro_state_free->destroy here.
1999		2868
2000	$LINK_MAP->width (41);	2869	$RELOAD_WATCHER ||= Event->timer (
2001	$LINK_MAP->height (41);	2870	reentrant => 0,
2002	$LINK_MAP->alloc;
2003	$LINK_MAP->path ("{link}");
2004	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2005	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2006
2007	# dirty hack because... archetypes are not yet loaded
2008	Event->timer (
2009	after => 2,	2871	after => 0,
		2872	data => WF_AUTOCANCEL,
2010	cb => sub {	2873	cb => sub {
2011	$_[0]->w->cancel;	2874	do_reload_perl;
2012		2875	undef $RELOAD_WATCHER;
2013	# provide some exits "home"
2014	my $exit = cf::object::new "exit";
2015
2016	$exit->slaying ($EMERGENCY_POSITION->[0]);
2017	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2018	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2019
2020	$LINK_MAP->insert ($exit->clone, 19, 19);
2021	$LINK_MAP->insert ($exit->clone, 19, 20);
2022	$LINK_MAP->insert ($exit->clone, 19, 21);
2023	$LINK_MAP->insert ($exit->clone, 20, 19);
2024	$LINK_MAP->insert ($exit->clone, 20, 21);
2025	$LINK_MAP->insert ($exit->clone, 21, 19);
2026	$LINK_MAP->insert ($exit->clone, 21, 20);
2027	$LINK_MAP->insert ($exit->clone, 21, 21);
2028
2029	$exit->destroy;
2030	});	2876	},
2031		2877	);
2032	$LINK_MAP->{deny_save} = 1;
2033	$LINK_MAP->{deny_reset} = 1;
2034
2035	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2036	}	2878	}
2037
2038	register "<global>", __PACKAGE__;
2039		2879
2040	register_command "reload" => sub {	2880	register_command "reload" => sub {
2041	my ($who, $arg) = @_;	2881	my ($who, $arg) = @_;
2042		2882
2043	if ($who->flag (FLAG_WIZ)) {	2883	if ($who->flag (FLAG_WIZ)) {
2044	$who->message ("start of reload.");
2045	reload;
2046	$who->message ("end of reload.");	2884	$who->message ("reloading server.");
		2885	async { reload_perl };
2047	}	2886	}
2048	};	2887	};
2049		2888
2050	unshift @INC, $LIBDIR;	2889	unshift @INC, $LIBDIR;
2051		2890
		2891	my $bug_warning = 0;
		2892
		2893	our @WAIT_FOR_TICK;
		2894	our @WAIT_FOR_TICK_BEGIN;
		2895
		2896	sub wait_for_tick {
		2897	return unless $TICK_WATCHER->is_active;
		2898	return if $Coro::current == $Coro::main;
		2899
		2900	my $signal = new Coro::Signal;
		2901	push @WAIT_FOR_TICK, $signal;
		2902	$signal->wait;
		2903	}
		2904
		2905	sub wait_for_tick_begin {
		2906	return unless $TICK_WATCHER->is_active;
		2907	return if $Coro::current == $Coro::main;
		2908
		2909	my $signal = new Coro::Signal;
		2910	push @WAIT_FOR_TICK_BEGIN, $signal;
		2911	$signal->wait;
		2912	}
		2913
		2914	my $min = 1e6;#d#
		2915	my $avg = 10;
2052	$TICK_WATCHER = Event->timer (	2916	$TICK_WATCHER = Event->timer (
2053	reentrant => 0,	2917	reentrant => 0,
		2918	parked => 1,
2054	prio => 0,	2919	prio => 0,
2055	at => $NEXT_TICK || $TICK,	2920	at => $NEXT_TICK || $TICK,
2056	data => WF_AUTOCANCEL,	2921	data => WF_AUTOCANCEL,
2057	cb => sub {	2922	cb => sub {
2058	unless ($FREEZE) {	2923	if ($Coro::current != $Coro::main) {
		2924	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2925	unless ++$bug_warning > 10;
		2926	return;
		2927	}
		2928
		2929	$NOW = $tick_start = Event::time;
		2930
2059	cf::server_tick; # one server iteration	2931	cf::server_tick; # one server iteration
2060	$RUNTIME += $TICK;	2932
		2933	0 && sync_job {#d#
		2934	for(1..10) {
		2935	my $t = Event::time;
		2936	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2937	or die;
		2938
		2939	$map->width (50);
		2940	$map->height (50);
		2941	$map->alloc;
		2942	$map->_load_objects ("/tmp/x.map", 1);
		2943	my $t = Event::time - $t;
		2944
		2945	#next unless $t < 0.0013;#d#
		2946	if ($t < $min) {
		2947	$min = $t;
		2948	}
		2949	$avg = $avg * 0.99 + $t * 0.01;
		2950	}
		2951	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2952	exit 0;
		2953	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2061	}	2954	};
2062		2955
		2956	$RUNTIME += $TICK;
2063	$NEXT_TICK += $TICK;	2957	$NEXT_TICK += $TICK;
2064		2958
		2959	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2960	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2961	Coro::async_pool {
		2962	write_runtime
		2963	or warn "ERROR: unable to write runtime file: $!";
		2964	};
		2965	}
		2966
		2967	# my $AFTER = Event::time;
		2968	# warn $AFTER - $NOW;#d#
		2969
		2970	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2971	$sig->send;
		2972	}
		2973	while (my $sig = shift @WAIT_FOR_TICK) {
		2974	$sig->send;
		2975	}
		2976
		2977	$NOW = Event::time;
		2978
2065	# if we are delayed by four ticks or more, skip them all	2979	# if we are delayed by four ticks or more, skip them all
2066	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2980	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2067		2981
2068	$TICK_WATCHER->at ($NEXT_TICK);	2982	$TICK_WATCHER->at ($NEXT_TICK);
2069	$TICK_WATCHER->start;	2983	$TICK_WATCHER->start;
		2984
		2985	$LOAD = ($NOW - $tick_start) / $TICK;
		2986	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2987
		2988	_post_tick;
		2989
		2990
2070	},	2991	},
2071	);	2992	);
2072		2993
		2994	{
2073	IO::AIO::max_poll_time $TICK * 0.2;	2995	BDB::max_poll_time $TICK * 0.1;
2074		2996	$BDB_POLL_WATCHER = Event->io (
2075	Event->io (	2997	reentrant => 0,
2076	fd => IO::AIO::poll_fileno,	2998	fd => BDB::poll_fileno,
2077	poll => 'r',	2999	poll => 'r',
2078	prio => 5,	3000	prio => 0,
2079	data => WF_AUTOCANCEL,
2080	cb => \&IO::AIO::poll_cb,
2081	);
2082
2083	Event->timer (
2084	data => WF_AUTOCANCEL,	3001	data => WF_AUTOCANCEL,
2085	after => 0,	3002	cb => \&BDB::poll_cb,
2086	interval => 10,	3003	);
2087	cb => sub {	3004	BDB::min_parallel 8;
2088	(Coro::unblock_sub {	3005
2089	write_runtime	3006	BDB::set_sync_prepare {
2090	or warn "ERROR: unable to write runtime file: $!";	3007	my $status;
		3008	my $current = $Coro::current;
		3009	(
		3010	sub {
		3011	$status = $!;
		3012	$current->ready; undef $current;
		3013	},
		3014	sub {
		3015	Coro::schedule while defined $current;
		3016	$! = $status;
		3017	},
		3018	)
		3019	};
		3020
		3021	unless ($DB_ENV) {
		3022	$DB_ENV = BDB::db_env_create;
		3023
		3024	cf::sync_job {
		3025	eval {
		3026	BDB::db_env_open
		3027	$DB_ENV,
		3028	$BDBDIR,
		3029	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3030	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3031	0666;
		3032
		3033	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3034
		3035	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3036	$DB_ENV->set_lk_detect;
		3037	};
		3038
		3039	cf::cleanup "db_env_open(db): $@" if $@;
2091	})->();	3040	};
2092	},	3041	}
2093	);	3042	}
		3043
		3044	{
		3045	IO::AIO::min_parallel 8;
		3046
		3047	undef $Coro::AIO::WATCHER;
		3048	IO::AIO::max_poll_time $TICK * 0.1;
		3049	$AIO_POLL_WATCHER = Event->io (
		3050	reentrant => 0,
		3051	data => WF_AUTOCANCEL,
		3052	fd => IO::AIO::poll_fileno,
		3053	poll => 'r',
		3054	prio => 6,
		3055	cb => \&IO::AIO::poll_cb,
		3056	);
		3057	}
		3058
		3059	my $_log_backtrace;
		3060
		3061	sub _log_backtrace {
		3062	my ($msg, @addr) = @_;
		3063
		3064	$msg =~ s/\n//;
		3065
		3066	# limit the # of concurrent backtraces
		3067	if ($_log_backtrace < 2) {
		3068	++$_log_backtrace;
		3069	async {
		3070	my @bt = fork_call {
		3071	@addr = map { sprintf "%x", $_ } @addr;
		3072	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3073	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3074	or die "addr2line: $!";
		3075
		3076	my @funcs;
		3077	my @res = <$fh>;
		3078	chomp for @res;
		3079	while (@res) {
		3080	my ($func, $line) = splice @res, 0, 2, ();
		3081	push @funcs, "[$func] $line";
		3082	}
		3083
		3084	@funcs
		3085	};
		3086
		3087	LOG llevInfo, "[ABT] $msg\n";
		3088	LOG llevInfo, "[ABT] $_\n" for @bt;
		3089	--$_log_backtrace;
		3090	};
		3091	} else {
		3092	LOG llevInfo, "[ABT] $msg\n";
		3093	LOG llevInfo, "[ABT] [suppressed]\n";
		3094	}
		3095	}
		3096
		3097	# load additional modules
		3098	use cf::pod;
		3099
		3100	END { cf::emergency_save }
2094		3101
2095	1	3102	1
2096		3103

Diff Legend

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