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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.288 by root, Mon Jun 25 07:40: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 JSON::XS 1.4 ();
		26	use BDB ();
20	use Data::Dumper;	27	use Data::Dumper;
21	use Digest::MD5;	28	use Digest::MD5;
22	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
23	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	32	use Time::HiRes;
		33	use Compress::LZF;
26		34
		35	# configure various modules to our taste
		36	#
		37	$Storable::canonical = 1; # reduce rsync transfers
		38	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		39	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		40
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	41	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		42
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	43	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	44	$YAML::Syck::ImplicitUnicode = 1;
33		45
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	46	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		47
		48	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		49
36	our %COMMAND = ();	50	our %COMMAND = ();
37	our %COMMAND_TIME = ();	51	our %COMMAND_TIME = ();
38		52
39	our @EXTS = (); # list of extension package names	53	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	54	our %EXTCMD = ();
		55	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	56	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	57	our %EXT_MAP = (); # pluggable maps
43		58
		59	our $RELOAD; # number of reloads so far
44	our @EVENT;	60	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		61
47	our $TICK = MAX_TIME * 1e-6;	62	our $CONFDIR = confdir;
		63	our $DATADIR = datadir;
		64	our $LIBDIR = "$DATADIR/ext";
		65	our $PODDIR = "$DATADIR/pod";
		66	our $MAPDIR = "$DATADIR/" . mapdir;
		67	our $LOCALDIR = localdir;
		68	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		69	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		70	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		71	our $RANDOMDIR = "$LOCALDIR/random";
		72	our $BDBDIR = "$LOCALDIR/db";
		73
		74	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	75	our $TICK_WATCHER;
		76	our $AIO_POLL_WATCHER;
		77	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
49	our $NEXT_TICK;	78	our $NEXT_TICK;
50	our $NOW;	79	our $NOW;
		80	our $USE_FSYNC = 1; # use fsync to write maps - default off
		81
		82	our $BDB_POLL_WATCHER;
		83	our $DB_ENV;
51		84
52	our %CFG;	85	our %CFG;
53		86
54	our $UPTIME; $UPTIME ||= time;	87	our $UPTIME; $UPTIME ||= time;
55	our $RUNTIME;	88	our $RUNTIME;
56		89
57	our %PLAYER; # all users	90	our %PLAYER; # all users
58	our %MAP; # all maps	91	our %MAP; # all maps
59	our $LINK_MAP; # the special {link} map, which is always available	92	our $LINK_MAP; # the special {link} map, which is always available
60	our $RANDOM_MAPS = cf::localdir . "/random";
61
62	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
63	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
64		93
65	# used to convert map paths into valid unix filenames by replacing / by ∕	94	# used to convert map paths into valid unix filenames by replacing / by ∕
66	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	95	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
67		96
		97	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		98	our $LOADAVG; # same thing, but with alpha-smoothing
		99	our $tick_start; # for load detecting purposes
		100
68	binmode STDOUT;	101	binmode STDOUT;
69	binmode STDERR;	102	binmode STDERR;
70		103
71	# read virtual server time, if available	104	# read virtual server time, if available
72	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	105	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
73	open my $fh, "<", cf::localdir . "/runtime"	106	open my $fh, "<", "$LOCALDIR/runtime"
74	or die "unable to read runtime file: $!";	107	or die "unable to read runtime file: $!";
75	$RUNTIME = <$fh> + 0.;	108	$RUNTIME = <$fh> + 0.;
76	}	109	}
77		110
78	mkdir cf::localdir;	111	mkdir $_
79	mkdir cf::localdir . "/" . cf::playerdir;	112	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
80	mkdir cf::localdir . "/" . cf::tmpdir;
81	mkdir cf::localdir . "/" . cf::uniquedir;
82	mkdir $RANDOM_MAPS;
83		113
84	our $EMERGENCY_POSITION;	114	our $EMERGENCY_POSITION;
		115
		116	sub cf::map::normalise;
85		117
86	#############################################################################	118	#############################################################################
87		119
88	=head2 GLOBAL VARIABLES	120	=head2 GLOBAL VARIABLES
89		121
…		…
96	=item $cf::RUNTIME	128	=item $cf::RUNTIME
97		129
98	The time this server has run, starts at 0 and is increased by $cf::TICK on	130	The time this server has run, starts at 0 and is increased by $cf::TICK on
99	every server tick.	131	every server tick.
100		132
101	=item $cf::LIBDIR	133	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		134	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		135	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
102		136
103	The perl library directory, where extensions and cf-specific modules can	137	Various directories - "/etc", read-only install directory, perl-library
104	be found. It will be added to C<@INC> automatically.	138	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		139	unique-items directory, player file directory, random maps directory and
		140	database environment.
105		141
106	=item $cf::NOW	142	=item $cf::NOW
107		143
108	The time of the last (current) server tick.	144	The time of the last (current) server tick.
109		145
110	=item $cf::TICK	146	=item $cf::TICK
111		147
112	The interval between server ticks, in seconds.	148	The interval between server ticks, in seconds.
		149
		150	=item $cf::LOADAVG
		151
		152	The current CPU load on the server (alpha-smoothed), as a value between 0
		153	(none) and 1 (overloaded), indicating how much time is spent on processing
		154	objects per tick. Healthy values are < 0.5.
		155
		156	=item $cf::LOAD
		157
		158	The raw value load value from the last tick.
113		159
114	=item %cf::CFG	160	=item %cf::CFG
115		161
116	Configuration for the server, loaded from C</etc/crossfire/config>, or	162	Configuration for the server, loaded from C</etc/crossfire/config>, or
117	from wherever your confdir points to.	163	from wherever your confdir points to.
118		164
119	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	165	=item cf::wait_for_tick, cf::wait_for_tick_begin
120		166
121	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	167	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
122	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	168	returns directly I<after> the tick processing (and consequently, can only wake one process
123	processing has been done. Call C<< ->wait >> on them to maximise the	169	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
124	window of cpu time available, or simply to synchronise to the server tick.
125		170
126	=back	171	=back
127		172
128	=cut	173	=cut
129		174
130	BEGIN {	175	BEGIN {
131	*CORE::GLOBAL::warn = sub {	176	*CORE::GLOBAL::warn = sub {
132	my $msg = join "", @_;	177	my $msg = join "", @_;
133	utf8::encode $msg;
134		178
135	$msg .= "\n"	179	$msg .= "\n"
136	unless $msg =~ /\n$/;	180	unless $msg =~ /\n$/;
137		181
		182	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		183
		184	utf8::encode $msg;
138	LOG llevError, $msg;	185	LOG llevError, $msg;
139	};	186	};
140	}	187	}
141		188
142	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	189	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
143	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	190	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
144	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	191	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
145	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	192	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
146	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	193	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		194	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
147	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	195	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
148		196
149	# we bless all objects into (empty) derived classes to force a method lookup	197	# we bless all objects into (empty) derived classes to force a method lookup
150	# within the Safe compartment.	198	# within the Safe compartment.
151	for my $pkg (qw(	199	for my $pkg (qw(
152	cf::global cf::attachable	200	cf::global cf::attachable
…		…
160	}	208	}
161		209
162	$Event::DIED = sub {	210	$Event::DIED = sub {
163	warn "error in event callback: @_";	211	warn "error in event callback: @_";
164	};	212	};
		213
		214	#############################################################################
165		215
166	=head2 UTILITY FUNCTIONS	216	=head2 UTILITY FUNCTIONS
167		217
168	=over 4	218	=over 4
169		219
…		…
188	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	238	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
189	$d	239	$d
190	} || "[unable to dump $_[0]: '$@']";	240	} || "[unable to dump $_[0]: '$@']";
191	}	241	}
192		242
193	use JSON::Syck (); # TODO# replace by JSON::PC once working
194
195	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
196		244
197	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
198		246
199	=cut
200
201	sub from_json($) {
202	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203	JSON::Syck::Load $_[0]
204	}
205
206	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
207		248
208	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
209		250
210	=cut	251	=cut
211		252
212	sub to_json($) {	253	our $json_coder = JSON::XS->new->convert_blessed->utf8->max_size (1e6); # accept ~1mb max
213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	254
214	JSON::Syck::Dump $_[0]	255	sub to_json ($) { $json_coder->encode ($_[0]) }
215	}	256	sub from_json ($) { $json_coder->decode ($_[0]) }
216		257
217	=item cf::lock_wait $string	258	=item cf::lock_wait $string
218		259
219	Wait until the given lock is available. See cf::lock_acquire.	260	Wait until the given lock is available. See cf::lock_acquire.
220		261
…		…
226	returned.	267	returned.
227		268
228	Lock names should begin with a unique identifier (for example, cf::map::find	269	Lock names should begin with a unique identifier (for example, cf::map::find
229	uses map_find and cf::map::load uses map_load).	270	uses map_find and cf::map::load uses map_load).
230		271
		272	=item $locked = cf::lock_active $string
		273
		274	Return true if the lock is currently active, i.e. somebody has locked it.
		275
231	=cut	276	=cut
232		277
233	our %LOCK;	278	our %LOCK;
234		279
235	sub lock_wait($) {	280	sub lock_wait($) {
…		…
254	# wake up all waiters, to be on the safe side	299	# wake up all waiters, to be on the safe side
255	$_->ready for @{ delete $LOCK{$key} };	300	$_->ready for @{ delete $LOCK{$key} };
256	}	301	}
257	}	302	}
258		303
		304	sub lock_active($) {
		305	my ($key) = @_;
		306
		307	! ! $LOCK{$key}
		308	}
		309
259	sub freeze_mainloop {	310	sub freeze_mainloop {
260	return unless $TICK_WATCHER->is_active;	311	return unless $TICK_WATCHER->is_active;
261		312
262	my $guard = Coro::guard { $TICK_WATCHER->start };	313	my $guard = Coro::guard {
		314	$TICK_WATCHER->start;
		315	};
263	$TICK_WATCHER->stop;	316	$TICK_WATCHER->stop;
264	$guard	317	$guard
265	}	318	}
266		319
267	=item cf::async { BLOCK }	320	=item cf::async { BLOCK }
…		…
274		327
275	BEGIN { *async = \&Coro::async_pool }	328	BEGIN { *async = \&Coro::async_pool }
276		329
277	=item cf::sync_job { BLOCK }	330	=item cf::sync_job { BLOCK }
278		331
279	The design of crossfire+ requires that the main coro ($Coro::main) is	332	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
280	always able to handle events or runnable, as crossfire+ is only partly	333	is always able to handle events or runnable, as Crossfire TRT is only
281	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	334	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		335	acceptable.
282		336
283	If it must be done, put the blocking parts into C<sync_job>. This will run	337	If it must be done, put the blocking parts into C<sync_job>. This will run
284	the given BLOCK in another coroutine while waiting for the result. The	338	the given BLOCK in another coroutine while waiting for the result. The
285	server will be frozen during this time, so the block should either finish	339	server will be frozen during this time, so the block should either finish
286	fast or be very important.	340	fast or be very important.
…		…
289		343
290	sub sync_job(&) {	344	sub sync_job(&) {
291	my ($job) = @_;	345	my ($job) = @_;
292		346
293	if ($Coro::current == $Coro::main) {	347	if ($Coro::current == $Coro::main) {
		348	my $time = Event::time;
		349
294	# this is the main coro, too bad, we have to block	350	# this is the main coro, too bad, we have to block
295	# till the operation succeeds, freezing the server :/	351	# till the operation succeeds, freezing the server :/
296		352
297	# TODO: use suspend/resume instead	353	# TODO: use suspend/resume instead
298	# (but this is cancel-safe)	354	# (but this is cancel-safe)
…		…
309		365
310	while ($busy) {	366	while ($busy) {
311	Coro::cede or Event::one_event;	367	Coro::cede or Event::one_event;
312	}	368	}
313		369
		370	$time = Event::time - $time;
		371
		372	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		373	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		374
		375	$tick_start += $time; # do not account sync jobs to server load
		376
314	wantarray ? @res : $res[0]	377	wantarray ? @res : $res[0]
315	} else {	378	} else {
316	# we are in another coroutine, how wonderful, everything just works	379	# we are in another coroutine, how wonderful, everything just works
317		380
318	$job->()	381	$job->()
…		…
337	$EXT_CORO{$coro+0} = $coro;	400	$EXT_CORO{$coro+0} = $coro;
338		401
339	$coro	402	$coro
340	}	403	}
341		404
342	sub write_runtime {	405	=item fork_call { }, $args
343	return unless $TICK_WATCHER->is_active;
344		406
345	my $runtime = cf::localdir . "/runtime";	407	Executes the given code block with the given arguments in a seperate
		408	process, returning the results. Everything must be serialisable with
		409	Coro::Storable. May, of course, block. Note that the executed sub may
		410	never block itself or use any form of Event handling.
346		411
347	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	412	=cut
348	or return;
349		413
350	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	414	sub fork_call(&@) {
351	(aio_write $fh, 0, (length $value), $value, 0) <= 0	415	my ($cb, @args) = @_;
352	and return;
353		416
354	aio_fsync $fh	417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
355	and return;	418	# or die "socketpair: $!";
		419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
356		421
		422	if (my $pid = fork) {
357	close $fh	423	close $fh2;
358	or return;
359		424
360	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
361	and return;	426	$res = Coro::Storable::thaw $res;
362		427
		428	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		429
		430	die $$res unless "ARRAY" eq ref $res;
		431
		432	return wantarray ? @$res : $res->[-1];
		433	} else {
		434	reset_signals;
		435	local $SIG{__WARN__};
		436	local $SIG{__DIE__};
		437	eval {
		438	close $fh1;
		439
		440	my @res = eval { $cb->(@args) };
		441	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		442	};
		443
		444	warn $@ if $@;
		445	_exit 0;
363	1	446	}
		447	}
		448
		449	=item $value = cf::db_get $family => $key
		450
		451	Returns a single value from the environment database.
		452
		453	=item cf::db_put $family => $key => $value
		454
		455	Stores the given C<$value> in the family. It can currently store binary
		456	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		457
		458	=cut
		459
		460	our $DB;
		461
		462	sub db_init {
		463	unless ($DB) {
		464	$DB = BDB::db_create $DB_ENV;
		465
		466	cf::sync_job {
		467	eval {
		468	$DB->set_flags (BDB::CHKSUM);
		469
		470	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		471	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		472	cf::cleanup "db_open(db): $!" if $!;
		473	};
		474	cf::cleanup "db_open(db): $@" if $@;
		475	};
		476	}
		477	}
		478
		479	sub db_get($$) {
		480	my $key = "$_[0]/$_[1]";
		481
		482	cf::sync_job {
		483	BDB::db_get $DB, undef, $key, my $data;
		484
		485	$! ? ()
		486	: $data
		487	}
		488	}
		489
		490	sub db_put($$$) {
		491	BDB::dbreq_pri 4;
		492	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		493	}
		494
		495	=item cf::cache $id => [$paths...], $processversion => $process
		496
		497	Generic caching function that returns the value of the resource $id,
		498	caching and regenerating as required.
		499
		500	This function can block.
		501
		502	=cut
		503
		504	sub cache {
		505	my ($id, $src, $processversion, $process) = @_;
		506
		507	my $meta =
		508	join "\x00",
		509	$processversion,
		510	map {
		511	aio_stat $_
		512	and Carp::croak "$_: $!";
		513
		514	($_, (stat _)[7,9])
		515	} @$src;
		516
		517	my $dbmeta = db_get cache => "$id/meta";
		518	if ($dbmeta ne $meta) {
		519	# changed, we may need to process
		520
		521	my @data;
		522	my $md5;
		523
		524	for (0 .. $#$src) {
		525	0 <= aio_load $src->[$_], $data[$_]
		526	or Carp::croak "$src->[$_]: $!";
		527	}
		528
		529	# if processing is expensive, check
		530	# checksum first
		531	if (1) {
		532	$md5 =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	Coro::cede;
		537	($src->[$_], Digest::MD5::md5_hex $data[$_])
		538	} 0.. $#$src;
		539
		540
		541	my $dbmd5 = db_get cache => "$id/md5";
		542	if ($dbmd5 eq $md5) {
		543	db_put cache => "$id/meta", $meta;
		544
		545	return db_get cache => "$id/data";
		546	}
		547	}
		548
		549	my $t1 = Time::HiRes::time;
		550	my $data = $process->(\@data);
		551	my $t2 = Time::HiRes::time;
		552
		553	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		554
		555	db_put cache => "$id/data", $data;
		556	db_put cache => "$id/md5" , $md5;
		557	db_put cache => "$id/meta", $meta;
		558
		559	return $data;
		560	}
		561
		562	db_get cache => "$id/data"
		563	}
		564
		565	=item cf::datalog type => key => value, ...
		566
		567	Log a datalog packet of the given type with the given key-value pairs.
		568
		569	=cut
		570
		571	sub datalog($@) {
		572	my ($type, %kv) = @_;
		573	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
364	}	574	}
365		575
366	=back	576	=back
367		577
368	=cut	578	=cut
…		…
375	attach callbacks/event handlers (a collection of which is called an "attachment")	585	attach callbacks/event handlers (a collection of which is called an "attachment")
376	to it. All such attachable objects support the following methods.	586	to it. All such attachable objects support the following methods.
377		587
378	In the following description, CLASS can be any of C<global>, C<object>	588	In the following description, CLASS can be any of C<global>, C<object>
379	C<player>, C<client> or C<map> (i.e. the attachable objects in	589	C<player>, C<client> or C<map> (i.e. the attachable objects in
380	crossfire+).	590	Crossfire TRT).
381		591
382	=over 4	592	=over 4
383		593
384	=item $attachable->attach ($attachment, key => $value...)	594	=item $attachable->attach ($attachment, key => $value...)
385		595
…		…
499	our @CB_TYPE = (); # registry for type (cf-object class) based events	709	our @CB_TYPE = (); # registry for type (cf-object class) based events
500	our @CB_MAP = ();	710	our @CB_MAP = ();
501		711
502	my %attachment;	712	my %attachment;
503		713
		714	sub cf::attachable::thawer_merge {
		715	# simply override everything except _meta
		716	local $_[0]{_meta};
		717	%{$_[0]} = %{$_[1]};
		718	}
		719
504	sub _attach_cb($$$$) {	720	sub _attach_cb($$$$) {
505	my ($registry, $event, $prio, $cb) = @_;	721	my ($registry, $event, $prio, $cb) = @_;
506		722
507	use sort 'stable';	723	use sort 'stable';
508		724
…		…
542	$registry = $CB_TYPE[$object_type] ||= [];	758	$registry = $CB_TYPE[$object_type] ||= [];
543		759
544	} elsif ($type eq "subtype") {	760	} elsif ($type eq "subtype") {
545	defined $object_type or Carp::croak "subtype specified without type";	761	defined $object_type or Carp::croak "subtype specified without type";
546	my $object_subtype = shift @arg;	762	my $object_subtype = shift @arg;
547	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	763	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
548		764
549	} elsif ($type eq "package") {	765	} elsif ($type eq "package") {
550	my $pkg = shift @arg;	766	my $pkg = shift @arg;
551		767
552	while (my ($name, $id) = each %cb_id) {	768	while (my ($name, $id) = each %cb_id) {
…		…
581	_attach $registry, $klass, @attach;	797	_attach $registry, $klass, @attach;
582	}	798	}
583		799
584	$obj->{$name} = \%arg;	800	$obj->{$name} = \%arg;
585	} else {	801	} else {
586	warn "object uses attachment '$name' that is not available, postponing.\n";	802	warn "object uses attachment '$name' which is not available, postponing.\n";
587	}	803	}
588		804
589	$obj->{_attachment}{$name} = undef;	805	$obj->{_attachment}{$name} = undef;
590	}	806	}
591		807
…		…
593	if (ref $_[0]) {	809	if (ref $_[0]) {
594	_object_attach @_;	810	_object_attach @_;
595	} else {	811	} else {
596	_attach shift->_attach_registry, @_;	812	_attach shift->_attach_registry, @_;
597	}	813	}
		814	_recalc_want;
598	};	815	};
599		816
600	# all those should be optimised	817	# all those should be optimised
601	sub cf::attachable::detach {	818	sub cf::attachable::detach {
602	my ($obj, $name) = @_;	819	my ($obj, $name) = @_;
…		…
605	delete $obj->{_attachment}{$name};	822	delete $obj->{_attachment}{$name};
606	reattach ($obj);	823	reattach ($obj);
607	} else {	824	} else {
608	Carp::croak "cannot, currently, detach class attachments";	825	Carp::croak "cannot, currently, detach class attachments";
609	}	826	}
		827	_recalc_want;
610	};	828	};
611		829
612	sub cf::attachable::attached {	830	sub cf::attachable::attached {
613	my ($obj, $name) = @_;	831	my ($obj, $name) = @_;
614		832
…		…
679	# object support	897	# object support
680		898
681	sub reattach {	899	sub reattach {
682	# basically do the same as instantiate, without calling instantiate	900	# basically do the same as instantiate, without calling instantiate
683	my ($obj) = @_;	901	my ($obj) = @_;
		902
		903	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
684		904
685	my $registry = $obj->registry;	905	my $registry = $obj->registry;
686		906
687	@$registry = ();	907	@$registry = ();
688		908
…		…
735	$filename, length $$rdata, scalar @$objs;	955	$filename, length $$rdata, scalar @$objs;
736		956
737	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	957	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
738	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
739	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	959	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
740	aio_fsync $fh;	960	aio_fsync $fh if $cf::USE_FSYNC;
741	close $fh;	961	close $fh;
742		962
743	if (@$objs) {	963	if (@$objs) {
744	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	964	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
745	chmod SAVE_MODE, $fh;	965	chmod SAVE_MODE, $fh;
746	my $data = Storable::nfreeze { version => 1, objs => $objs };	966	my $data = Storable::nfreeze { version => 1, objs => $objs };
747	aio_write $fh, 0, (length $data), $data, 0;	967	aio_write $fh, 0, (length $data), $data, 0;
748	aio_fsync $fh;	968	aio_fsync $fh if $cf::USE_FSYNC;
749	close $fh;	969	close $fh;
750	aio_rename "$filename.pst~", "$filename.pst";	970	aio_rename "$filename.pst~", "$filename.pst";
751	}	971	}
752	} else {	972	} else {
753	aio_unlink "$filename.pst";	973	aio_unlink "$filename.pst";
…		…
785	or return;	1005	or return;
786	$av = eval { (Storable::thaw $av)->{objs} };	1006	$av = eval { (Storable::thaw $av)->{objs} };
787	}	1007	}
788		1008
789	warn sprintf "loading %s (%d)\n",	1009	warn sprintf "loading %s (%d)\n",
790	$filename, length $data, scalar @{$av || []};#d#	1010	$filename, length $data, scalar @{$av || []};
791	return ($data, $av);	1011	return ($data, $av);
792	}	1012	}
		1013
		1014	=head2 COMMAND CALLBACKS
		1015
		1016	=over 4
		1017
		1018	=cut
793		1019
794	#############################################################################	1020	#############################################################################
795	# command handling &c	1021	# command handling &c
796		1022
797	=item cf::register_command $name => \&callback($ob,$args);	1023	=item cf::register_command $name => \&callback($ob,$args);
…		…
810	push @{ $COMMAND{$name} }, [$caller, $cb];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
811	}	1037	}
812		1038
813	=item cf::register_extcmd $name => \&callback($pl,$packet);	1039	=item cf::register_extcmd $name => \&callback($pl,$packet);
814		1040
815	Register a callbackf ro execution when the client sends an extcmd packet.	1041	Register a callback for execution when the client sends an (synchronous)
		1042	extcmd packet. Ext commands will be processed in the order they are
		1043	received by the server, like other user commands. The first argument is
		1044	the logged-in player. Ext commands can only be processed after a player
		1045	has logged in successfully.
816		1046
817	If the callback returns something, it is sent back as if reply was being	1047	If the callback returns something, it is sent back as if reply was being
818	called.	1048	called.
819		1049
		1050	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1051
		1052	Register a callback for execution when the client sends an (asynchronous)
		1053	exticmd packet. Exti commands are processed by the server as soon as they
		1054	are received, i.e. out of order w.r.t. other commands. The first argument
		1055	is a client socket. Exti commands can be received anytime, even before
		1056	log-in.
		1057
		1058	If the callback returns something, it is sent back as if reply was being
		1059	called.
		1060
820	=cut	1061	=cut
821		1062
822	sub register_extcmd {	1063	sub register_extcmd {
823	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
824		1065
825	$EXTCMD{$name} = $cb;	1066	$EXTCMD{$name} = $cb;
		1067	}
		1068
		1069	sub register_exticmd {
		1070	my ($name, $cb) = @_;
		1071
		1072	$EXTICMD{$name} = $cb;
826	}	1073	}
827		1074
828	cf::player->attach (	1075	cf::player->attach (
829	on_command => sub {	1076	on_command => sub {
830	my ($pl, $name, $params) = @_;	1077	my ($pl, $name, $params) = @_;
…		…
855		1102
856	cf::override;	1103	cf::override;
857	},	1104	},
858	);	1105	);
859		1106
860	sub load_extension {
861	my ($path) = @_;
862
863	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
864	my $base = $1;
865	my $pkg = $1;
866	$pkg =~ s/[^[:word:]]/_/g;
867	$pkg = "ext::$pkg";
868
869	warn "... loading '$path' into '$pkg'\n";
870
871	open my $fh, "<:utf8", $path
872	or die "$path: $!";
873
874	my $source =
875	"package $pkg; use strict; use utf8;\n"
876	. "#line 1 \"$path\"\n{\n"
877	. (do { local $/; <$fh> })
878	. "\n};\n1";
879
880	unless (eval $source) {
881	my $msg = $@ ? "$path: $@\n"
882	: "extension disabled.\n";
883	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
884	warn $@;
885	warn "mandatory extension failed to load, exiting.\n";
886	exit 1;
887	}
888	die $@;
889	}
890
891	push @EXTS, $pkg;
892	}
893
894	sub load_extensions {	1107	sub load_extensions {
		1108	cf::sync_job {
		1109	my %todo;
		1110
895	for my $ext (<$LIBDIR/*.ext>) {	1111	for my $path (<$LIBDIR/*.ext>) {
896	next unless -r $ext;	1112	next unless -r $path;
897	eval {	1113
898	load_extension $ext;	1114	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1115	my $base = $1;
		1116	my $pkg = $1;
		1117	$pkg =~ s/[^[:word:]]/_/g;
		1118	$pkg = "ext::$pkg";
		1119
		1120	open my $fh, "<:utf8", $path
		1121	or die "$path: $!";
		1122
		1123	my $source = do { local $/; <$fh> };
		1124
		1125	my %ext = (
		1126	path => $path,
		1127	base => $base,
		1128	pkg => $pkg,
		1129	);
		1130
		1131	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1132	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1133
		1134	$ext{source} =
		1135	"package $pkg; use strict; use utf8;\n"
		1136	. "#line 1 \"$path\"\n{\n"
		1137	. $source
		1138	. "\n};\n1";
		1139
		1140	$todo{$base} = \%ext;
		1141	}
		1142
		1143	my %done;
		1144	while (%todo) {
		1145	my $progress;
		1146
		1147	while (my ($k, $v) = each %todo) {
		1148	for (split /,\s*/, $v->{meta}{depends}) {
		1149	goto skip
		1150	unless exists $done{$_};
		1151	}
		1152
		1153	warn "... loading '$k' into '$v->{pkg}'\n";
		1154
		1155	unless (eval $v->{source}) {
		1156	my $msg = $@ ? "$v->{path}: $@\n"
		1157	: "$v->{base}: extension inactive.\n";
		1158
		1159	if (exists $v->{meta}{mandatory}) {
		1160	warn $msg;
		1161	warn "mandatory extension failed to load, exiting.\n";
		1162	exit 1;
		1163	}
		1164
		1165	warn $msg;
		1166	}
		1167
		1168	$done{$k} = delete $todo{$k};
		1169	push @EXTS, $v->{pkg};
		1170	$progress = 1;
899	1	1171	}
900	} or warn "$ext not loaded: $@";	1172
		1173	skip:
		1174	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1175	unless $progress;
		1176	}
901	}	1177	};
902	}	1178	}
903		1179
904	#############################################################################	1180	#############################################################################
905	# load/save/clean perl data associated with a map
906		1181
907	*cf::mapsupport::on_clean = sub {	1182	=back
908	my ($map) = @_;
909
910	my $path = $map->tmpname;
911	defined $path or return;
912
913	unlink "$path.pst";
914	};
915
916	cf::map->attach (prio => -10000, package => cf::mapsupport::);
917
918	#############################################################################
919		1183
920	=head2 CORE EXTENSIONS	1184	=head2 CORE EXTENSIONS
921		1185
922	Functions and methods that extend core crossfire objects.	1186	Functions and methods that extend core crossfire objects.
923		1187
…		…
936	Returns the given player object, loading it if necessary (might block).	1200	Returns the given player object, loading it if necessary (might block).
937		1201
938	=cut	1202	=cut
939		1203
940	sub playerdir($) {	1204	sub playerdir($) {
941	cf::localdir	1205	"$PLAYERDIR/"
942	. "/"
943	. cf::playerdir
944	. "/"
945	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1206	. (ref $_[0] ? $_[0]->ob->name : $_[0])
946	}	1207	}
947		1208
948	sub path($) {	1209	sub path($) {
949	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1210	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
950		1211
951	(playerdir $login) . "/$login.pl"	1212	(playerdir $login) . "/playerdata"
952	}	1213	}
953		1214
954	sub find_active($) {	1215	sub find_active($) {
955	$cf::PLAYER{$_[0]}	1216	$cf::PLAYER{$_[0]}
956	and $cf::PLAYER{$_[0]}->active	1217	and $cf::PLAYER{$_[0]}->active
…		…
959		1220
960	sub exists($) {	1221	sub exists($) {
961	my ($login) = @_;	1222	my ($login) = @_;
962		1223
963	$cf::PLAYER{$login}	1224	$cf::PLAYER{$login}
964	or cf::sync_job { !aio_stat $login }	1225	or cf::sync_job { !aio_stat path $login }
965	}	1226	}
966		1227
967	sub find($) {	1228	sub find($) {
968	return $cf::PLAYER{$_[0]} || do {	1229	return $cf::PLAYER{$_[0]} || do {
969	my $login = $_[0];	1230	my $login = $_[0];
970		1231
971	my $guard = cf::lock_acquire "user_find:$login";	1232	my $guard = cf::lock_acquire "user_find:$login";
972		1233
973	$cf::PLAYER{$_[0]} || do {	1234	$cf::PLAYER{$_[0]} || do {
		1235	# rename old playerfiles to new ones
		1236	#TODO: remove when no longer required
		1237	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1238	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1239	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1240	aio_unlink +(playerdir $login) . "/$login.pl";
		1241
974	my $pl = load_pl path $login	1242	my $pl = load_pl path $login
975	or return;	1243	or return;
976	$cf::PLAYER{$login} = $pl	1244	$cf::PLAYER{$login} = $pl
977	}	1245	}
978	}	1246	}
…		…
1015		1283
1016	=cut	1284	=cut
1017		1285
1018	sub quit_character {	1286	sub quit_character {
1019	my ($pl) = @_;	1287	my ($pl) = @_;
		1288
		1289	my $name = $pl->ob->name;
1020		1290
1021	$pl->{deny_save} = 1;	1291	$pl->{deny_save} = 1;
1022	$pl->password ("*"); # this should lock out the player until we nuked the dir	1292	$pl->password ("*"); # this should lock out the player until we nuked the dir
1023		1293
1024	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1294	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1029	my $path = playerdir $pl;	1299	my $path = playerdir $pl;
1030	my $temp = "$path~$cf::RUNTIME~deleting~";	1300	my $temp = "$path~$cf::RUNTIME~deleting~";
1031	aio_rename $path, $temp;	1301	aio_rename $path, $temp;
1032	delete $cf::PLAYER{$pl->ob->name};	1302	delete $cf::PLAYER{$pl->ob->name};
1033	$pl->destroy;	1303	$pl->destroy;
		1304
		1305	my $prefix = qr<^~\Q$name\E/>;
		1306
		1307	# nuke player maps
		1308	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1309
1034	IO::AIO::aio_rmtree $temp;	1310	IO::AIO::aio_rmtree $temp;
		1311	}
		1312
		1313	=item $pl->kick
		1314
		1315	Kicks a player out of the game. This destroys the connection.
		1316
		1317	=cut
		1318
		1319	sub kick {
		1320	my ($pl, $kicker) = @_;
		1321
		1322	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1323	$pl->killer ("kicked");
		1324	$pl->ns->destroy;
1035	}	1325	}
1036		1326
1037	=item cf::player::list_logins	1327	=item cf::player::list_logins
1038		1328
1039	Returns am arrayref of all valid playernames in the system, can take a	1329	Returns am arrayref of all valid playernames in the system, can take a
1040	while and may block, so not sync_job-capable, ever.	1330	while and may block, so not sync_job-capable, ever.
1041		1331
1042	=cut	1332	=cut
1043		1333
1044	sub list_logins {	1334	sub list_logins {
1045	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1335	my $dirs = aio_readdir $PLAYERDIR
1046	or return [];	1336	or return [];
1047		1337
1048	my @logins;	1338	my @logins;
1049		1339
1050	for my $login (@$dirs) {	1340	for my $login (@$dirs) {
…		…
1067	=cut	1357	=cut
1068		1358
1069	sub maps($) {	1359	sub maps($) {
1070	my ($pl) = @_;	1360	my ($pl) = @_;
1071		1361
		1362	$pl = ref $pl ? $pl->ob->name : $pl;
		1363
1072	my $files = aio_readdir playerdir $pl	1364	my $files = aio_readdir playerdir $pl
1073	or return;	1365	or return;
1074		1366
1075	my @paths;	1367	my @paths;
1076		1368
1077	for (@$files) {	1369	for (@$files) {
1078	utf8::decode $_;	1370	utf8::decode $_;
1079	next if /\.(?:pl|pst)$/;	1371	next if /\.(?:pl|pst)$/;
1080	next unless /^$PATH_SEP/o;	1372	next unless /^$PATH_SEP/o;
1081		1373
1082	push @paths, "~" . $pl->ob->name . "/" . $_;	1374	push @paths, cf::map::normalise "~$pl/$_";
1083	}	1375	}
1084		1376
1085	\@paths	1377	\@paths
1086	}	1378	}
1087		1379
		1380	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1381
		1382	Expand crossfire pod fragments into protocol xml.
		1383
		1384	=cut
		1385
		1386	sub expand_cfpod {
		1387	((my $self), (local $_)) = @_;
		1388
		1389	# escape & and <
		1390	s/&/&amp;/g;
		1391	s/(?<![BIUGH])</&lt;/g;
		1392
		1393	# this is buggy, it needs to properly take care of nested <'s
		1394
		1395	1 while
		1396	# replace B<>, I<>, U<> etc.
		1397	s/B<([^\>]*)>/<b>$1<\/b>/
		1398	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1399	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1400	# replace G<male|female> tags
		1401	|| s{G<([^>|]*)\|([^>]*)>}{
		1402	$self->gender ? $2 : $1
		1403	}ge
		1404	# replace H<hint text>
		1405	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1406
		1407	# create single paragraphs (very hackish)
		1408	s/(?<=\S)\n(?=\w)/ /g;
		1409
		1410	$_
		1411	}
		1412
1088	=item $player->ext_reply ($msgid, $msgtype, %msg)	1413	=item $player->ext_reply ($msgid, %msg)
1089		1414
1090	Sends an ext reply to the player.	1415	Sends an ext reply to the player.
1091		1416
1092	=cut	1417	=cut
1093		1418
1094	sub ext_reply($$$%) {	1419	sub ext_reply($$%) {
1095	my ($self, $id, %msg) = @_;	1420	my ($self, $id, %msg) = @_;
1096		1421
1097	$msg{msgid} = $id;	1422	$msg{msgid} = $id;
1098
1099	$self->send ("ext " . cf::to_json \%msg);	1423	$self->send ("ext " . cf::to_json \%msg);
1100	}	1424	}
1101		1425
1102	package cf;	1426	=item $player->ext_event ($type, %msg)
		1427
		1428	Sends an ext event to the client.
		1429
		1430	=cut
		1431
		1432	sub ext_event($$%) {
		1433	my ($self, $type, %msg) = @_;
		1434
		1435	$self->ns->ext_event ($type, %msg);
		1436	}
		1437
		1438	=head3 cf::region
		1439
		1440	=over 4
		1441
		1442	=cut
		1443
		1444	package cf::region;
		1445
		1446	=item cf::region::find_by_path $path
		1447
		1448	Tries to decuce the likely region for a map knowing only its path.
		1449
		1450	=cut
		1451
		1452	sub find_by_path($) {
		1453	my ($path) = @_;
		1454
		1455	my ($match, $specificity);
		1456
		1457	for my $region (list) {
		1458	if ($region->match && $path =~ $region->match) {
		1459	($match, $specificity) = ($region, $region->specificity)
		1460	if $region->specificity > $specificity;
		1461	}
		1462	}
		1463
		1464	$match
		1465	}
1103		1466
1104	=back	1467	=back
1105
1106		1468
1107	=head3 cf::map	1469	=head3 cf::map
1108		1470
1109	=over 4	1471	=over 4
1110		1472
…		…
1114		1476
1115	use Fcntl;	1477	use Fcntl;
1116	use Coro::AIO;	1478	use Coro::AIO;
1117		1479
1118	use overload	1480	use overload
1119	'""' => \&as_string;	1481	'""' => \&as_string,
		1482	fallback => 1;
1120		1483
1121	our $MAX_RESET = 3600;	1484	our $MAX_RESET = 3600;
1122	our $DEFAULT_RESET = 3000;	1485	our $DEFAULT_RESET = 3000;
1123		1486
1124	sub generate_random_map {	1487	sub generate_random_map {
1125	my ($self, $rmp) = @_;	1488	my ($self, $rmp) = @_;
1126
1127	# mit "rum" bekleckern, nicht	1489	# mit "rum" bekleckern, nicht
1128	$self->_create_random_map (	1490	$self->_create_random_map (
1129	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1491	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1130	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1492	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1131	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1493	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1138	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1500	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1139	(cf::region::find $rmp->{region}), $rmp->{custom}	1501	(cf::region::find $rmp->{region}), $rmp->{custom}
1140	)	1502	)
1141	}	1503	}
1142		1504
		1505	=item cf::map->register ($regex, $prio)
		1506
		1507	Register a handler for the map path matching the given regex at the
		1508	givne priority (higher is better, built-in handlers have priority 0, the
		1509	default).
		1510
		1511	=cut
		1512
1143	sub register {	1513	sub register {
1144	my (undef, $regex) = @_;	1514	my (undef, $regex, $prio) = @_;
1145	my $pkg = caller;	1515	my $pkg = caller;
1146		1516
1147	no strict;	1517	no strict;
1148	push @{"$pkg\::ISA"}, __PACKAGE__;	1518	push @{"$pkg\::ISA"}, __PACKAGE__;
1149		1519
1150	$EXT_MAP{$pkg} = qr<$regex>;	1520	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1151	}	1521	}
1152		1522
1153	# also paths starting with '/'	1523	# also paths starting with '/'
1154	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1524	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1525
		1526	sub thawer_merge {
		1527	my ($self, $merge) = @_;
		1528
		1529	# we have to keep some variables in memory intact
		1530	local $self->{path};
		1531	local $self->{load_path};
		1532
		1533	$self->SUPER::thawer_merge ($merge);
		1534	}
1155		1535
1156	sub normalise {	1536	sub normalise {
1157	my ($path, $base) = @_;	1537	my ($path, $base) = @_;
		1538
		1539	$path = "$path"; # make sure its a string
		1540
		1541	$path =~ s/\.map$//;
1158		1542
1159	# map plan:	1543	# map plan:
1160	#	1544	#
1161	# /! non-realised random map exit (special hack!)	1545	# /! non-realised random map exit (special hack!)
1162	# {... are special paths that are not being touched	1546	# {... are special paths that are not being touched
…		…
1190		1574
1191	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1575	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1192		1576
1193	$path = normalise $path, $base;	1577	$path = normalise $path, $base;
1194		1578
1195	for my $pkg (keys %EXT_MAP) {	1579	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1196	if ($path =~ $EXT_MAP{$pkg}) {	1580	if ($path =~ $EXT_MAP{$pkg}[1]) {
1197	my $self = bless cf::map::new, $pkg;	1581	my $self = bless cf::map::new, $pkg;
1198	$self->{path} = $path; $self->path ($path);	1582	$self->{path} = $path; $self->path ($path);
1199	$self->init; # pass $1 etc.	1583	$self->init; # pass $1 etc.
1200	return $self;	1584	return $self;
1201	}	1585	}
1202	}	1586	}
1203		1587
1204	Carp::carp "unable to resolve path '$path'.";	1588	Carp::carp "unable to resolve path '$path' (base '$base').";
1205	()	1589	()
1206	}	1590	}
1207		1591
1208	sub init {	1592	sub init {
1209	my ($self) = @_;	1593	my ($self) = @_;
…		…
1220	# the displayed name, this is a one way mapping	1604	# the displayed name, this is a one way mapping
1221	sub visible_name {	1605	sub visible_name {
1222	&as_string	1606	&as_string
1223	}	1607	}
1224		1608
1225	# escape the /'s in the path
1226	sub _escaped_path {
1227	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1228
1229	$path
1230	}
1231
1232	# the original (read-only) location	1609	# the original (read-only) location
1233	sub load_path {	1610	sub load_path {
1234	my ($self) = @_;	1611	my ($self) = @_;
1235		1612
1236	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1613	"$MAPDIR/$self->{path}.map"
1237	}	1614	}
1238		1615
1239	# the temporary/swap location	1616	# the temporary/swap location
1240	sub save_path {	1617	sub save_path {
1241	my ($self) = @_;	1618	my ($self) = @_;
1242		1619
1243	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $self->_escaped_path	1620	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1621	"$TMPDIR/$path.map"
1244	}	1622	}
1245		1623
1246	# the unique path, undef == no special unique path	1624	# the unique path, undef == no special unique path
1247	sub uniq_path {	1625	sub uniq_path {
1248	my ($self) = @_;	1626	my ($self) = @_;
1249		1627
1250	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path	1628	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1629	"$UNIQUEDIR/$path"
1251	}	1630	}
1252		1631
1253	# and all this just because we cannot iterate over	1632	# and all this just because we cannot iterate over
1254	# all maps in C++...	1633	# all maps in C++...
1255	sub change_all_map_light {	1634	sub change_all_map_light {
…		…
1257		1636
1258	$_->change_map_light ($change)	1637	$_->change_map_light ($change)
1259	for grep $_->outdoor, values %cf::MAP;	1638	for grep $_->outdoor, values %cf::MAP;
1260	}	1639	}
1261		1640
		1641	sub decay_objects {
		1642	my ($self) = @_;
		1643
		1644	return if $self->{deny_reset};
		1645
		1646	$self->do_decay_objects;
		1647	}
		1648
1262	sub unlink_save {	1649	sub unlink_save {
1263	my ($self) = @_;	1650	my ($self) = @_;
1264		1651
1265	utf8::encode (my $save = $self->save_path);	1652	utf8::encode (my $save = $self->save_path);
1266	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;	1653	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1267	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";	1654	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1268	}	1655	}
1269		1656
1270	sub load_header_from($) {	1657	sub load_header_from($) {
1271	my ($self, $path) = @_;	1658	my ($self, $path) = @_;
1272		1659
1273	utf8::encode $path;	1660	utf8::encode $path;
1274	aio_open $path, O_RDONLY, 0	1661	#aio_open $path, O_RDONLY, 0
1275	or return;	1662	# or return;
1276		1663
1277	$self->_load_header ($path)	1664	$self->_load_header ($path)
1278	or return;	1665	or return;
1279		1666
1280	$self->{load_path} = $path;	1667	$self->{load_path} = $path;
1281		1668
1282	1	1669	1
1283	}	1670	}
1284		1671
1285	sub load_orig {	1672	sub load_header_orig {
1286	my ($self) = @_;	1673	my ($self) = @_;
1287		1674
1288	$self->load_header_from ($self->load_path)	1675	$self->load_header_from ($self->load_path)
1289	}	1676	}
1290		1677
1291	sub load_temp {	1678	sub load_header_temp {
1292	my ($self) = @_;	1679	my ($self) = @_;
1293		1680
1294	$self->load_header_from ($self->save_path)	1681	$self->load_header_from ($self->save_path)
		1682	}
		1683
		1684	sub prepare_temp {
		1685	my ($self) = @_;
		1686
		1687	$self->last_access ((delete $self->{last_access})
		1688	|| $cf::RUNTIME); #d#
		1689	# safety
		1690	$self->{instantiate_time} = $cf::RUNTIME
		1691	if $self->{instantiate_time} > $cf::RUNTIME;
		1692	}
		1693
		1694	sub prepare_orig {
		1695	my ($self) = @_;
		1696
		1697	$self->{load_original} = 1;
		1698	$self->{instantiate_time} = $cf::RUNTIME;
		1699	$self->last_access ($cf::RUNTIME);
		1700	$self->instantiate;
1295	}	1701	}
1296		1702
1297	sub load_header {	1703	sub load_header {
1298	my ($self) = @_;	1704	my ($self) = @_;
1299		1705
1300	if ($self->load_temp) {	1706	if ($self->load_header_temp) {
1301	$self->last_access ((delete $self->{last_access})	1707	$self->prepare_temp;
1302	|| $cf::RUNTIME); #d#
1303	# safety
1304	$self->{instantiate_time} = $cf::RUNTIME
1305	if $self->{instantiate_time} > $cf::RUNTIME;
1306	} else {	1708	} else {
1307	$self->load_orig	1709	$self->load_header_orig
1308	or return;	1710	or return;
1309		1711	$self->prepare_orig;
1310	$self->{load_original} = 1;
1311	$self->{instantiate_time} = $cf::RUNTIME;
1312	$self->last_access ($cf::RUNTIME);
1313	$self->instantiate;
1314	}	1712	}
		1713
		1714	$self->{deny_reset} = 1
		1715	if $self->no_reset;
		1716
		1717	$self->default_region (cf::region::find_by_path $self->{path})
		1718	unless $self->default_region;
1315		1719
1316	1	1720	1
1317	}	1721	}
1318		1722
1319	sub find;	1723	sub find;
…		…
1332	$map->{last_save} = $cf::RUNTIME;	1736	$map->{last_save} = $cf::RUNTIME;
1333		1737
1334	$map->load_header	1738	$map->load_header
1335	or return;	1739	or return;
1336		1740
1337	if ($map->should_reset) {	1741	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1742	# doing this can freeze the server in a sync job, obviously
		1743	#$cf::WAIT_FOR_TICK->wait;
1338	$map->reset;	1744	$map->reset;
1339	undef $guard;	1745	undef $guard;
1340	$map = find $path	1746	return find $path;
1341	or return;
1342	}	1747	}
1343		1748
1344	$cf::MAP{$path} = $map	1749	$cf::MAP{$path} = $map
1345	}	1750	}
1346	}	1751	}
		1752
		1753	sub pre_load { }
		1754	sub post_load { }
1347		1755
1348	sub load {	1756	sub load {
1349	my ($self) = @_;	1757	my ($self) = @_;
1350		1758
		1759	local $self->{deny_reset} = 1; # loading can take a long time
		1760
1351	my $path = $self->{path};	1761	my $path = $self->{path};
		1762
		1763	{
1352	my $guard = cf::lock_acquire "map_load:$path";	1764	my $guard = cf::lock_acquire "map_load:$path";
1353		1765
1354	return if $self->in_memory != cf::MAP_SWAPPED;	1766	return if $self->in_memory != cf::MAP_SWAPPED;
1355		1767
1356	$self->in_memory (cf::MAP_LOADING);	1768	$self->in_memory (cf::MAP_LOADING);
1357		1769
1358	$self->alloc;	1770	$self->alloc;
1359	$self->_load_objects ($self->{load_path}, 1)
1360	or return;
1361		1771
1362	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1772	$self->pre_load;
1363	if delete $self->{load_original};
1364
1365	if (my $uniq = $self->uniq_path) {
1366	utf8::encode $uniq;
1367	if (aio_open $uniq, O_RDONLY, 0) {
1368	$self->clear_unique_items;
1369	$self->_load_objects ($uniq, 0);
1370	}
1371	}
1372
1373	Coro::cede;
1374
1375	# now do the right thing for maps
1376	$self->link_multipart_objects;
1377
1378	unless ($self->{deny_activate}) {
1379	$self->decay_objects;
1380	$self->fix_auto_apply;
1381	$self->update_buttons;
1382	Coro::cede;	1773	Coro::cede;
1383	$self->set_darkness_map;	1774
		1775	$self->_load_objects ($self->{load_path}, 1)
		1776	or return;
		1777
		1778	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1779	if delete $self->{load_original};
		1780
		1781	if (my $uniq = $self->uniq_path) {
		1782	utf8::encode $uniq;
		1783	if (aio_open $uniq, O_RDONLY, 0) {
		1784	$self->clear_unique_items;
		1785	$self->_load_objects ($uniq, 0);
		1786	}
		1787	}
		1788
		1789	Coro::cede;
		1790	# now do the right thing for maps
		1791	$self->link_multipart_objects;
1384	$self->difficulty ($self->estimate_difficulty)	1792	$self->difficulty ($self->estimate_difficulty)
1385	unless $self->difficulty;	1793	unless $self->difficulty;
1386	Coro::cede;	1794	Coro::cede;
		1795
		1796	unless ($self->{deny_activate}) {
		1797	$self->decay_objects;
		1798	$self->fix_auto_apply;
		1799	$self->update_buttons;
		1800	Coro::cede;
		1801	$self->set_darkness_map;
		1802	Coro::cede;
1387	$self->activate;	1803	$self->activate;
1388	}	1804	}
1389		1805
1390	$self->in_memory (cf::MAP_IN_MEMORY);	1806	$self->in_memory (cf::MAP_IN_MEMORY);
		1807	}
		1808
		1809	$self->post_load;
1391	}	1810	}
1392		1811
1393	sub customise_for {	1812	sub customise_for {
1394	my ($self, $ob) = @_;	1813	my ($self, $ob) = @_;
1395		1814
1396	return find "~" . $ob->name . "/" . $self->{path}	1815	return find "~" . $ob->name . "/" . $self->{path}
1397	if $self->per_player;	1816	if $self->per_player;
		1817
		1818	# return find "?party/" . $ob->name . "/" . $self->{path}
		1819	# if $self->per_party;
1398		1820
1399	$self	1821	$self
1400	}	1822	}
1401		1823
1402	# find and load all maps in the 3x3 area around a map	1824	# find and load all maps in the 3x3 area around a map
…		…
1434		1856
1435	cf::sync_job { $map->load };	1857	cf::sync_job { $map->load };
1436	}	1858	}
1437		1859
1438	our %MAP_PREFETCH;	1860	our %MAP_PREFETCH;
1439	our $MAP_PREFETCHER = Coro::async {	1861	our $MAP_PREFETCHER = undef;
1440	while () {
1441	for my $path (keys %MAP_PREFETCH) {
1442	my $map = find $path
1443	or next;
1444	$map->load;
1445
1446	delete $MAP_PREFETCH{$path};
1447	}
1448	Coro::schedule;
1449	}
1450	};
1451		1862
1452	sub find_async {	1863	sub find_async {
1453	my ($path, $origin) = @_;	1864	my ($path, $origin) = @_;
1454		1865
1455	$path = normalise $path, $origin && $origin->{path};	1866	$path = normalise $path, $origin && $origin->{path};
1456		1867
1457	if (my $map = $cf::MAP{$path}) {	1868	if (my $map = $cf::MAP{$path}) {
1458	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1869	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1459	}	1870	}
1460		1871
1461	$MAP_PREFETCH{$path} = 0;	1872	undef $MAP_PREFETCH{$path};
		1873	$MAP_PREFETCHER ||= cf::async {
		1874	while (%MAP_PREFETCH) {
		1875	for my $path (keys %MAP_PREFETCH) {
		1876	my $map = find $path
		1877	or next;
		1878	$map->load;
		1879
		1880	delete $MAP_PREFETCH{$path};
		1881	}
		1882	}
		1883	undef $MAP_PREFETCHER;
		1884	};
1462	$MAP_PREFETCHER->ready;	1885	$MAP_PREFETCHER->prio (6);
1463		1886
1464	()	1887	()
1465	}	1888	}
1466		1889
1467	sub save {	1890	sub save {
…		…
1512		1935
1513	sub reset_at {	1936	sub reset_at {
1514	my ($self) = @_;	1937	my ($self) = @_;
1515		1938
1516	# TODO: safety, remove and allow resettable per-player maps	1939	# TODO: safety, remove and allow resettable per-player maps
1517	return 1e99 if $self->isa ("ext::map_per_player");
1518	return 1e99 if $self->{deny_reset};	1940	return 1e99 if $self->{deny_reset};
1519		1941
1520	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1942	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1521	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1943	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1522		1944
…		…
1527	my ($self) = @_;	1949	my ($self) = @_;
1528		1950
1529	$self->reset_at <= $cf::RUNTIME	1951	$self->reset_at <= $cf::RUNTIME
1530	}	1952	}
1531		1953
1532	sub rename {
1533	my ($self, $new_path) = @_;
1534
1535	normalise $new_path;
1536
1537	$self->unlink_save;
1538
1539	delete $cf::MAP{$self->path};
1540	$self->{path} = $new_path; $self->path ($self->{path});
1541	$cf::MAP{$self->path} = $self;
1542
1543	$self->save;
1544	}
1545
1546	sub reset {	1954	sub reset {
1547	my ($self) = @_;	1955	my ($self) = @_;
1548		1956
1549	my $lock = cf::lock_acquire "map_data:" . $self->path;	1957	my $lock = cf::lock_acquire "map_data:$self->{path}";
1550		1958
1551	return if $self->players;	1959	return if $self->players;
1552	return if $self->isa ("ext::map_per_player");#d#
1553		1960
1554	warn "resetting map ", $self->path;#d#	1961	warn "resetting map ", $self->path;
		1962
		1963	$self->in_memory (cf::MAP_SWAPPED);
		1964
		1965	# need to save uniques path
		1966	unless ($self->{deny_save}) {
		1967	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1968
		1969	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1970	if $uniq;
		1971	}
1555		1972
1556	delete $cf::MAP{$self->path};	1973	delete $cf::MAP{$self->path};
		1974
		1975	$self->clear;
1557		1976
1558	$_->clear_links_to ($self) for values %cf::MAP;	1977	$_->clear_links_to ($self) for values %cf::MAP;
1559		1978
1560	$self->unlink_save;	1979	$self->unlink_save;
1561	$self->destroy;	1980	$self->destroy;
…		…
1564	my $nuke_counter = "aaaa";	1983	my $nuke_counter = "aaaa";
1565		1984
1566	sub nuke {	1985	sub nuke {
1567	my ($self) = @_;	1986	my ($self) = @_;
1568		1987
		1988	delete $cf::MAP{$self->path};
		1989
		1990	$self->unlink_save;
		1991
		1992	bless $self, "cf::map";
		1993	delete $self->{deny_reset};
1569	$self->{deny_save} = 1;	1994	$self->{deny_save} = 1;
1570	$self->reset_timeout (1);	1995	$self->reset_timeout (1);
1571	$self->rename ("{nuke}/" . ($nuke_counter++));	1996	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1997
		1998	$cf::MAP{$self->path} = $self;
		1999
1572	$self->reset; # polite request, might not happen	2000	$self->reset; # polite request, might not happen
		2001	}
		2002
		2003	=item $maps = cf::map::tmp_maps
		2004
		2005	Returns an arrayref with all map paths of currently instantiated and saved
		2006	maps. May block.
		2007
		2008	=cut
		2009
		2010	sub tmp_maps() {
		2011	[
		2012	map {
		2013	utf8::decode $_;
		2014	/\.map$/
		2015	? normalise $_
		2016	: ()
		2017	} @{ aio_readdir $TMPDIR or [] }
		2018	]
		2019	}
		2020
		2021	=item $maps = cf::map::random_maps
		2022
		2023	Returns an arrayref with all map paths of currently instantiated and saved
		2024	random maps. May block.
		2025
		2026	=cut
		2027
		2028	sub random_maps() {
		2029	[
		2030	map {
		2031	utf8::decode $_;
		2032	/\.map$/
		2033	? normalise "?random/$_"
		2034	: ()
		2035	} @{ aio_readdir $RANDOMDIR or [] }
		2036	]
1573	}	2037	}
1574		2038
1575	=item cf::map::unique_maps	2039	=item cf::map::unique_maps
1576		2040
1577	Returns an arrayref of paths of all shared maps that have	2041	Returns an arrayref of paths of all shared maps that have
1578	instantiated unique items. May block.	2042	instantiated unique items. May block.
1579		2043
1580	=cut	2044	=cut
1581		2045
1582	sub unique_maps() {	2046	sub unique_maps() {
1583	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2047	[
1584	or return;	2048	map {
1585
1586	my @paths;
1587
1588	for (@$files) {
1589	utf8::decode $_;	2049	utf8::decode $_;
1590	next if /\.pst$/;	2050	/\.map$/
1591	next unless /^$PATH_SEP/o;	2051	? normalise $_
1592		2052	: ()
1593	push @paths, $_;	2053	} @{ aio_readdir $UNIQUEDIR or [] }
1594	}	2054	]
1595
1596	\@paths
1597	}	2055	}
1598		2056
1599	package cf;	2057	package cf;
1600		2058
1601	=back	2059	=back
…		…
1647		2105
1648	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2106	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1649		2107
1650	if ($self->{record_replies}) {	2108	if ($self->{record_replies}) {
1651	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2109	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2110
1652	} else {	2111	} else {
		2112	my $pl = $self->contr;
		2113
		2114	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2115	my $diag = $pl->{npc_dialog};
		2116	$diag->{pl}->ext_reply (
		2117	$diag->{id},
		2118	msgtype => "reply",
		2119	msg => $diag->{pl}->expand_cfpod ($msg),
		2120	add_topics => []
		2121	);
		2122
		2123	} else {
1653	$msg = $npc->name . " says: $msg" if $npc;	2124	$msg = $npc->name . " says: $msg" if $npc;
1654	$self->message ($msg, $flags);	2125	$self->message ($msg, $flags);
		2126	}
1655	}	2127	}
1656	}	2128	}
1657		2129
1658	=item $player_object->may ("access")	2130	=item $player_object->may ("access")
1659		2131
…		…
1692	=cut	2164	=cut
1693		2165
1694	sub link_map {	2166	sub link_map {
1695	unless ($LINK_MAP) {	2167	unless ($LINK_MAP) {
1696	$LINK_MAP = cf::map::find "{link}"	2168	$LINK_MAP = cf::map::find "{link}"
1697	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2169	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1698	$LINK_MAP->load;	2170	$LINK_MAP->load;
1699	}	2171	}
1700		2172
1701	$LINK_MAP	2173	$LINK_MAP
1702	}	2174	}
…		…
1707	$self->deactivate_recursive;	2179	$self->deactivate_recursive;
1708		2180
1709	return if UNIVERSAL::isa $self->map, "ext::map_link";	2181	return if UNIVERSAL::isa $self->map, "ext::map_link";
1710		2182
1711	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2183	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1712	if $self->map;	2184	if $self->map && $self->map->{path} ne "{link}";
1713		2185
1714	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2186	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1715	}	2187	}
1716		2188
1717	sub cf::object::player::leave_link {	2189	sub cf::object::player::leave_link {
1718	my ($self, $map, $x, $y) = @_;	2190	my ($self, $map, $x, $y) = @_;
		2191
		2192	return unless $self->contr->active;
1719		2193
1720	my $link_pos = delete $self->{_link_pos};	2194	my $link_pos = delete $self->{_link_pos};
1721		2195
1722	unless ($map) {	2196	unless ($map) {
1723	# restore original map position	2197	# restore original map position
…		…
1741	$map->load;	2215	$map->load;
1742	$map->load_diag;	2216	$map->load_diag;
1743		2217
1744	return unless $self->contr->active;	2218	return unless $self->contr->active;
1745	$self->activate_recursive;	2219	$self->activate_recursive;
		2220
		2221	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1746	$self->enter_map ($map, $x, $y);	2222	$self->enter_map ($map, $x, $y);
1747	}	2223	}
1748		2224
1749	cf::player->attach (
1750	on_logout => sub {
1751	my ($pl) = @_;
1752
1753	# abort map switching before logout
1754	if ($pl->ob->{_link_pos}) {
1755	cf::sync_job {
1756	$pl->ob->leave_link
1757	};
1758	}
1759	},
1760	on_login => sub {
1761	my ($pl) = @_;
1762
1763	# try to abort aborted map switching on player login :)
1764	# should happen only on crashes
1765	if ($pl->ob->{_link_pos}) {
1766	$pl->ob->enter_link;
1767	(async {
1768	# we need this sleep as the login has a concurrent enter_exit running
1769	# and this sleep increases chances of the player not ending up in scorn
1770	$pl->ob->reply (undef,
1771	"There was an internal problem at your last logout, "
1772	. "the server will try to bring you to your intended destination in a second.",
1773	cf::NDI_RED);
1774	Coro::Timer::sleep 1;
1775	$pl->ob->leave_link;
1776	})->prio (2);
1777	}
1778	},
1779	);
1780
1781	=item $player_object->goto ($path, $x, $y)	2225	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1782		2226
		2227	Moves the player to the given map-path and coordinates by first freezing
		2228	her, loading and preparing them map, calling the provided $check callback
		2229	that has to return the map if sucecssful, and then unfreezes the player on
		2230	the new (success) or old (failed) map position.
		2231
1783	=cut	2232	=cut
		2233
		2234	our $GOTOGEN;
1784		2235
1785	sub cf::object::player::goto {	2236	sub cf::object::player::goto {
1786	my ($self, $path, $x, $y) = @_;	2237	my ($self, $path, $x, $y, $check) = @_;
		2238
		2239	# do generation counting so two concurrent goto's will be executed in-order
		2240	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1787		2241
1788	$self->enter_link;	2242	$self->enter_link;
1789		2243
1790	(async {	2244	(async {
		2245	my $map = eval {
1791	my $map = cf::map::find $path;	2246	my $map = cf::map::find $path;
		2247
		2248	if ($map) {
1792	$map = $map->customise_for ($self) if $map;	2249	$map = $map->customise_for ($self);
1793		2250	$map = $check->($map) if $check && $map;
1794	# warn "entering ", $map->path, " at ($x, $y)\n"	2251	} else {
1795	# if $map;
1796
1797	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2252	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2253	}
1798		2254
		2255	$map
		2256	};
		2257
		2258	if ($@) {
		2259	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2260	LOG llevError | logBacktrace, Carp::longmess $@;
		2261	}
		2262
		2263	if ($gen == $self->{_goto_generation}) {
		2264	delete $self->{_goto_generation};
1799	$self->leave_link ($map, $x, $y);	2265	$self->leave_link ($map, $x, $y);
		2266	}
1800	})->prio (1);	2267	})->prio (1);
1801	}	2268	}
1802		2269
1803	=item $player_object->enter_exit ($exit_object)	2270	=item $player_object->enter_exit ($exit_object)
1804		2271
…		…
1806		2273
1807	sub parse_random_map_params {	2274	sub parse_random_map_params {
1808	my ($spec) = @_;	2275	my ($spec) = @_;
1809		2276
1810	my $rmp = { # defaults	2277	my $rmp = { # defaults
1811	xsize => 10,	2278	xsize => (cf::rndm 15, 40),
1812	ysize => 10,	2279	ysize => (cf::rndm 15, 40),
		2280	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2281	#layout => string,
1813	};	2282	};
1814		2283
1815	for (split /\n/, $spec) {	2284	for (split /\n/, $spec) {
1816	my ($k, $v) = split /\s+/, $_, 2;	2285	my ($k, $v) = split /\s+/, $_, 2;
1817		2286
…		…
1821	$rmp	2290	$rmp
1822	}	2291	}
1823		2292
1824	sub prepare_random_map {	2293	sub prepare_random_map {
1825	my ($exit) = @_;	2294	my ($exit) = @_;
		2295
		2296	my $guard = cf::lock_acquire "exit_prepare:$exit";
1826		2297
1827	# all this does is basically replace the /! path by	2298	# all this does is basically replace the /! path by
1828	# a new random map path (?random/...) with a seed	2299	# a new random map path (?random/...) with a seed
1829	# that depends on the exit object	2300	# that depends on the exit object
1830		2301
1831	my $rmp = parse_random_map_params $exit->msg;	2302	my $rmp = parse_random_map_params $exit->msg;
1832		2303
1833	if ($exit->map) {	2304	if ($exit->map) {
1834	$rmp->{region} = $exit->map->region_name;	2305	$rmp->{region} = $exit->region->name;
1835	$rmp->{origin_map} = $exit->map->path;	2306	$rmp->{origin_map} = $exit->map->path;
1836	$rmp->{origin_x} = $exit->x;	2307	$rmp->{origin_x} = $exit->x;
1837	$rmp->{origin_y} = $exit->y;	2308	$rmp->{origin_y} = $exit->y;
1838	}	2309	}
1839		2310
1840	$rmp->{random_seed} ||= $exit->random_seed;	2311	$rmp->{random_seed} ||= $exit->random_seed;
1841		2312
1842	my $data = cf::to_json $rmp;	2313	my $data = cf::to_json $rmp;
1843	my $md5 = Digest::MD5::md5_hex $data;	2314	my $md5 = Digest::MD5::md5_hex $data;
		2315	my $meta = "$RANDOMDIR/$md5.meta";
1844		2316
1845	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2317	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1846	aio_write $fh, 0, (length $data), $data, 0;	2318	aio_write $fh, 0, (length $data), $data, 0;
		2319	undef $fh;
		2320	aio_rename "$meta~", $meta;
1847		2321
1848	$exit->slaying ("?random/$md5");	2322	$exit->slaying ("?random/$md5");
1849	$exit->msg (undef);	2323	$exit->msg (undef);
1850	}	2324	}
1851	}	2325	}
1852		2326
1853	sub cf::object::player::enter_exit {	2327	sub cf::object::player::enter_exit {
1854	my ($self, $exit) = @_;	2328	my ($self, $exit) = @_;
1855		2329
1856	return unless $self->type == cf::PLAYER;	2330	return unless $self->type == cf::PLAYER;
		2331
		2332	if ($exit->slaying eq "/!") {
		2333	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2334	# the problem is that $exit might not survive long enough
		2335	# so it needs to be done right now, right here
		2336	cf::sync_job { prepare_random_map $exit };
		2337	}
		2338
		2339	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2340	my $hp = $exit->stats->hp;
		2341	my $sp = $exit->stats->sp;
1857		2342
1858	$self->enter_link;	2343	$self->enter_link;
1859		2344
1860	(async {	2345	(async {
1861	$self->deactivate_recursive; # just to be sure	2346	$self->deactivate_recursive; # just to be sure
1862	unless (eval {	2347	unless (eval {
1863	prepare_random_map $exit	2348	$self->goto ($slaying, $hp, $sp);
1864	if $exit->slaying eq "/!";
1865
1866	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1867	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1868		2349
1869	1;	2350	1;
1870	}) {	2351	}) {
1871	$self->message ("Something went wrong deep within the crossfire server. "	2352	$self->message ("Something went wrong deep within the crossfire server. "
1872	. "I'll try to bring you back to the map you were before. "	2353	. "I'll try to bring you back to the map you were before. "
1873	. "Please report this to the dungeon master!",	2354	. "Please report this to the dungeon master!",
1874	cf::NDI_UNIQUE | cf::NDI_RED);	2355	cf::NDI_UNIQUE | cf::NDI_RED);
1875		2356
1876	warn "ERROR in enter_exit: $@";	2357	warn "ERROR in enter_exit: $@";
1877	$self->leave_link;	2358	$self->leave_link;
1878	}	2359	}
1879	})->prio (1);	2360	})->prio (1);
…		…
1892		2373
1893	sub cf::client::send_drawinfo {	2374	sub cf::client::send_drawinfo {
1894	my ($self, $text, $flags) = @_;	2375	my ($self, $text, $flags) = @_;
1895		2376
1896	utf8::encode $text;	2377	utf8::encode $text;
1897	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2378	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1898	}	2379	}
1899		2380
		2381	=item $client->send_msg ($color, $type, $msg, [extra...])
		2382
		2383	Send a drawinfo or msg packet to the client, formatting the msg for the
		2384	client if neccessary. C<$type> should be a string identifying the type of
		2385	the message, with C<log> being the default. If C<$color> is negative, suppress
		2386	the message unless the client supports the msg packet.
		2387
		2388	=cut
		2389
		2390	sub cf::client::send_msg {
		2391	my ($self, $color, $type, $msg, @extra) = @_;
		2392
		2393	$msg = $self->pl->expand_cfpod ($msg);
		2394
		2395	if ($self->can_msg) {
		2396	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2397	} else {
		2398	# replace some tags by gcfclient-compatible ones
		2399	for ($msg) {
		2400	1 while
		2401	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2402	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2403	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2404	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2405	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2406	}
		2407
		2408	if ($color >= 0) {
		2409	if (0 && $msg =~ /\[/) {
		2410	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2411	} else {
		2412	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2413	$self->send_packet ("drawinfo $color $msg")
		2414	}
		2415	}
		2416	}
		2417	}
		2418
		2419	=item $client->ext_event ($type, %msg)
		2420
		2421	Sends an ext event to the client.
		2422
		2423	=cut
		2424
		2425	sub cf::client::ext_event($$%) {
		2426	my ($self, $type, %msg) = @_;
		2427
		2428	$msg{msgtype} = "event_$type";
		2429	$self->send_packet ("ext " . cf::to_json \%msg);
		2430	}
1900		2431
1901	=item $success = $client->query ($flags, "text", \&cb)	2432	=item $success = $client->query ($flags, "text", \&cb)
1902		2433
1903	Queues a query to the client, calling the given callback with	2434	Queues a query to the client, calling the given callback with
1904	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2435	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1905	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2436	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1906		2437
1907	Queries can fail, so check the return code. Or don't, as queries will become	2438	Queries can fail, so check the return code. Or don't, as queries will
1908	reliable at some point in the future.	2439	become reliable at some point in the future.
1909		2440
1910	=cut	2441	=cut
1911		2442
1912	sub cf::client::query {	2443	sub cf::client::query {
1913	my ($self, $flags, $text, $cb) = @_;	2444	my ($self, $flags, $text, $cb) = @_;
…		…
1921	utf8::encode $text;	2452	utf8::encode $text;
1922	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2453	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1923		2454
1924	$self->send_packet ($self->{query_queue}[0][0])	2455	$self->send_packet ($self->{query_queue}[0][0])
1925	if @{ $self->{query_queue} } == 1;	2456	if @{ $self->{query_queue} } == 1;
		2457
		2458	1
1926	}	2459	}
1927		2460
1928	cf::client->attach (	2461	cf::client->attach (
1929	on_reply => sub {	2462	on_reply => sub {
1930	my ($ns, $msg) = @_;	2463	my ($ns, $msg) = @_;
…		…
1933	# get handled first	2466	# get handled first
1934	my $queue = delete $ns->{query_queue}	2467	my $queue = delete $ns->{query_queue}
1935	or return; # be conservative, not sure how that can happen, but we saw a crash here	2468	or return; # be conservative, not sure how that can happen, but we saw a crash here
1936		2469
1937	(shift @$queue)->[1]->($msg);	2470	(shift @$queue)->[1]->($msg);
		2471	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1938		2472
1939	push @{ $ns->{query_queue} }, @$queue;	2473	push @{ $ns->{query_queue} }, @$queue;
1940		2474
1941	if (@{ $ns->{query_queue} } == @$queue) {	2475	if (@{ $ns->{query_queue} } == @$queue) {
1942	if (@$queue) {	2476	if (@$queue) {
…		…
1944	} else {	2478	} else {
1945	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2479	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1946	}	2480	}
1947	}	2481	}
1948	},	2482	},
		2483	on_exticmd => sub {
		2484	my ($ns, $buf) = @_;
		2485
		2486	my $msg = eval { from_json $buf };
		2487
		2488	if (ref $msg) {
		2489	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2490	if (my %reply = $cb->($ns, $msg)) {
		2491	$reply{msgid} = $msg->{msgid};
		2492	$ns->send ("ext " . cf::to_json \%reply);
		2493	}
		2494	}
		2495	} else {
		2496	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2497	}
		2498
		2499	cf::override;
		2500	},
1949	);	2501	);
1950		2502
1951	=item $client->async (\&cb)	2503	=item $client->async (\&cb)
1952		2504
1953	Create a new coroutine, running the specified callback. The coroutine will	2505	Create a new coroutine, running the specified callback. The coroutine will
…		…
2000		2552
2001	# here we export the classes and methods available to script code	2553	# here we export the classes and methods available to script code
2002		2554
2003	=pod	2555	=pod
2004		2556
2005	The following fucntions and emthods are available within a safe environment:	2557	The following functions and methods are available within a safe environment:
2006		2558
2007	cf::object contr pay_amount pay_player map	2559	cf::object contr pay_amount pay_player map
2008	cf::object::player player	2560	cf::object::player player
2009	cf::player peaceful	2561	cf::player peaceful
2010	cf::map trigger	2562	cf::map trigger
…		…
2091	=back	2643	=back
2092		2644
2093	=cut	2645	=cut
2094		2646
2095	#############################################################################	2647	#############################################################################
		2648	# the server's init and main functions
2096		2649
2097	=head2 EXTENSION DATABASE SUPPORT	2650	sub load_facedata($) {
		2651	my ($path) = @_;
2098		2652
2099	Crossfire maintains a very simple database for extension use. It can	2653	warn "loading facedata from $path\n";
2100	currently store anything that can be serialised using Storable, which
2101	excludes objects.
2102		2654
2103	The parameter C<$family> should best start with the name of the extension	2655	my $facedata;
2104	using it, it should be unique.	2656	0 < aio_load $path, $facedata
		2657	or die "$path: $!";
2105		2658
2106	=over 4	2659	$facedata = Coro::Storable::thaw $facedata;
2107		2660
2108	=item $hashref = cf::db_get $family	2661	$facedata->{version} == 2
		2662	or cf::cleanup "$path: version mismatch, cannot proceed.";
2109		2663
2110	Return a hashref for use by the extension C<$family>, which can be
2111	modified. After modifications, you have to call C<cf::db_dirty> or
2112	C<cf::db_sync>.
2113
2114	=item $value = cf::db_get $family => $key
2115
2116	Returns a single value from the database
2117
2118	=item cf::db_put $family => $hashref
2119
2120	Stores the given family hashref into the database. Updates are delayed, if
2121	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2122
2123	=item cf::db_put $family => $key => $value
2124
2125	Stores the given C<$value> in the family hash. Updates are delayed, if you
2126	want the data to be synced to disk immediately, use C<cf::db_sync>.
2127
2128	=item cf::db_dirty
2129
2130	Marks the database as dirty, to be updated at a later time.
2131
2132	=item cf::db_sync
2133
2134	Immediately write the database to disk I<if it is dirty>.
2135
2136	=cut
2137
2138	our $DB;
2139
2140	{
2141	my $path = cf::localdir . "/database.pst";
2142
2143	sub db_load() {
2144	$DB = stat $path ? Storable::retrieve $path : { };
2145	}	2664	{
		2665	my $faces = $facedata->{faceinfo};
2146		2666
2147	my $pid;	2667	while (my ($face, $info) = each %$faces) {
2148		2668	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2149	sub db_save() {	2669	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2150	waitpid $pid, 0 if $pid;	2670	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2151	if (0 == ($pid = fork)) {	2671	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2152	$DB->{_meta}{version} = 1;	2672	Coro::cede;
2153	Storable::nstore $DB, "$path~";
2154	rename "$path~", $path;
2155	cf::_exit 0 if defined $pid;
2156	}
2157	}
2158
2159	my $dirty;
2160
2161	sub db_sync() {
2162	db_save if $dirty;
2163	undef $dirty;
2164	}
2165
2166	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2167	db_sync;
2168	});
2169
2170	sub db_dirty() {
2171	$dirty = 1;
2172	$idle->start;
2173	}
2174
2175	sub db_get($;$) {
2176	@_ >= 2
2177	? $DB->{$_[0]}{$_[1]}
2178	: ($DB->{$_[0]} ||= { })
2179	}
2180
2181	sub db_put($$;$) {
2182	if (@_ >= 3) {
2183	$DB->{$_[0]}{$_[1]} = $_[2];
2184	} else {
2185	$DB->{$_[0]} = $_[1];
2186	}
2187	db_dirty;
2188	}
2189
2190	cf::global->attach (
2191	prio => 10000,
2192	on_cleanup => sub {
2193	db_sync;
2194	},	2673	}
2195	);
2196	}
2197		2674
2198	#############################################################################	2675	while (my ($face, $info) = each %$faces) {
2199	# the server's main()	2676	next unless $info->{smooth};
		2677	my $idx = cf::face::find $face
		2678	or next;
		2679	if (my $smooth = cf::face::find $info->{smooth}) {
		2680	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2681	} else {
		2682	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2683	}
		2684	Coro::cede;
		2685	}
		2686	}
		2687
		2688	{
		2689	my $anims = $facedata->{animinfo};
		2690
		2691	while (my ($anim, $info) = each %$anims) {
		2692	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2693	Coro::cede;
		2694	}
		2695
		2696	cf::anim::invalidate_all; # d'oh
		2697	}
		2698
		2699	1
		2700	}
		2701
		2702	sub reload_regions {
		2703	load_resource_file "$MAPDIR/regions"
		2704	or die "unable to load regions file\n";
		2705	}
		2706
		2707	sub reload_facedata {
		2708	load_facedata "$DATADIR/facedata"
		2709	or die "unable to load facedata\n";
		2710	}
		2711
		2712	sub reload_archetypes {
		2713	load_resource_file "$DATADIR/archetypes"
		2714	or die "unable to load archetypes\n";
		2715	}
		2716
		2717	sub reload_treasures {
		2718	load_resource_file "$DATADIR/treasures"
		2719	or die "unable to load treasurelists\n";
		2720	}
		2721
		2722	sub reload_resources {
		2723	warn "reloading resource files...\n";
		2724
		2725	reload_regions;
		2726	reload_facedata;
		2727	#reload_archetypes;#d#
		2728	reload_archetypes;
		2729	reload_treasures;
		2730
		2731	warn "finished reloading resource files\n";
		2732	}
		2733
		2734	sub init {
		2735	reload_resources;
		2736	}
2200		2737
2201	sub cfg_load {	2738	sub cfg_load {
2202	open my $fh, "<:utf8", cf::confdir . "/config"	2739	open my $fh, "<:utf8", "$CONFDIR/config"
2203	or return;	2740	or return;
2204		2741
2205	local $/;	2742	local $/;
2206	*CFG = YAML::Syck::Load <$fh>;	2743	*CFG = YAML::Syck::Load <$fh>;
2207		2744
…		…
2221		2758
2222	sub main {	2759	sub main {
2223	# we must not ever block the main coroutine	2760	# we must not ever block the main coroutine
2224	local $Coro::idle = sub {	2761	local $Coro::idle = sub {
2225	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2762	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2763	(async {
2226	async { Event::one_event };	2764	Event::one_event;
		2765	})->prio (Coro::PRIO_MAX);
2227	};	2766	};
2228		2767
2229	cfg_load;	2768	cfg_load;
2230	db_load;	2769	db_init;
2231	load_extensions;	2770	load_extensions;
		2771
		2772	$TICK_WATCHER->start;
2232	Event::loop;	2773	Event::loop;
2233	}	2774	}
2234		2775
2235	#############################################################################	2776	#############################################################################
2236	# initialisation and cleanup	2777	# initialisation and cleanup
2237		2778
2238	# install some emergency cleanup handlers	2779	# install some emergency cleanup handlers
2239	BEGIN {	2780	BEGIN {
2240	for my $signal (qw(INT HUP TERM)) {	2781	for my $signal (qw(INT HUP TERM)) {
2241	Event->signal (	2782	Event->signal (
		2783	reentrant => 0,
2242	data => WF_AUTOCANCEL,	2784	data => WF_AUTOCANCEL,
2243	signal => $signal,	2785	signal => $signal,
		2786	prio => 0,
2244	cb => sub {	2787	cb => sub {
2245	cf::cleanup "SIG$signal";	2788	cf::cleanup "SIG$signal";
2246	},	2789	},
2247	);	2790	);
2248	}	2791	}
2249	}	2792	}
2250		2793
		2794	sub write_runtime {
		2795	my $runtime = "$LOCALDIR/runtime";
		2796
		2797	# first touch the runtime file to show we are still running:
		2798	# the fsync below can take a very very long time.
		2799
		2800	IO::AIO::aio_utime $runtime, undef, undef;
		2801
		2802	my $guard = cf::lock_acquire "write_runtime";
		2803
		2804	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2805	or return;
		2806
		2807	my $value = $cf::RUNTIME + 90 + 10;
		2808	# 10 is the runtime save interval, for a monotonic clock
		2809	# 60 allows for the watchdog to kill the server.
		2810
		2811	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2812	and return;
		2813
		2814	# always fsync - this file is important
		2815	aio_fsync $fh
		2816	and return;
		2817
		2818	# touch it again to show we are up-to-date
		2819	aio_utime $fh, undef, undef;
		2820
		2821	close $fh
		2822	or return;
		2823
		2824	aio_rename "$runtime~", $runtime
		2825	and return;
		2826
		2827	warn "runtime file written.\n";
		2828
		2829	1
		2830	}
		2831
2251	sub emergency_save() {	2832	sub emergency_save() {
2252	my $freeze_guard = cf::freeze_mainloop;	2833	my $freeze_guard = cf::freeze_mainloop;
2253		2834
2254	warn "enter emergency perl save\n";	2835	warn "enter emergency perl save\n";
2255		2836
2256	cf::sync_job {	2837	cf::sync_job {
2257	# use a peculiar iteration method to avoid tripping on perl	2838	# use a peculiar iteration method to avoid tripping on perl
2258	# refcount bugs in for. also avoids problems with players	2839	# refcount bugs in for. also avoids problems with players
2259	# and maps saved/Destroyed asynchronously.	2840	# and maps saved/destroyed asynchronously.
2260	warn "begin emergency player save\n";	2841	warn "begin emergency player save\n";
2261	for my $login (keys %cf::PLAYER) {	2842	for my $login (keys %cf::PLAYER) {
2262	my $pl = $cf::PLAYER{$login} or next;	2843	my $pl = $cf::PLAYER{$login} or next;
2263	$pl->valid or next;	2844	$pl->valid or next;
2264	$pl->save;	2845	$pl->save;
…		…
2270	my $map = $cf::MAP{$path} or next;	2851	my $map = $cf::MAP{$path} or next;
2271	$map->valid or next;	2852	$map->valid or next;
2272	$map->save;	2853	$map->save;
2273	}	2854	}
2274	warn "end emergency map save\n";	2855	warn "end emergency map save\n";
		2856
		2857	warn "begin emergency database checkpoint\n";
		2858	BDB::db_env_txn_checkpoint $DB_ENV;
		2859	warn "end emergency database checkpoint\n";
2275	};	2860	};
2276		2861
2277	warn "leave emergency perl save\n";	2862	warn "leave emergency perl save\n";
2278	}	2863	}
2279		2864
		2865	sub post_cleanup {
		2866	my ($make_core) = @_;
		2867
		2868	warn Carp::longmess "post_cleanup backtrace"
		2869	if $make_core;
		2870	}
		2871
2280	sub reload() {	2872	sub do_reload_perl() {
2281	# can/must only be called in main	2873	# can/must only be called in main
2282	if ($Coro::current != $Coro::main) {	2874	if ($Coro::current != $Coro::main) {
2283	warn "can only reload from main coroutine\n";	2875	warn "can only reload from main coroutine";
2284	return;	2876	return;
2285	}	2877	}
2286		2878
2287	warn "reloading...";	2879	warn "reloading...";
2288		2880
2289	warn "freezing server";	2881	warn "entering sync_job";
2290	my $guard = freeze_mainloop;	2882
		2883	cf::sync_job {
		2884	cf::write_runtime; # external watchdog should not bark
2291	cf::emergency_save;	2885	cf::emergency_save;
		2886	cf::write_runtime; # external watchdog should not bark
2292		2887
2293	warn "sync database to disk";	2888	warn "syncing database to disk";
2294	cf::db_sync;	2889	BDB::db_env_txn_checkpoint $DB_ENV;
2295	IO::AIO::flush;
2296		2890
2297	eval {
2298	# if anything goes wrong in here, we should simply crash as we already saved	2891	# if anything goes wrong in here, we should simply crash as we already saved
2299		2892
2300	warn "cancel all watchers";	2893	warn "cancelling all WF_AUTOCANCEL watchers";
2301	for (Event::all_watchers) {	2894	for (Event::all_watchers) {
2302	$_->cancel if $_->data & WF_AUTOCANCEL;	2895	$_->cancel if $_->data & WF_AUTOCANCEL;
2303	}	2896	}
2304		2897
		2898	warn "flushing outstanding aio requests";
		2899	for (;;) {
		2900	BDB::flush;
		2901	IO::AIO::flush;
		2902	Coro::cede;
		2903	last unless IO::AIO::nreqs || BDB::nreqs;
		2904	warn "iterate...";
		2905	}
		2906
		2907	++$RELOAD;
		2908
2305	warn "cancel all extension coros";	2909	warn "cancelling all extension coros";
2306	$_->cancel for values %EXT_CORO;	2910	$_->cancel for values %EXT_CORO;
2307	%EXT_CORO = ();	2911	%EXT_CORO = ();
2308		2912
2309	warn "remove commands";	2913	warn "removing commands";
2310	%COMMAND = ();	2914	%COMMAND = ();
2311		2915
2312	warn "remove ext commands";	2916	warn "removing ext/exti commands";
2313	%EXTCMD = ();	2917	%EXTCMD = ();
		2918	%EXTICMD = ();
2314		2919
2315	warn "unload/nuke all extensions";	2920	warn "unloading/nuking all extensions";
2316	for my $pkg (@EXTS) {	2921	for my $pkg (@EXTS) {
2317	warn "... unloading $pkg";	2922	warn "... unloading $pkg";
2318		2923
2319	if (my $cb = $pkg->can ("unload")) {	2924	if (my $cb = $pkg->can ("unload")) {
2320	eval {	2925	eval {
…		…
2325		2930
2326	warn "... nuking $pkg";	2931	warn "... nuking $pkg";
2327	Symbol::delete_package $pkg;	2932	Symbol::delete_package $pkg;
2328	}	2933	}
2329		2934
2330	warn "unload all perl modules loaded from $LIBDIR";	2935	warn "unloading all perl modules loaded from $LIBDIR";
2331	while (my ($k, $v) = each %INC) {	2936	while (my ($k, $v) = each %INC) {
2332	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2937	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2333		2938
2334	warn "removing <$k>";	2939	warn "... unloading $k";
2335	delete $INC{$k};	2940	delete $INC{$k};
2336		2941
2337	$k =~ s/\.pm$//;	2942	$k =~ s/\.pm$//;
2338	$k =~ s/\//::/g;	2943	$k =~ s/\//::/g;
2339		2944
…		…
2342	}	2947	}
2343		2948
2344	Symbol::delete_package $k;	2949	Symbol::delete_package $k;
2345	}	2950	}
2346		2951
2347	warn "get rid of safe::, as good as possible";	2952	warn "getting rid of safe::, as good as possible";
2348	Symbol::delete_package "safe::$_"	2953	Symbol::delete_package "safe::$_"
2349	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2954	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2350		2955
2351	warn "unload cf.pm \"a bit\"";	2956	warn "unloading cf.pm \"a bit\"";
2352	delete $INC{"cf.pm"};	2957	delete $INC{"cf.pm"};
		2958	delete $INC{"cf/pod.pm"};
2353		2959
2354	# don't, removes xs symbols, too,	2960	# don't, removes xs symbols, too,
2355	# and global variables created in xs	2961	# and global variables created in xs
2356	#Symbol::delete_package __PACKAGE__;	2962	#Symbol::delete_package __PACKAGE__;
2357		2963
		2964	warn "unload completed, starting to reload now";
		2965
2358	warn "reloading cf.pm";	2966	warn "reloading cf.pm";
2359	require cf;	2967	require cf;
2360	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2968	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2361		2969
2362	warn "load config and database again";	2970	warn "loading config and database again";
2363	cf::cfg_load;	2971	cf::cfg_load;
2364	cf::db_load;
2365		2972
2366	warn "load extensions";	2973	warn "loading extensions";
2367	cf::load_extensions;	2974	cf::load_extensions;
2368		2975
2369	warn "reattach attachments to objects/players";	2976	warn "reattaching attachments to objects/players";
2370	_global_reattach;	2977	_global_reattach; # objects, sockets
2371	warn "reattach attachments to maps";	2978	warn "reattaching attachments to maps";
2372	reattach $_ for values %MAP;	2979	reattach $_ for values %MAP;
2373	};	2980	warn "reattaching attachments to players";
		2981	reattach $_ for values %PLAYER;
2374		2982
2375	if ($@) {	2983	warn "leaving sync_job";
		2984
		2985	1
		2986	} or do {
2376	warn $@;	2987	warn $@;
2377	warn "error while reloading, exiting.";	2988	warn "error while reloading, exiting.";
2378	exit 1;	2989	exit 1;
2379	}	2990	};
2380		2991
2381	warn "reloaded";	2992	warn "reloaded";
2382	};	2993	};
2383		2994
		2995	our $RELOAD_WATCHER; # used only during reload
		2996
		2997	sub reload_perl() {
		2998	# doing reload synchronously and two reloads happen back-to-back,
		2999	# coro crashes during coro_state_free->destroy here.
		3000
		3001	$RELOAD_WATCHER ||= Event->timer (
		3002	reentrant => 0,
		3003	after => 0,
		3004	data => WF_AUTOCANCEL,
		3005	cb => sub {
		3006	do_reload_perl;
		3007	undef $RELOAD_WATCHER;
		3008	},
		3009	);
		3010	}
		3011
2384	register_command "reload" => sub {	3012	register_command "reload" => sub {
2385	my ($who, $arg) = @_;	3013	my ($who, $arg) = @_;
2386		3014
2387	if ($who->flag (FLAG_WIZ)) {	3015	if ($who->flag (FLAG_WIZ)) {
2388	$who->message ("start of reload.");
2389	reload;
2390	$who->message ("end of reload.");	3016	$who->message ("reloading server.");
		3017	async { reload_perl };
2391	}	3018	}
2392	};	3019	};
2393		3020
2394	unshift @INC, $LIBDIR;	3021	unshift @INC, $LIBDIR;
2395		3022
		3023	my $bug_warning = 0;
		3024
		3025	our @WAIT_FOR_TICK;
		3026	our @WAIT_FOR_TICK_BEGIN;
		3027
		3028	sub wait_for_tick {
		3029	return unless $TICK_WATCHER->is_active;
		3030	return if $Coro::current == $Coro::main;
		3031
		3032	my $signal = new Coro::Signal;
		3033	push @WAIT_FOR_TICK, $signal;
		3034	$signal->wait;
		3035	}
		3036
		3037	sub wait_for_tick_begin {
		3038	return unless $TICK_WATCHER->is_active;
		3039	return if $Coro::current == $Coro::main;
		3040
		3041	my $signal = new Coro::Signal;
		3042	push @WAIT_FOR_TICK_BEGIN, $signal;
		3043	$signal->wait;
		3044	}
		3045
		3046	my $min = 1e6;#d#
		3047	my $avg = 10;
2396	$TICK_WATCHER = Event->timer (	3048	$TICK_WATCHER = Event->timer (
2397	reentrant => 0,	3049	reentrant => 0,
		3050	parked => 1,
2398	prio => 0,	3051	prio => 0,
2399	at => $NEXT_TICK || $TICK,	3052	at => $NEXT_TICK || $TICK,
2400	data => WF_AUTOCANCEL,	3053	data => WF_AUTOCANCEL,
2401	cb => sub {	3054	cb => sub {
		3055	if ($Coro::current != $Coro::main) {
		3056	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3057	unless ++$bug_warning > 10;
		3058	return;
		3059	}
		3060
2402	$NOW = Event::time;	3061	$NOW = $tick_start = Event::time;
2403		3062
2404	cf::server_tick; # one server iteration	3063	cf::server_tick; # one server iteration
		3064
		3065	0 && sync_job {#d#
		3066	for(1..10) {
		3067	my $t = Event::time;
		3068	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3069	or die;
		3070
		3071	$map->width (50);
		3072	$map->height (50);
		3073	$map->alloc;
		3074	$map->_load_objects ("/tmp/x.map", 1);
		3075	my $t = Event::time - $t;
		3076
		3077	#next unless $t < 0.0013;#d#
		3078	if ($t < $min) {
		3079	$min = $t;
		3080	}
		3081	$avg = $avg * 0.99 + $t * 0.01;
		3082	}
		3083	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3084	exit 0;
		3085	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3086	};
		3087
2405	$RUNTIME += $TICK;	3088	$RUNTIME += $TICK;
2406	$NEXT_TICK += $TICK;	3089	$NEXT_TICK += $TICK;
2407		3090
2408	$WAIT_FOR_TICK->broadcast;	3091	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2409	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3092	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3093	Coro::async_pool {
		3094	write_runtime
		3095	or warn "ERROR: unable to write runtime file: $!";
		3096	};
		3097	}
		3098
		3099	# my $AFTER = Event::time;
		3100	# warn $AFTER - $NOW;#d#
		3101
		3102	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3103	$sig->send;
		3104	}
		3105	while (my $sig = shift @WAIT_FOR_TICK) {
		3106	$sig->send;
		3107	}
		3108
		3109	$NOW = Event::time;
2410		3110
2411	# if we are delayed by four ticks or more, skip them all	3111	# if we are delayed by four ticks or more, skip them all
2412	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3112	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2413		3113
2414	$TICK_WATCHER->at ($NEXT_TICK);	3114	$TICK_WATCHER->at ($NEXT_TICK);
2415	$TICK_WATCHER->start;	3115	$TICK_WATCHER->start;
		3116
		3117	$LOAD = ($NOW - $tick_start) / $TICK;
		3118	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3119
		3120	_post_tick;
		3121
		3122
2416	},	3123	},
2417	);	3124	);
2418		3125
		3126	{
2419	IO::AIO::max_poll_time $TICK * 0.2;	3127	BDB::max_poll_time $TICK * 0.1;
2420		3128	$BDB_POLL_WATCHER = Event->io (
2421	Event->io (	3129	reentrant => 0,
2422	fd => IO::AIO::poll_fileno,	3130	fd => BDB::poll_fileno,
2423	poll => 'r',	3131	poll => 'r',
2424	prio => 5,	3132	prio => 0,
2425	data => WF_AUTOCANCEL,
2426	cb => \&IO::AIO::poll_cb,
2427	);
2428
2429	Event->timer (
2430	data => WF_AUTOCANCEL,	3133	data => WF_AUTOCANCEL,
2431	after => 0,	3134	cb => \&BDB::poll_cb,
2432	interval => 10,	3135	);
2433	cb => sub {	3136	BDB::min_parallel 8;
2434	(Coro::unblock_sub {	3137
2435	write_runtime	3138	BDB::set_sync_prepare {
2436	or warn "ERROR: unable to write runtime file: $!";	3139	my $status;
		3140	my $current = $Coro::current;
		3141	(
		3142	sub {
		3143	$status = $!;
		3144	$current->ready; undef $current;
		3145	},
		3146	sub {
		3147	Coro::schedule while defined $current;
		3148	$! = $status;
		3149	},
		3150	)
		3151	};
		3152
		3153	unless ($DB_ENV) {
		3154	$DB_ENV = BDB::db_env_create;
		3155
		3156	cf::sync_job {
		3157	eval {
		3158	BDB::db_env_open
		3159	$DB_ENV,
		3160	$BDBDIR,
		3161	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3162	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3163	0666;
		3164
		3165	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3166
		3167	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3168	$DB_ENV->set_lk_detect;
		3169	};
		3170
		3171	cf::cleanup "db_env_open(db): $@" if $@;
2437	})->();	3172	};
2438	},	3173	}
2439	);	3174	}
		3175
		3176	{
		3177	IO::AIO::min_parallel 8;
		3178
		3179	undef $Coro::AIO::WATCHER;
		3180	IO::AIO::max_poll_time $TICK * 0.1;
		3181	$AIO_POLL_WATCHER = Event->io (
		3182	reentrant => 0,
		3183	data => WF_AUTOCANCEL,
		3184	fd => IO::AIO::poll_fileno,
		3185	poll => 'r',
		3186	prio => 6,
		3187	cb => \&IO::AIO::poll_cb,
		3188	);
		3189	}
		3190
		3191	my $_log_backtrace;
		3192
		3193	sub _log_backtrace {
		3194	my ($msg, @addr) = @_;
		3195
		3196	$msg =~ s/\n//;
		3197
		3198	# limit the # of concurrent backtraces
		3199	if ($_log_backtrace < 2) {
		3200	++$_log_backtrace;
		3201	async {
		3202	my @bt = fork_call {
		3203	@addr = map { sprintf "%x", $_ } @addr;
		3204	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3205	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3206	or die "addr2line: $!";
		3207
		3208	my @funcs;
		3209	my @res = <$fh>;
		3210	chomp for @res;
		3211	while (@res) {
		3212	my ($func, $line) = splice @res, 0, 2, ();
		3213	push @funcs, "[$func] $line";
		3214	}
		3215
		3216	@funcs
		3217	};
		3218
		3219	LOG llevInfo, "[ABT] $msg\n";
		3220	LOG llevInfo, "[ABT] $_\n" for @bt;
		3221	--$_log_backtrace;
		3222	};
		3223	} else {
		3224	LOG llevInfo, "[ABT] $msg\n";
		3225	LOG llevInfo, "[ABT] [suppressed]\n";
		3226	}
		3227	}
		3228
		3229	# load additional modules
		3230	use cf::pod;
2440		3231
2441	END { cf::emergency_save }	3232	END { cf::emergency_save }
2442		3233
2443	1	3234	1
2444		3235

Diff Legend

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