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.171 by root, Sun Jan 14 12:24:48 2007 UTC vs.
Revision 1.297 by root, Thu Jul 5 08:10:30 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;
49	our $AIO_POLL_WATCHER;	76	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	77	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	78	our $NEXT_TICK;
52	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;
53		84
54	our %CFG;	85	our %CFG;
55		86
56	our $UPTIME; $UPTIME ||= time;	87	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	88	our $RUNTIME;
58		89
59	our %PLAYER; # all users	90	our %PLAYER; # all users
60	our %MAP; # all maps	91	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	92	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		93
67	# 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 ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	95	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		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
70	binmode STDOUT;	101	binmode STDOUT;
71	binmode STDERR;	102	binmode STDERR;
72		103
73	# read virtual server time, if available	104	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	105	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	106	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	107	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	108	$RUNTIME = <$fh> + 0.;
78	}	109	}
79		110
80	mkdir cf::localdir;	111	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	112	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		113
86	our $EMERGENCY_POSITION;	114	our $EMERGENCY_POSITION;
		115
		116	sub cf::map::normalise;
87		117
88	#############################################################################	118	#############################################################################
89		119
90	=head2 GLOBAL VARIABLES	120	=head2 GLOBAL VARIABLES
91		121
…		…
98	=item $cf::RUNTIME	128	=item $cf::RUNTIME
99		129
100	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
101	every server tick.	131	every server tick.
102		132
103	=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
104		136
105	The perl library directory, where extensions and cf-specific modules can	137	Various directories - "/etc", read-only install directory, perl-library
106	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.
107		141
108	=item $cf::NOW	142	=item $cf::NOW
109		143
110	The time of the last (current) server tick.	144	The time of the last (current) server tick.
111		145
112	=item $cf::TICK	146	=item $cf::TICK
113		147
114	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.
115		159
116	=item %cf::CFG	160	=item %cf::CFG
117		161
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	162	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	163	from wherever your confdir points to.
120		164
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	165	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		166
123	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
124	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
125	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.
126	window of cpu time available, or simply to synchronise to the server tick.
127		170
128	=back	171	=back
129		172
130	=cut	173	=cut
131		174
132	BEGIN {	175	BEGIN {
133	*CORE::GLOBAL::warn = sub {	176	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	177	my $msg = join "", @_;
135	utf8::encode $msg;
136		178
137	$msg .= "\n"	179	$msg .= "\n"
138	unless $msg =~ /\n$/;	180	unless $msg =~ /\n$/;
139		181
		182	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		183
		184	utf8::encode $msg;
140	LOG llevError, $msg;	185	LOG llevError, $msg;
141	};	186	};
142	}	187	}
143		188
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	189	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	190	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	191	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	192	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@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';
149	@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)
150		196
151	# 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
152	# within the Safe compartment.	198	# within the Safe compartment.
153	for my $pkg (qw(	199	for my $pkg (qw(
154	cf::global cf::attachable	200	cf::global cf::attachable
…		…
162	}	208	}
163		209
164	$Event::DIED = sub {	210	$Event::DIED = sub {
165	warn "error in event callback: @_";	211	warn "error in event callback: @_";
166	};	212	};
		213
		214	#############################################################################
167		215
168	=head2 UTILITY FUNCTIONS	216	=head2 UTILITY FUNCTIONS
169		217
170	=over 4	218	=over 4
171		219
…		…
190	$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;
191	$d	239	$d
192	} || "[unable to dump $_[0]: '$@']";	240	} || "[unable to dump $_[0]: '$@']";
193	}	241	}
194		242
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
198		244
199	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
200		246
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
209		248
210	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
211		250
212	=cut	251	=cut
213		252
214	sub to_json($) {	253	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	254
216	JSON::Syck::Dump $_[0]	255	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	256	sub from_json ($) { $json_coder->decode ($_[0]) }
218		257
219	=item cf::lock_wait $string	258	=item cf::lock_wait $string
220		259
221	Wait until the given lock is available. See cf::lock_acquire.	260	Wait until the given lock is available. See cf::lock_acquire.
222		261
…		…
228	returned.	267	returned.
229		268
230	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
231	uses map_find and cf::map::load uses map_load).	270	uses map_find and cf::map::load uses map_load).
232		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
233	=cut	276	=cut
234		277
235	our %LOCK;	278	our %LOCK;
236		279
237	sub lock_wait($) {	280	sub lock_wait($) {
…		…
256	# wake up all waiters, to be on the safe side	299	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	300	$_->ready for @{ delete $LOCK{$key} };
258	}	301	}
259	}	302	}
260		303
		304	sub lock_active($) {
		305	my ($key) = @_;
		306
		307	! ! $LOCK{$key}
		308	}
		309
261	sub freeze_mainloop {	310	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	311	return unless $TICK_WATCHER->is_active;
263		312
264	my $guard = Coro::guard {	313	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	314	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	315	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	316	$TICK_WATCHER->stop;
270	$guard	317	$guard
271	}	318	}
272		319
273	=item cf::async { BLOCK }	320	=item cf::async { BLOCK }
…		…
280		327
281	BEGIN { *async = \&Coro::async_pool }	328	BEGIN { *async = \&Coro::async_pool }
282		329
283	=item cf::sync_job { BLOCK }	330	=item cf::sync_job { BLOCK }
284		331
285	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)
286	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
287	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.
288		336
289	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
290	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
291	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
292	fast or be very important.	340	fast or be very important.
…		…
295		343
296	sub sync_job(&) {	344	sub sync_job(&) {
297	my ($job) = @_;	345	my ($job) = @_;
298		346
299	if ($Coro::current == $Coro::main) {	347	if ($Coro::current == $Coro::main) {
		348	my $time = Event::time;
		349
300	# this is the main coro, too bad, we have to block	350	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	351	# till the operation succeeds, freezing the server :/
302		352
303	# TODO: use suspend/resume instead	353	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	354	# (but this is cancel-safe)
…		…
315		365
316	while ($busy) {	366	while ($busy) {
317	Coro::cede or Event::one_event;	367	Coro::cede or Event::one_event;
318	}	368	}
319		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
320	wantarray ? @res : $res[0]	377	wantarray ? @res : $res[0]
321	} else {	378	} else {
322	# we are in another coroutine, how wonderful, everything just works	379	# we are in another coroutine, how wonderful, everything just works
323		380
324	$job->()	381	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	400	$EXT_CORO{$coro+0} = $coro;
344		401
345	$coro	402	$coro
346	}	403	}
347		404
348	sub write_runtime {	405	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		406
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	407	Executes the given code block with the given arguments in a seperate
352	or return;	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.
353		411
354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	412	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		413
358	aio_fsync $fh	414	sub fork_call(&@) {
359	and return;	415	my ($cb, @args) = @_;
360		416
		417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		418	# or die "socketpair: $!";
		419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
		421
		422	if (my $pid = fork) {
361	close $fh	423	close $fh2;
362	or return;
363		424
364	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
365	and return;	426	$res = Coro::Storable::thaw $res;
366		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;
367	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 });
368	}	574	}
369		575
370	=back	576	=back
371		577
372	=cut	578	=cut
…		…
379	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")
380	to it. All such attachable objects support the following methods.	586	to it. All such attachable objects support the following methods.
381		587
382	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>
383	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
384	crossfire+).	590	Crossfire TRT).
385		591
386	=over 4	592	=over 4
387		593
388	=item $attachable->attach ($attachment, key => $value...)	594	=item $attachable->attach ($attachment, key => $value...)
389		595
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	758	$registry = $CB_TYPE[$object_type] ||= [];
553		759
554	} elsif ($type eq "subtype") {	760	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	761	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	762	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	763	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		764
559	} elsif ($type eq "package") {	765	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	766	my $pkg = shift @arg;
561		767
562	while (my ($name, $id) = each %cb_id) {	768	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	797	_attach $registry, $klass, @attach;
592	}	798	}
593		799
594	$obj->{$name} = \%arg;	800	$obj->{$name} = \%arg;
595	} else {	801	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	802	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	803	}
598		804
599	$obj->{_attachment}{$name} = undef;	805	$obj->{_attachment}{$name} = undef;
600	}	806	}
601		807
…		…
603	if (ref $_[0]) {	809	if (ref $_[0]) {
604	_object_attach @_;	810	_object_attach @_;
605	} else {	811	} else {
606	_attach shift->_attach_registry, @_;	812	_attach shift->_attach_registry, @_;
607	}	813	}
		814	_recalc_want;
608	};	815	};
609		816
610	# all those should be optimised	817	# all those should be optimised
611	sub cf::attachable::detach {	818	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	819	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	822	delete $obj->{_attachment}{$name};
616	reattach ($obj);	823	reattach ($obj);
617	} else {	824	} else {
618	Carp::croak "cannot, currently, detach class attachments";	825	Carp::croak "cannot, currently, detach class attachments";
619	}	826	}
		827	_recalc_want;
620	};	828	};
621		829
622	sub cf::attachable::attached {	830	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	831	my ($obj, $name) = @_;
624		832
…		…
747	$filename, length $$rdata, scalar @$objs;	955	$filename, length $$rdata, scalar @$objs;
748		956
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	957	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	959	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	960	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	961	close $fh;
754		962
755	if (@$objs) {	963	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	965	chmod SAVE_MODE, $fh;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	966	my $data = Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	967	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	968	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	969	close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	970	aio_rename "$filename.pst~", "$filename.pst";
763	}	971	}
764	} else {	972	} else {
765	aio_unlink "$filename.pst";	973	aio_unlink "$filename.pst";
…		…
797	or return;	1005	or return;
798	$av = eval { (Storable::thaw $av)->{objs} };	1006	$av = eval { (Storable::thaw $av)->{objs} };
799	}	1007	}
800		1008
801	warn sprintf "loading %s (%d)\n",	1009	warn sprintf "loading %s (%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1010	$filename, length $data, scalar @{$av || []};
803	return ($data, $av);	1011	return ($data, $av);
804	}	1012	}
		1013
		1014	=head2 COMMAND CALLBACKS
		1015
		1016	=over 4
		1017
		1018	=cut
805		1019
806	#############################################################################	1020	#############################################################################
807	# command handling &c	1021	# command handling &c
808		1022
809	=item cf::register_command $name => \&callback($ob,$args);	1023	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1037	}
824		1038
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1039	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1040
827	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.
828		1046
829	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
830	called.	1048	called.
831		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
832	=cut	1061	=cut
833		1062
834	sub register_extcmd {	1063	sub register_extcmd {
835	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
836		1065
837	$EXTCMD{$name} = $cb;	1066	$EXTCMD{$name} = $cb;
		1067	}
		1068
		1069	sub register_exticmd {
		1070	my ($name, $cb) = @_;
		1071
		1072	$EXTICMD{$name} = $cb;
838	}	1073	}
839		1074
840	cf::player->attach (	1075	cf::player->attach (
841	on_command => sub {	1076	on_command => sub {
842	my ($pl, $name, $params) = @_;	1077	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1086	cf::override;
852	},	1087	},
853	on_extcmd => sub {	1088	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1089	my ($pl, $buf) = @_;
855		1090
856	my $msg = eval { from_json $buf };	1091	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1092
858	if (ref $msg) {	1093	if (ref $msg) {
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1094	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
860	if (my %reply = $cb->($pl, $msg)) {	1095	if (my %reply = $cb->($pl, $msg)) {
861	$pl->ext_reply ($msg->{msgid}, %reply);	1096	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
867		1102
868	cf::override;	1103	cf::override;
869	},	1104	},
870	);	1105	);
871		1106
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1107	sub load_extensions {
		1108	cf::sync_job {
		1109	my %todo;
		1110
907	for my $ext (<$LIBDIR/*.ext>) {	1111	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1112	next unless -r $path;
909	eval {	1113
910	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;
911	1	1171	}
912	} or warn "$ext not loaded: $@";	1172
		1173	skip:
		1174	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1175	unless $progress;
		1176	}
913	}	1177	};
914	}	1178	}
915		1179
916	#############################################################################	1180	#############################################################################
917		1181
		1182	=back
		1183
918	=head2 CORE EXTENSIONS	1184	=head2 CORE EXTENSIONS
919		1185
920	Functions and methods that extend core crossfire objects.	1186	Functions and methods that extend core crossfire objects.
921		1187
922	=cut	1188	=cut
…		…
934	Returns the given player object, loading it if necessary (might block).	1200	Returns the given player object, loading it if necessary (might block).
935		1201
936	=cut	1202	=cut
937		1203
938	sub playerdir($) {	1204	sub playerdir($) {
939	cf::localdir	1205	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1206	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1207	}
945		1208
946	sub path($) {	1209	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1210	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1211
949	(playerdir $login) . "/$login.pl"	1212	(playerdir $login) . "/playerdata"
950	}	1213	}
951		1214
952	sub find_active($) {	1215	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1216	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1217	and $cf::PLAYER{$_[0]}->active
…		…
957		1220
958	sub exists($) {	1221	sub exists($) {
959	my ($login) = @_;	1222	my ($login) = @_;
960		1223
961	$cf::PLAYER{$login}	1224	$cf::PLAYER{$login}
962	or cf::sync_job { !aio_stat $login }	1225	or cf::sync_job { !aio_stat path $login }
963	}	1226	}
964		1227
965	sub find($) {	1228	sub find($) {
966	return $cf::PLAYER{$_[0]} || do {	1229	return $cf::PLAYER{$_[0]} || do {
967	my $login = $_[0];	1230	my $login = $_[0];
968		1231
969	my $guard = cf::lock_acquire "user_find:$login";	1232	my $guard = cf::lock_acquire "user_find:$login";
970		1233
971	$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
972	my $pl = load_pl path $login	1242	my $pl = load_pl path $login
973	or return;	1243	or return;
974	$cf::PLAYER{$login} = $pl	1244	$cf::PLAYER{$login} = $pl
975	}	1245	}
976	}	1246	}
…		…
1013		1283
1014	=cut	1284	=cut
1015		1285
1016	sub quit_character {	1286	sub quit_character {
1017	my ($pl) = @_;	1287	my ($pl) = @_;
		1288
		1289	my $name = $pl->ob->name;
1018		1290
1019	$pl->{deny_save} = 1;	1291	$pl->{deny_save} = 1;
1020	$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
1021		1293
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1294	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1027	my $path = playerdir $pl;	1299	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1300	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1301	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1302	delete $cf::PLAYER{$pl->ob->name};
1031	$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
1032	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;
1033	}	1325	}
1034		1326
1035	=item cf::player::list_logins	1327	=item cf::player::list_logins
1036		1328
1037	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
1038	while and may block, so not sync_job-capable, ever.	1330	while and may block, so not sync_job-capable, ever.
1039		1331
1040	=cut	1332	=cut
1041		1333
1042	sub list_logins {	1334	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1335	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1336	or return [];
1045		1337
1046	my @logins;	1338	my @logins;
1047		1339
1048	for my $login (@$dirs) {	1340	for my $login (@$dirs) {
…		…
1065	=cut	1357	=cut
1066		1358
1067	sub maps($) {	1359	sub maps($) {
1068	my ($pl) = @_;	1360	my ($pl) = @_;
1069		1361
		1362	$pl = ref $pl ? $pl->ob->name : $pl;
		1363
1070	my $files = aio_readdir playerdir $pl	1364	my $files = aio_readdir playerdir $pl
1071	or return;	1365	or return;
1072		1366
1073	my @paths;	1367	my @paths;
1074		1368
1075	for (@$files) {	1369	for (@$files) {
1076	utf8::decode $_;	1370	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1371	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1372	next unless /^$PATH_SEP/o;
1079		1373
1080	s/\.map$//;	1374	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1375	}
1083		1376
1084	\@paths	1377	\@paths
1085	}	1378	}
1086		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<([^\>]*)>}
		1406	{
		1407	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1408	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1409	"")
		1410	[$self->{hintmode}]
		1411	}ge;
		1412
		1413	# create single paragraphs (very hackish)
		1414	s/(?<=\S)\n(?=\w)/ /g;
		1415
		1416	# compress some whitespace
		1417	s/\s+\n/\n/g; # ws line-ends
		1418	s/\n\n+/\n/g; # double lines
		1419	s/^\n+//; # beginning lines
		1420	s/\n+$//; # ending lines
		1421
		1422	$_
		1423	}
		1424
		1425	sub hintmode {
		1426	$_[0]{hintmode} = $_[1] if @_ > 1;
		1427	$_[0]{hintmode}
		1428	}
		1429
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1430	=item $player->ext_reply ($msgid, %msg)
1088		1431
1089	Sends an ext reply to the player.	1432	Sends an ext reply to the player.
1090		1433
1091	=cut	1434	=cut
1092		1435
1093	sub ext_reply($$$%) {	1436	sub ext_reply($$%) {
1094	my ($self, $id, %msg) = @_;	1437	my ($self, $id, %msg) = @_;
1095		1438
1096	$msg{msgid} = $id;	1439	$msg{msgid} = $id;
1097		1440	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1441	}
1100		1442
1101	package cf;	1443	=item $player->ext_event ($type, %msg)
		1444
		1445	Sends an ext event to the client.
		1446
		1447	=cut
		1448
		1449	sub ext_event($$%) {
		1450	my ($self, $type, %msg) = @_;
		1451
		1452	$self->ns->ext_event ($type, %msg);
		1453	}
		1454
		1455	=head3 cf::region
		1456
		1457	=over 4
		1458
		1459	=cut
		1460
		1461	package cf::region;
		1462
		1463	=item cf::region::find_by_path $path
		1464
		1465	Tries to decuce the likely region for a map knowing only its path.
		1466
		1467	=cut
		1468
		1469	sub find_by_path($) {
		1470	my ($path) = @_;
		1471
		1472	my ($match, $specificity);
		1473
		1474	for my $region (list) {
		1475	if ($region->match && $path =~ $region->match) {
		1476	($match, $specificity) = ($region, $region->specificity)
		1477	if $region->specificity > $specificity;
		1478	}
		1479	}
		1480
		1481	$match
		1482	}
1102		1483
1103	=back	1484	=back
1104
1105		1485
1106	=head3 cf::map	1486	=head3 cf::map
1107		1487
1108	=over 4	1488	=over 4
1109		1489
…		…
1113		1493
1114	use Fcntl;	1494	use Fcntl;
1115	use Coro::AIO;	1495	use Coro::AIO;
1116		1496
1117	use overload	1497	use overload
1118	'""' => \&as_string;	1498	'""' => \&as_string,
		1499	fallback => 1;
1119		1500
1120	our $MAX_RESET = 3600;	1501	our $MAX_RESET = 3600;
1121	our $DEFAULT_RESET = 3000;	1502	our $DEFAULT_RESET = 3000;
1122		1503
1123	sub generate_random_map {	1504	sub generate_random_map {
1124	my ($self, $rmp) = @_;	1505	my ($self, $rmp) = @_;
1125
1126	# mit "rum" bekleckern, nicht	1506	# mit "rum" bekleckern, nicht
1127	$self->_create_random_map (	1507	$self->_create_random_map (
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1508	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1509	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1510	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1517	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1518	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1519	)
1140	}	1520	}
1141		1521
		1522	=item cf::map->register ($regex, $prio)
		1523
		1524	Register a handler for the map path matching the given regex at the
		1525	givne priority (higher is better, built-in handlers have priority 0, the
		1526	default).
		1527
		1528	=cut
		1529
1142	sub register {	1530	sub register {
1143	my (undef, $regex) = @_;	1531	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1532	my $pkg = caller;
1145		1533
1146	no strict;	1534	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1535	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1536
1149	$EXT_MAP{$pkg} = qr<$regex>;	1537	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1538	}
1151		1539
1152	# also paths starting with '/'	1540	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1541	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1542
1155	sub thawer_merge {	1543	sub thawer_merge {
		1544	my ($self, $merge) = @_;
		1545
1156	# we have to keep some variables in memory intact	1546	# we have to keep some variables in memory intact
1157	local $_[0]{path};	1547	local $self->{path};
1158	local $_[0]{deny_save};	1548	local $self->{load_path};
1159	local $_[0]{deny_reset};
1160		1549
1161	$_[0]->SUPER::thawer_merge ($_[1]);	1550	$self->SUPER::thawer_merge ($merge);
1162	}	1551	}
1163		1552
1164	sub normalise {	1553	sub normalise {
1165	my ($path, $base) = @_;	1554	my ($path, $base) = @_;
		1555
		1556	$path = "$path"; # make sure its a string
		1557
		1558	$path =~ s/\.map$//;
1166		1559
1167	# map plan:	1560	# map plan:
1168	#	1561	#
1169	# /! non-realised random map exit (special hack!)	1562	# /! non-realised random map exit (special hack!)
1170	# {... are special paths that are not being touched	1563	# {... are special paths that are not being touched
…		…
1198		1591
1199	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1592	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1200		1593
1201	$path = normalise $path, $base;	1594	$path = normalise $path, $base;
1202		1595
1203	for my $pkg (keys %EXT_MAP) {	1596	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1204	if ($path =~ $EXT_MAP{$pkg}) {	1597	if ($path =~ $EXT_MAP{$pkg}[1]) {
1205	my $self = bless cf::map::new, $pkg;	1598	my $self = bless cf::map::new, $pkg;
1206	$self->{path} = $path; $self->path ($path);	1599	$self->{path} = $path; $self->path ($path);
1207	$self->init; # pass $1 etc.	1600	$self->init; # pass $1 etc.
1208	return $self;	1601	return $self;
1209	}	1602	}
1210	}	1603	}
1211		1604
1212	Carp::carp "unable to resolve path '$path'.";	1605	Carp::carp "unable to resolve path '$path' (base '$base').";
1213	()	1606	()
1214	}	1607	}
1215		1608
1216	sub init {	1609	sub init {
1217	my ($self) = @_;	1610	my ($self) = @_;
…		…
1232		1625
1233	# the original (read-only) location	1626	# the original (read-only) location
1234	sub load_path {	1627	sub load_path {
1235	my ($self) = @_;	1628	my ($self) = @_;
1236		1629
1237	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1630	"$MAPDIR/$self->{path}.map"
1238	}	1631	}
1239		1632
1240	# the temporary/swap location	1633	# the temporary/swap location
1241	sub save_path {	1634	sub save_path {
1242	my ($self) = @_;	1635	my ($self) = @_;
1243		1636
1244	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1637	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1245	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1638	"$TMPDIR/$path.map"
1246	}	1639	}
1247		1640
1248	# the unique path, undef == no special unique path	1641	# the unique path, undef == no special unique path
1249	sub uniq_path {	1642	sub uniq_path {
1250	my ($self) = @_;	1643	my ($self) = @_;
1251		1644
1252	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1645	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1253	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1646	"$UNIQUEDIR/$path"
1254	}	1647	}
1255		1648
1256	# and all this just because we cannot iterate over	1649	# and all this just because we cannot iterate over
1257	# all maps in C++...	1650	# all maps in C++...
1258	sub change_all_map_light {	1651	sub change_all_map_light {
…		…
1260		1653
1261	$_->change_map_light ($change)	1654	$_->change_map_light ($change)
1262	for grep $_->outdoor, values %cf::MAP;	1655	for grep $_->outdoor, values %cf::MAP;
1263	}	1656	}
1264		1657
		1658	sub decay_objects {
		1659	my ($self) = @_;
		1660
		1661	return if $self->{deny_reset};
		1662
		1663	$self->do_decay_objects;
		1664	}
		1665
1265	sub unlink_save {	1666	sub unlink_save {
1266	my ($self) = @_;	1667	my ($self) = @_;
1267		1668
1268	utf8::encode (my $save = $self->save_path);	1669	utf8::encode (my $save = $self->save_path);
1269	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1670	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1272		1673
1273	sub load_header_from($) {	1674	sub load_header_from($) {
1274	my ($self, $path) = @_;	1675	my ($self, $path) = @_;
1275		1676
1276	utf8::encode $path;	1677	utf8::encode $path;
1277	aio_open $path, O_RDONLY, 0	1678	#aio_open $path, O_RDONLY, 0
1278	or return;	1679	# or return;
1279		1680
1280	$self->_load_header ($path)	1681	$self->_load_header ($path)
1281	or return;	1682	or return;
1282		1683
1283	$self->{load_path} = $path;	1684	$self->{load_path} = $path;
1284		1685
1285	1	1686	1
1286	}	1687	}
1287		1688
1288	sub load_orig {	1689	sub load_header_orig {
1289	my ($self) = @_;	1690	my ($self) = @_;
1290		1691
1291	$self->load_header_from ($self->load_path)	1692	$self->load_header_from ($self->load_path)
1292	}	1693	}
1293		1694
1294	sub load_temp {	1695	sub load_header_temp {
1295	my ($self) = @_;	1696	my ($self) = @_;
1296		1697
1297	$self->load_header_from ($self->save_path)	1698	$self->load_header_from ($self->save_path)
		1699	}
		1700
		1701	sub prepare_temp {
		1702	my ($self) = @_;
		1703
		1704	$self->last_access ((delete $self->{last_access})
		1705	|| $cf::RUNTIME); #d#
		1706	# safety
		1707	$self->{instantiate_time} = $cf::RUNTIME
		1708	if $self->{instantiate_time} > $cf::RUNTIME;
		1709	}
		1710
		1711	sub prepare_orig {
		1712	my ($self) = @_;
		1713
		1714	$self->{load_original} = 1;
		1715	$self->{instantiate_time} = $cf::RUNTIME;
		1716	$self->last_access ($cf::RUNTIME);
		1717	$self->instantiate;
1298	}	1718	}
1299		1719
1300	sub load_header {	1720	sub load_header {
1301	my ($self) = @_;	1721	my ($self) = @_;
1302		1722
1303	if ($self->load_temp) {	1723	if ($self->load_header_temp) {
1304	$self->last_access ((delete $self->{last_access})	1724	$self->prepare_temp;
1305	|| $cf::RUNTIME); #d#
1306	# safety
1307	$self->{instantiate_time} = $cf::RUNTIME
1308	if $self->{instantiate_time} > $cf::RUNTIME;
1309	} else {	1725	} else {
1310	$self->load_orig	1726	$self->load_header_orig
1311	or return;	1727	or return;
1312		1728	$self->prepare_orig;
1313	$self->{load_original} = 1;
1314	$self->{instantiate_time} = $cf::RUNTIME;
1315	$self->last_access ($cf::RUNTIME);
1316	$self->instantiate;
1317	}	1729	}
		1730
		1731	$self->{deny_reset} = 1
		1732	if $self->no_reset;
		1733
		1734	$self->default_region (cf::region::find_by_path $self->{path})
		1735	unless $self->default_region;
1318		1736
1319	1	1737	1
1320	}	1738	}
1321		1739
1322	sub find;	1740	sub find;
…		…
1335	$map->{last_save} = $cf::RUNTIME;	1753	$map->{last_save} = $cf::RUNTIME;
1336		1754
1337	$map->load_header	1755	$map->load_header
1338	or return;	1756	or return;
1339		1757
1340	if ($map->should_reset) {	1758	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1759	# doing this can freeze the server in a sync job, obviously
1341	$cf::WAIT_FOR_TICK->wait;	1760	#$cf::WAIT_FOR_TICK->wait;
1342	$map->reset;	1761	$map->reset;
1343	undef $guard;	1762	undef $guard;
1344	$map = find $path	1763	return find $path;
1345	or return;
1346	}	1764	}
1347		1765
1348	$cf::MAP{$path} = $map	1766	$cf::MAP{$path} = $map
1349	}	1767	}
1350	}	1768	}
		1769
		1770	sub pre_load { }
		1771	sub post_load { }
1351		1772
1352	sub load {	1773	sub load {
1353	my ($self) = @_;	1774	my ($self) = @_;
1354		1775
		1776	local $self->{deny_reset} = 1; # loading can take a long time
		1777
1355	my $path = $self->{path};	1778	my $path = $self->{path};
		1779
		1780	{
1356	my $guard = cf::lock_acquire "map_load:$path";	1781	my $guard = cf::lock_acquire "map_load:$path";
1357		1782
1358	return if $self->in_memory != cf::MAP_SWAPPED;	1783	return if $self->in_memory != cf::MAP_SWAPPED;
1359		1784
1360	$self->in_memory (cf::MAP_LOADING);	1785	$self->in_memory (cf::MAP_LOADING);
1361		1786
1362	$self->alloc;	1787	$self->alloc;
1363	$self->_load_objects ($self->{load_path}, 1)
1364	or return;
1365		1788
1366	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1789	$self->pre_load;
1367	if delete $self->{load_original};
1368
1369	if (my $uniq = $self->uniq_path) {
1370	utf8::encode $uniq;
1371	if (aio_open $uniq, O_RDONLY, 0) {
1372	$self->clear_unique_items;
1373	$self->_load_objects ($uniq, 0);
1374	}
1375	}
1376
1377	Coro::cede;
1378
1379	# now do the right thing for maps
1380	$self->link_multipart_objects;
1381
1382	unless ($self->{deny_activate}) {
1383	$self->decay_objects;
1384	$self->fix_auto_apply;
1385	$self->update_buttons;
1386	Coro::cede;	1790	Coro::cede;
1387	$self->set_darkness_map;	1791
		1792	$self->_load_objects ($self->{load_path}, 1)
		1793	or return;
		1794
		1795	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1796	if delete $self->{load_original};
		1797
		1798	if (my $uniq = $self->uniq_path) {
		1799	utf8::encode $uniq;
		1800	if (aio_open $uniq, O_RDONLY, 0) {
		1801	$self->clear_unique_items;
		1802	$self->_load_objects ($uniq, 0);
		1803	}
		1804	}
		1805
		1806	Coro::cede;
		1807	# now do the right thing for maps
		1808	$self->link_multipart_objects;
1388	$self->difficulty ($self->estimate_difficulty)	1809	$self->difficulty ($self->estimate_difficulty)
1389	unless $self->difficulty;	1810	unless $self->difficulty;
1390	Coro::cede;	1811	Coro::cede;
		1812
		1813	unless ($self->{deny_activate}) {
		1814	$self->decay_objects;
		1815	$self->fix_auto_apply;
		1816	$self->update_buttons;
		1817	Coro::cede;
		1818	$self->set_darkness_map;
		1819	Coro::cede;
1391	$self->activate;	1820	$self->activate;
1392	}	1821	}
1393		1822
1394	$self->in_memory (cf::MAP_IN_MEMORY);	1823	$self->in_memory (cf::MAP_IN_MEMORY);
		1824	}
		1825
		1826	$self->post_load;
1395	}	1827	}
1396		1828
1397	sub customise_for {	1829	sub customise_for {
1398	my ($self, $ob) = @_;	1830	my ($self, $ob) = @_;
1399		1831
1400	return find "~" . $ob->name . "/" . $self->{path}	1832	return find "~" . $ob->name . "/" . $self->{path}
1401	if $self->per_player;	1833	if $self->per_player;
		1834
		1835	# return find "?party/" . $ob->name . "/" . $self->{path}
		1836	# if $self->per_party;
1402		1837
1403	$self	1838	$self
1404	}	1839	}
1405		1840
1406	# find and load all maps in the 3x3 area around a map	1841	# find and load all maps in the 3x3 area around a map
…		…
1438		1873
1439	cf::sync_job { $map->load };	1874	cf::sync_job { $map->load };
1440	}	1875	}
1441		1876
1442	our %MAP_PREFETCH;	1877	our %MAP_PREFETCH;
1443	our $MAP_PREFETCHER = Coro::async {	1878	our $MAP_PREFETCHER = undef;
1444	while () {
1445	for my $path (keys %MAP_PREFETCH) {
1446	my $map = find $path
1447	or next;
1448	$map->load;
1449
1450	delete $MAP_PREFETCH{$path};
1451	}
1452	Coro::schedule;
1453	}
1454	};
1455		1879
1456	sub find_async {	1880	sub find_async {
1457	my ($path, $origin) = @_;	1881	my ($path, $origin) = @_;
1458		1882
1459	$path = normalise $path, $origin && $origin->{path};	1883	$path = normalise $path, $origin && $origin->{path};
1460		1884
1461	if (my $map = $cf::MAP{$path}) {	1885	if (my $map = $cf::MAP{$path}) {
1462	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1886	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1463	}	1887	}
1464		1888
1465	$MAP_PREFETCH{$path} = 0;	1889	undef $MAP_PREFETCH{$path};
		1890	$MAP_PREFETCHER ||= cf::async {
		1891	while (%MAP_PREFETCH) {
		1892	for my $path (keys %MAP_PREFETCH) {
		1893	my $map = find $path
		1894	or next;
		1895	$map->load;
		1896
		1897	delete $MAP_PREFETCH{$path};
		1898	}
		1899	}
		1900	undef $MAP_PREFETCHER;
		1901	};
1466	$MAP_PREFETCHER->ready;	1902	$MAP_PREFETCHER->prio (6);
1467		1903
1468	()	1904	()
1469	}	1905	}
1470		1906
1471	sub save {	1907	sub save {
…		…
1516		1952
1517	sub reset_at {	1953	sub reset_at {
1518	my ($self) = @_;	1954	my ($self) = @_;
1519		1955
1520	# TODO: safety, remove and allow resettable per-player maps	1956	# TODO: safety, remove and allow resettable per-player maps
1521	return 1e99 if $self->isa ("ext::map_per_player");#d#
1522	return 1e99 if $self->{deny_reset};	1957	return 1e99 if $self->{deny_reset};
1523		1958
1524	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1959	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1525	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1960	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1526		1961
…		…
1531	my ($self) = @_;	1966	my ($self) = @_;
1532		1967
1533	$self->reset_at <= $cf::RUNTIME	1968	$self->reset_at <= $cf::RUNTIME
1534	}	1969	}
1535		1970
1536	sub rename {
1537	my ($self, $new_path) = @_;
1538
1539	normalise $new_path;
1540
1541	$self->unlink_save;
1542
1543	delete $cf::MAP{$self->path};
1544	$self->{path} = $new_path; $self->path ($self->{path});
1545	$cf::MAP{$self->path} = $self;
1546
1547	$self->save;
1548	}
1549
1550	sub reset {	1971	sub reset {
1551	my ($self) = @_;	1972	my ($self) = @_;
1552		1973
1553	my $lock = cf::lock_acquire "map_data:$self->{path}";	1974	my $lock = cf::lock_acquire "map_data:$self->{path}";
1554		1975
1555	return if $self->players;	1976	return if $self->players;
1556	return if $self->isa ("ext::map_per_player");#d#
1557		1977
1558	warn "resetting map ", $self->path;#d#	1978	warn "resetting map ", $self->path;
		1979
		1980	$self->in_memory (cf::MAP_SWAPPED);
		1981
		1982	# need to save uniques path
		1983	unless ($self->{deny_save}) {
		1984	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1985
		1986	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1987	if $uniq;
		1988	}
1559		1989
1560	delete $cf::MAP{$self->path};	1990	delete $cf::MAP{$self->path};
1561		1991
1562	$self->in_memory (cf::MAP_SWAPPED);
1563	$self->clear;	1992	$self->clear;
1564		1993
1565	$_->clear_links_to ($self) for values %cf::MAP;	1994	$_->clear_links_to ($self) for values %cf::MAP;
1566		1995
1567	$self->unlink_save;	1996	$self->unlink_save;
…		…
1571	my $nuke_counter = "aaaa";	2000	my $nuke_counter = "aaaa";
1572		2001
1573	sub nuke {	2002	sub nuke {
1574	my ($self) = @_;	2003	my ($self) = @_;
1575		2004
		2005	delete $cf::MAP{$self->path};
		2006
		2007	$self->unlink_save;
		2008
		2009	bless $self, "cf::map";
		2010	delete $self->{deny_reset};
1576	$self->{deny_save} = 1;	2011	$self->{deny_save} = 1;
1577	$self->reset_timeout (1);	2012	$self->reset_timeout (1);
1578	$self->rename ("{nuke}/" . ($nuke_counter++));	2013	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2014
		2015	$cf::MAP{$self->path} = $self;
		2016
1579	$self->reset; # polite request, might not happen	2017	$self->reset; # polite request, might not happen
		2018	}
		2019
		2020	=item $maps = cf::map::tmp_maps
		2021
		2022	Returns an arrayref with all map paths of currently instantiated and saved
		2023	maps. May block.
		2024
		2025	=cut
		2026
		2027	sub tmp_maps() {
		2028	[
		2029	map {
		2030	utf8::decode $_;
		2031	/\.map$/
		2032	? normalise $_
		2033	: ()
		2034	} @{ aio_readdir $TMPDIR or [] }
		2035	]
		2036	}
		2037
		2038	=item $maps = cf::map::random_maps
		2039
		2040	Returns an arrayref with all map paths of currently instantiated and saved
		2041	random maps. May block.
		2042
		2043	=cut
		2044
		2045	sub random_maps() {
		2046	[
		2047	map {
		2048	utf8::decode $_;
		2049	/\.map$/
		2050	? normalise "?random/$_"
		2051	: ()
		2052	} @{ aio_readdir $RANDOMDIR or [] }
		2053	]
1580	}	2054	}
1581		2055
1582	=item cf::map::unique_maps	2056	=item cf::map::unique_maps
1583		2057
1584	Returns an arrayref of paths of all shared maps that have	2058	Returns an arrayref of paths of all shared maps that have
1585	instantiated unique items. May block.	2059	instantiated unique items. May block.
1586		2060
1587	=cut	2061	=cut
1588		2062
1589	sub unique_maps() {	2063	sub unique_maps() {
1590	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2064	[
1591	or return;	2065	map {
1592
1593	my @paths;
1594
1595	for (@$files) {
1596	utf8::decode $_;	2066	utf8::decode $_;
1597	next if /\.pst$/;
1598	next unless /^$PATH_SEP/o;
1599
1600	s/\.map$//;	2067	/\.map$/
1601	push @paths, $_;	2068	? normalise $_
		2069	: ()
		2070	} @{ aio_readdir $UNIQUEDIR or [] }
1602	}	2071	]
1603
1604	\@paths
1605	}	2072	}
1606		2073
1607	package cf;	2074	package cf;
1608		2075
1609	=back	2076	=back
…		…
1655		2122
1656	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2123	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1657		2124
1658	if ($self->{record_replies}) {	2125	if ($self->{record_replies}) {
1659	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2126	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2127
1660	} else {	2128	} else {
		2129	my $pl = $self->contr;
		2130
		2131	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2132	my $diag = $pl->{npc_dialog};
		2133	$diag->{pl}->ext_reply (
		2134	$diag->{id},
		2135	msgtype => "reply",
		2136	msg => $diag->{pl}->expand_cfpod ($msg),
		2137	add_topics => []
		2138	);
		2139
		2140	} else {
1661	$msg = $npc->name . " says: $msg" if $npc;	2141	$msg = $npc->name . " says: $msg" if $npc;
1662	$self->message ($msg, $flags);	2142	$self->message ($msg, $flags);
		2143	}
1663	}	2144	}
1664	}	2145	}
1665		2146
1666	=item $player_object->may ("access")	2147	=item $player_object->may ("access")
1667		2148
…		…
1700	=cut	2181	=cut
1701		2182
1702	sub link_map {	2183	sub link_map {
1703	unless ($LINK_MAP) {	2184	unless ($LINK_MAP) {
1704	$LINK_MAP = cf::map::find "{link}"	2185	$LINK_MAP = cf::map::find "{link}"
1705	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2186	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1706	$LINK_MAP->load;	2187	$LINK_MAP->load;
1707	}	2188	}
1708		2189
1709	$LINK_MAP	2190	$LINK_MAP
1710	}	2191	}
…		…
1715	$self->deactivate_recursive;	2196	$self->deactivate_recursive;
1716		2197
1717	return if UNIVERSAL::isa $self->map, "ext::map_link";	2198	return if UNIVERSAL::isa $self->map, "ext::map_link";
1718		2199
1719	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2200	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1720	if $self->map;	2201	if $self->map && $self->map->{path} ne "{link}";
1721		2202
1722	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2203	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1723	}	2204	}
1724		2205
1725	sub cf::object::player::leave_link {	2206	sub cf::object::player::leave_link {
1726	my ($self, $map, $x, $y) = @_;	2207	my ($self, $map, $x, $y) = @_;
		2208
		2209	return unless $self->contr->active;
1727		2210
1728	my $link_pos = delete $self->{_link_pos};	2211	my $link_pos = delete $self->{_link_pos};
1729		2212
1730	unless ($map) {	2213	unless ($map) {
1731	# restore original map position	2214	# restore original map position
…		…
1749	$map->load;	2232	$map->load;
1750	$map->load_diag;	2233	$map->load_diag;
1751		2234
1752	return unless $self->contr->active;	2235	return unless $self->contr->active;
1753	$self->activate_recursive;	2236	$self->activate_recursive;
		2237
		2238	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1754	$self->enter_map ($map, $x, $y);	2239	$self->enter_map ($map, $x, $y);
1755	}	2240	}
1756		2241
1757	cf::player->attach (
1758	on_logout => sub {
1759	my ($pl) = @_;
1760
1761	# abort map switching before logout
1762	if ($pl->ob->{_link_pos}) {
1763	cf::sync_job {
1764	$pl->ob->leave_link
1765	};
1766	}
1767	},
1768	on_login => sub {
1769	my ($pl) = @_;
1770
1771	# try to abort aborted map switching on player login :)
1772	# should happen only on crashes
1773	if ($pl->ob->{_link_pos}) {
1774	$pl->ob->enter_link;
1775	(async {
1776	# we need this sleep as the login has a concurrent enter_exit running
1777	# and this sleep increases chances of the player not ending up in scorn
1778	$pl->ob->reply (undef,
1779	"There was an internal problem at your last logout, "
1780	. "the server will try to bring you to your intended destination in a second.",
1781	cf::NDI_RED);
1782	Coro::Timer::sleep 1;
1783	$pl->ob->leave_link;
1784	})->prio (2);
1785	}
1786	},
1787	);
1788
1789	=item $player_object->goto ($path, $x, $y)	2242	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1790		2243
		2244	Moves the player to the given map-path and coordinates by first freezing
		2245	her, loading and preparing them map, calling the provided $check callback
		2246	that has to return the map if sucecssful, and then unfreezes the player on
		2247	the new (success) or old (failed) map position.
		2248
1791	=cut	2249	=cut
		2250
		2251	our $GOTOGEN;
1792		2252
1793	sub cf::object::player::goto {	2253	sub cf::object::player::goto {
1794	my ($self, $path, $x, $y) = @_;	2254	my ($self, $path, $x, $y, $check) = @_;
		2255
		2256	# do generation counting so two concurrent goto's will be executed in-order
		2257	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1795		2258
1796	$self->enter_link;	2259	$self->enter_link;
1797		2260
1798	(async {	2261	(async {
		2262	my $map = eval {
1799	my $map = cf::map::find $path;	2263	my $map = cf::map::find $path;
		2264
		2265	if ($map) {
1800	$map = $map->customise_for ($self) if $map;	2266	$map = $map->customise_for ($self);
1801		2267	$map = $check->($map) if $check && $map;
1802	# warn "entering ", $map->path, " at ($x, $y)\n"	2268	} else {
1803	# if $map;
1804
1805	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2269	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2270	}
1806		2271
		2272	$map
		2273	};
		2274
		2275	if ($@) {
		2276	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2277	LOG llevError | logBacktrace, Carp::longmess $@;
		2278	}
		2279
		2280	if ($gen == $self->{_goto_generation}) {
		2281	delete $self->{_goto_generation};
1807	$self->leave_link ($map, $x, $y);	2282	$self->leave_link ($map, $x, $y);
		2283	}
1808	})->prio (1);	2284	})->prio (1);
1809	}	2285	}
1810		2286
1811	=item $player_object->enter_exit ($exit_object)	2287	=item $player_object->enter_exit ($exit_object)
1812		2288
…		…
1814		2290
1815	sub parse_random_map_params {	2291	sub parse_random_map_params {
1816	my ($spec) = @_;	2292	my ($spec) = @_;
1817		2293
1818	my $rmp = { # defaults	2294	my $rmp = { # defaults
1819	xsize => 10,	2295	xsize => (cf::rndm 15, 40),
1820	ysize => 10,	2296	ysize => (cf::rndm 15, 40),
		2297	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2298	#layout => string,
1821	};	2299	};
1822		2300
1823	for (split /\n/, $spec) {	2301	for (split /\n/, $spec) {
1824	my ($k, $v) = split /\s+/, $_, 2;	2302	my ($k, $v) = split /\s+/, $_, 2;
1825		2303
…		…
1829	$rmp	2307	$rmp
1830	}	2308	}
1831		2309
1832	sub prepare_random_map {	2310	sub prepare_random_map {
1833	my ($exit) = @_;	2311	my ($exit) = @_;
		2312
		2313	my $guard = cf::lock_acquire "exit_prepare:$exit";
1834		2314
1835	# all this does is basically replace the /! path by	2315	# all this does is basically replace the /! path by
1836	# a new random map path (?random/...) with a seed	2316	# a new random map path (?random/...) with a seed
1837	# that depends on the exit object	2317	# that depends on the exit object
1838		2318
1839	my $rmp = parse_random_map_params $exit->msg;	2319	my $rmp = parse_random_map_params $exit->msg;
1840		2320
1841	if ($exit->map) {	2321	if ($exit->map) {
1842	$rmp->{region} = $exit->map->region_name;	2322	$rmp->{region} = $exit->region->name;
1843	$rmp->{origin_map} = $exit->map->path;	2323	$rmp->{origin_map} = $exit->map->path;
1844	$rmp->{origin_x} = $exit->x;	2324	$rmp->{origin_x} = $exit->x;
1845	$rmp->{origin_y} = $exit->y;	2325	$rmp->{origin_y} = $exit->y;
1846	}	2326	}
1847		2327
1848	$rmp->{random_seed} ||= $exit->random_seed;	2328	$rmp->{random_seed} ||= $exit->random_seed;
1849		2329
1850	my $data = cf::to_json $rmp;	2330	my $data = cf::to_json $rmp;
1851	my $md5 = Digest::MD5::md5_hex $data;	2331	my $md5 = Digest::MD5::md5_hex $data;
		2332	my $meta = "$RANDOMDIR/$md5.meta";
1852		2333
1853	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2334	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1854	aio_write $fh, 0, (length $data), $data, 0;	2335	aio_write $fh, 0, (length $data), $data, 0;
		2336	undef $fh;
		2337	aio_rename "$meta~", $meta;
1855		2338
1856	$exit->slaying ("?random/$md5");	2339	$exit->slaying ("?random/$md5");
1857	$exit->msg (undef);	2340	$exit->msg (undef);
1858	}	2341	}
1859	}	2342	}
…		…
1861	sub cf::object::player::enter_exit {	2344	sub cf::object::player::enter_exit {
1862	my ($self, $exit) = @_;	2345	my ($self, $exit) = @_;
1863		2346
1864	return unless $self->type == cf::PLAYER;	2347	return unless $self->type == cf::PLAYER;
1865		2348
		2349	if ($exit->slaying eq "/!") {
		2350	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2351	# the problem is that $exit might not survive long enough
		2352	# so it needs to be done right now, right here
		2353	cf::sync_job { prepare_random_map $exit };
		2354	}
		2355
		2356	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2357	my $hp = $exit->stats->hp;
		2358	my $sp = $exit->stats->sp;
		2359
1866	$self->enter_link;	2360	$self->enter_link;
		2361
		2362	# if exit is damned, update players death & WoR home-position
		2363	$self->contr->savebed ($slaying, $hp, $sp)
		2364	if $exit->flag (FLAG_DAMNED);
1867		2365
1868	(async {	2366	(async {
1869	$self->deactivate_recursive; # just to be sure	2367	$self->deactivate_recursive; # just to be sure
1870	unless (eval {	2368	unless (eval {
1871	prepare_random_map $exit	2369	$self->goto ($slaying, $hp, $sp);
1872	if $exit->slaying eq "/!";
1873
1874	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1875	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1876		2370
1877	1;	2371	1;
1878	}) {	2372	}) {
1879	$self->message ("Something went wrong deep within the crossfire server. "	2373	$self->message ("Something went wrong deep within the crossfire server. "
1880	. "I'll try to bring you back to the map you were before. "	2374	. "I'll try to bring you back to the map you were before. "
1881	. "Please report this to the dungeon master!",	2375	. "Please report this to the dungeon master!",
1882	cf::NDI_UNIQUE | cf::NDI_RED);	2376	cf::NDI_UNIQUE | cf::NDI_RED);
1883		2377
1884	warn "ERROR in enter_exit: $@";	2378	warn "ERROR in enter_exit: $@";
1885	$self->leave_link;	2379	$self->leave_link;
1886	}	2380	}
1887	})->prio (1);	2381	})->prio (1);
…		…
1900		2394
1901	sub cf::client::send_drawinfo {	2395	sub cf::client::send_drawinfo {
1902	my ($self, $text, $flags) = @_;	2396	my ($self, $text, $flags) = @_;
1903		2397
1904	utf8::encode $text;	2398	utf8::encode $text;
1905	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2399	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1906	}	2400	}
1907		2401
		2402	=item $client->send_msg ($color, $type, $msg, [extra...])
		2403
		2404	Send a drawinfo or msg packet to the client, formatting the msg for the
		2405	client if neccessary. C<$type> should be a string identifying the type of
		2406	the message, with C<log> being the default. If C<$color> is negative, suppress
		2407	the message unless the client supports the msg packet.
		2408
		2409	=cut
		2410
		2411	sub cf::client::send_msg {
		2412	my ($self, $color, $type, $msg, @extra) = @_;
		2413
		2414	$msg = $self->pl->expand_cfpod ($msg);
		2415
		2416	return unless @extra || length $msg;
		2417
		2418	if ($self->can_msg) {
		2419	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2420	} else {
		2421	# replace some tags by gcfclient-compatible ones
		2422	for ($msg) {
		2423	1 while
		2424	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2425	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2426	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2427	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2428	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2429	}
		2430
		2431	if ($color >= 0) {
		2432	if (0 && $msg =~ /\[/) {
		2433	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2434	} else {
		2435	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2436	$self->send_packet ("drawinfo $color $msg")
		2437	}
		2438	}
		2439	}
		2440	}
		2441
		2442	=item $client->ext_event ($type, %msg)
		2443
		2444	Sends an ext event to the client.
		2445
		2446	=cut
		2447
		2448	sub cf::client::ext_event($$%) {
		2449	my ($self, $type, %msg) = @_;
		2450
		2451	$msg{msgtype} = "event_$type";
		2452	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2453	}
1908		2454
1909	=item $success = $client->query ($flags, "text", \&cb)	2455	=item $success = $client->query ($flags, "text", \&cb)
1910		2456
1911	Queues a query to the client, calling the given callback with	2457	Queues a query to the client, calling the given callback with
1912	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2458	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1913	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2459	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1914		2460
1915	Queries can fail, so check the return code. Or don't, as queries will become	2461	Queries can fail, so check the return code. Or don't, as queries will
1916	reliable at some point in the future.	2462	become reliable at some point in the future.
1917		2463
1918	=cut	2464	=cut
1919		2465
1920	sub cf::client::query {	2466	sub cf::client::query {
1921	my ($self, $flags, $text, $cb) = @_;	2467	my ($self, $flags, $text, $cb) = @_;
…		…
1929	utf8::encode $text;	2475	utf8::encode $text;
1930	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2476	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1931		2477
1932	$self->send_packet ($self->{query_queue}[0][0])	2478	$self->send_packet ($self->{query_queue}[0][0])
1933	if @{ $self->{query_queue} } == 1;	2479	if @{ $self->{query_queue} } == 1;
		2480
		2481	1
1934	}	2482	}
1935		2483
1936	cf::client->attach (	2484	cf::client->attach (
		2485	on_connect => sub {
		2486	my ($ns) = @_;
		2487
		2488	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2489	},
1937	on_reply => sub {	2490	on_reply => sub {
1938	my ($ns, $msg) = @_;	2491	my ($ns, $msg) = @_;
1939		2492
1940	# this weird shuffling is so that direct followup queries	2493	# this weird shuffling is so that direct followup queries
1941	# get handled first	2494	# get handled first
1942	my $queue = delete $ns->{query_queue}	2495	my $queue = delete $ns->{query_queue}
1943	or return; # be conservative, not sure how that can happen, but we saw a crash here	2496	or return; # be conservative, not sure how that can happen, but we saw a crash here
1944		2497
1945	(shift @$queue)->[1]->($msg);	2498	(shift @$queue)->[1]->($msg);
		2499	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1946		2500
1947	push @{ $ns->{query_queue} }, @$queue;	2501	push @{ $ns->{query_queue} }, @$queue;
1948		2502
1949	if (@{ $ns->{query_queue} } == @$queue) {	2503	if (@{ $ns->{query_queue} } == @$queue) {
1950	if (@$queue) {	2504	if (@$queue) {
…		…
1952	} else {	2506	} else {
1953	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2507	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1954	}	2508	}
1955	}	2509	}
1956	},	2510	},
		2511	on_exticmd => sub {
		2512	my ($ns, $buf) = @_;
		2513
		2514	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2515
		2516	if (ref $msg) {
		2517	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2518	if (my %reply = $cb->($ns, $msg)) {
		2519	$reply{msgid} = $msg->{msgid};
		2520	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2521	}
		2522	}
		2523	} else {
		2524	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2525	}
		2526
		2527	cf::override;
		2528	},
1957	);	2529	);
1958		2530
1959	=item $client->async (\&cb)	2531	=item $client->async (\&cb)
1960		2532
1961	Create a new coroutine, running the specified callback. The coroutine will	2533	Create a new coroutine, running the specified callback. The coroutine will
…		…
2008		2580
2009	# here we export the classes and methods available to script code	2581	# here we export the classes and methods available to script code
2010		2582
2011	=pod	2583	=pod
2012		2584
2013	The following fucntions and emthods are available within a safe environment:	2585	The following functions and methods are available within a safe environment:
2014		2586
2015	cf::object contr pay_amount pay_player map	2587	cf::object
		2588	contr pay_amount pay_player map x y force_find force_add
		2589	insert remove
		2590
2016	cf::object::player player	2591	cf::object::player
2017	cf::player peaceful	2592	player
2018	cf::map trigger	2593
		2594	cf::player
		2595	peaceful
		2596
		2597	cf::map
		2598	trigger
2019		2599
2020	=cut	2600	=cut
2021		2601
2022	for (	2602	for (
2023	["cf::object" => qw(contr pay_amount pay_player map)],	2603	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2604	insert remove)],
2024	["cf::object::player" => qw(player)],	2605	["cf::object::player" => qw(player)],
2025	["cf::player" => qw(peaceful)],	2606	["cf::player" => qw(peaceful)],
2026	["cf::map" => qw(trigger)],	2607	["cf::map" => qw(trigger)],
2027	) {	2608	) {
2028	no strict 'refs';	2609	no strict 'refs';
…		…
2099	=back	2680	=back
2100		2681
2101	=cut	2682	=cut
2102		2683
2103	#############################################################################	2684	#############################################################################
		2685	# the server's init and main functions
2104		2686
2105	=head2 EXTENSION DATABASE SUPPORT	2687	sub load_facedata($) {
		2688	my ($path) = @_;
2106		2689
2107	Crossfire maintains a very simple database for extension use. It can	2690	warn "loading facedata from $path\n";
2108	currently store anything that can be serialised using Storable, which
2109	excludes objects.
2110		2691
2111	The parameter C<$family> should best start with the name of the extension	2692	my $facedata;
2112	using it, it should be unique.	2693	0 < aio_load $path, $facedata
		2694	or die "$path: $!";
2113		2695
2114	=over 4	2696	$facedata = Coro::Storable::thaw $facedata;
2115		2697
2116	=item $hashref = cf::db_get $family	2698	$facedata->{version} == 2
		2699	or cf::cleanup "$path: version mismatch, cannot proceed.";
2117		2700
2118	Return a hashref for use by the extension C<$family>, which can be
2119	modified. After modifications, you have to call C<cf::db_dirty> or
2120	C<cf::db_sync>.
2121
2122	=item $value = cf::db_get $family => $key
2123
2124	Returns a single value from the database
2125
2126	=item cf::db_put $family => $hashref
2127
2128	Stores the given family hashref into the database. Updates are delayed, if
2129	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2130
2131	=item cf::db_put $family => $key => $value
2132
2133	Stores the given C<$value> in the family hash. Updates are delayed, if you
2134	want the data to be synced to disk immediately, use C<cf::db_sync>.
2135
2136	=item cf::db_dirty
2137
2138	Marks the database as dirty, to be updated at a later time.
2139
2140	=item cf::db_sync
2141
2142	Immediately write the database to disk I<if it is dirty>.
2143
2144	=cut
2145
2146	our $DB;
2147
2148	{
2149	my $path = cf::localdir . "/database.pst";
2150
2151	sub db_load() {
2152	$DB = stat $path ? Storable::retrieve $path : { };
2153	}	2701	{
		2702	my $faces = $facedata->{faceinfo};
2154		2703
2155	my $pid;	2704	while (my ($face, $info) = each %$faces) {
2156		2705	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2157	sub db_save() {	2706	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2158	waitpid $pid, 0 if $pid;	2707	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2159	if (0 == ($pid = fork)) {	2708	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2160	$DB->{_meta}{version} = 1;	2709	Coro::cede;
2161	Storable::nstore $DB, "$path~";
2162	rename "$path~", $path;
2163	cf::_exit 0 if defined $pid;
2164	}
2165	}
2166
2167	my $dirty;
2168
2169	sub db_sync() {
2170	db_save if $dirty;
2171	undef $dirty;
2172	}
2173
2174	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2175	db_sync;
2176	});
2177
2178	sub db_dirty() {
2179	$dirty = 1;
2180	$idle->start;
2181	}
2182
2183	sub db_get($;$) {
2184	@_ >= 2
2185	? $DB->{$_[0]}{$_[1]}
2186	: ($DB->{$_[0]} ||= { })
2187	}
2188
2189	sub db_put($$;$) {
2190	if (@_ >= 3) {
2191	$DB->{$_[0]}{$_[1]} = $_[2];
2192	} else {
2193	$DB->{$_[0]} = $_[1];
2194	}
2195	db_dirty;
2196	}
2197
2198	cf::global->attach (
2199	prio => 10000,
2200	on_cleanup => sub {
2201	db_sync;
2202	},	2710	}
2203	);
2204	}
2205		2711
2206	#############################################################################	2712	while (my ($face, $info) = each %$faces) {
2207	# the server's main()	2713	next unless $info->{smooth};
		2714	my $idx = cf::face::find $face
		2715	or next;
		2716	if (my $smooth = cf::face::find $info->{smooth}) {
		2717	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2718	} else {
		2719	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2720	}
		2721	Coro::cede;
		2722	}
		2723	}
		2724
		2725	{
		2726	my $anims = $facedata->{animinfo};
		2727
		2728	while (my ($anim, $info) = each %$anims) {
		2729	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2730	Coro::cede;
		2731	}
		2732
		2733	cf::anim::invalidate_all; # d'oh
		2734	}
		2735
		2736	1
		2737	}
		2738
		2739	sub reload_regions {
		2740	load_resource_file "$MAPDIR/regions"
		2741	or die "unable to load regions file\n";
		2742	}
		2743
		2744	sub reload_facedata {
		2745	load_facedata "$DATADIR/facedata"
		2746	or die "unable to load facedata\n";
		2747	}
		2748
		2749	sub reload_archetypes {
		2750	load_resource_file "$DATADIR/archetypes"
		2751	or die "unable to load archetypes\n";
		2752	#d# NEED to laod twice to resolve forward references
		2753	# this really needs to be done in an extra post-pass
		2754	# (which needs to be synchronous, so solve it differently)
		2755	load_resource_file "$DATADIR/archetypes"
		2756	or die "unable to load archetypes\n";
		2757	}
		2758
		2759	sub reload_treasures {
		2760	load_resource_file "$DATADIR/treasures"
		2761	or die "unable to load treasurelists\n";
		2762	}
		2763
		2764	sub reload_resources {
		2765	warn "reloading resource files...\n";
		2766
		2767	reload_regions;
		2768	reload_facedata;
		2769	#reload_archetypes;#d#
		2770	reload_archetypes;
		2771	reload_treasures;
		2772
		2773	warn "finished reloading resource files\n";
		2774	}
		2775
		2776	sub init {
		2777	reload_resources;
		2778	}
2208		2779
2209	sub cfg_load {	2780	sub cfg_load {
2210	open my $fh, "<:utf8", cf::confdir . "/config"	2781	open my $fh, "<:utf8", "$CONFDIR/config"
2211	or return;	2782	or return;
2212		2783
2213	local $/;	2784	local $/;
2214	*CFG = YAML::Syck::Load <$fh>;	2785	*CFG = YAML::Syck::Load <$fh>;
2215		2786
…		…
2229		2800
2230	sub main {	2801	sub main {
2231	# we must not ever block the main coroutine	2802	# we must not ever block the main coroutine
2232	local $Coro::idle = sub {	2803	local $Coro::idle = sub {
2233	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2804	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2805	(async {
2234	async { Event::one_event };	2806	Event::one_event;
		2807	})->prio (Coro::PRIO_MAX);
2235	};	2808	};
2236		2809
2237	cfg_load;	2810	cfg_load;
2238	db_load;	2811	db_init;
2239	load_extensions;	2812	load_extensions;
		2813
		2814	$TICK_WATCHER->start;
2240	Event::loop;	2815	Event::loop;
2241	}	2816	}
2242		2817
2243	#############################################################################	2818	#############################################################################
2244	# initialisation and cleanup	2819	# initialisation and cleanup
2245		2820
2246	# install some emergency cleanup handlers	2821	# install some emergency cleanup handlers
2247	BEGIN {	2822	BEGIN {
2248	for my $signal (qw(INT HUP TERM)) {	2823	for my $signal (qw(INT HUP TERM)) {
2249	Event->signal (	2824	Event->signal (
		2825	reentrant => 0,
2250	data => WF_AUTOCANCEL,	2826	data => WF_AUTOCANCEL,
2251	signal => $signal,	2827	signal => $signal,
		2828	prio => 0,
2252	cb => sub {	2829	cb => sub {
2253	cf::cleanup "SIG$signal";	2830	cf::cleanup "SIG$signal";
2254	},	2831	},
2255	);	2832	);
2256	}	2833	}
		2834	}
		2835
		2836	sub write_runtime {
		2837	my $runtime = "$LOCALDIR/runtime";
		2838
		2839	# first touch the runtime file to show we are still running:
		2840	# the fsync below can take a very very long time.
		2841
		2842	IO::AIO::aio_utime $runtime, undef, undef;
		2843
		2844	my $guard = cf::lock_acquire "write_runtime";
		2845
		2846	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2847	or return;
		2848
		2849	my $value = $cf::RUNTIME + 90 + 10;
		2850	# 10 is the runtime save interval, for a monotonic clock
		2851	# 60 allows for the watchdog to kill the server.
		2852
		2853	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2854	and return;
		2855
		2856	# always fsync - this file is important
		2857	aio_fsync $fh
		2858	and return;
		2859
		2860	# touch it again to show we are up-to-date
		2861	aio_utime $fh, undef, undef;
		2862
		2863	close $fh
		2864	or return;
		2865
		2866	aio_rename "$runtime~", $runtime
		2867	and return;
		2868
		2869	warn "runtime file written.\n";
		2870
		2871	1
2257	}	2872	}
2258		2873
2259	sub emergency_save() {	2874	sub emergency_save() {
2260	my $freeze_guard = cf::freeze_mainloop;	2875	my $freeze_guard = cf::freeze_mainloop;
2261		2876
…		…
2278	my $map = $cf::MAP{$path} or next;	2893	my $map = $cf::MAP{$path} or next;
2279	$map->valid or next;	2894	$map->valid or next;
2280	$map->save;	2895	$map->save;
2281	}	2896	}
2282	warn "end emergency map save\n";	2897	warn "end emergency map save\n";
		2898
		2899	warn "begin emergency database checkpoint\n";
		2900	BDB::db_env_txn_checkpoint $DB_ENV;
		2901	warn "end emergency database checkpoint\n";
2283	};	2902	};
2284		2903
2285	warn "leave emergency perl save\n";	2904	warn "leave emergency perl save\n";
2286	}	2905	}
2287		2906
		2907	sub post_cleanup {
		2908	my ($make_core) = @_;
		2909
		2910	warn Carp::longmess "post_cleanup backtrace"
		2911	if $make_core;
		2912	}
		2913
2288	sub reload() {	2914	sub do_reload_perl() {
2289	# can/must only be called in main	2915	# can/must only be called in main
2290	if ($Coro::current != $Coro::main) {	2916	if ($Coro::current != $Coro::main) {
2291	warn "can only reload from main coroutine\n";	2917	warn "can only reload from main coroutine";
2292	return;	2918	return;
2293	}	2919	}
2294		2920
2295	warn "reloading...";	2921	warn "reloading...";
2296		2922
2297	warn "freezing server";	2923	warn "entering sync_job";
2298	my $guard = freeze_mainloop;	2924
		2925	cf::sync_job {
		2926	cf::write_runtime; # external watchdog should not bark
2299	cf::emergency_save;	2927	cf::emergency_save;
		2928	cf::write_runtime; # external watchdog should not bark
2300		2929
2301	warn "sync database to disk";	2930	warn "syncing database to disk";
2302	cf::db_sync;	2931	BDB::db_env_txn_checkpoint $DB_ENV;
2303	IO::AIO::flush;
2304		2932
2305	eval {
2306	# if anything goes wrong in here, we should simply crash as we already saved	2933	# if anything goes wrong in here, we should simply crash as we already saved
2307		2934
2308	warn "cancel all watchers";	2935	warn "cancelling all WF_AUTOCANCEL watchers";
2309	for (Event::all_watchers) {	2936	for (Event::all_watchers) {
2310	$_->cancel if $_->data & WF_AUTOCANCEL;	2937	$_->cancel if $_->data & WF_AUTOCANCEL;
2311	}	2938	}
2312		2939
		2940	warn "flushing outstanding aio requests";
		2941	for (;;) {
		2942	BDB::flush;
		2943	IO::AIO::flush;
		2944	Coro::cede;
		2945	last unless IO::AIO::nreqs || BDB::nreqs;
		2946	warn "iterate...";
		2947	}
		2948
		2949	++$RELOAD;
		2950
2313	warn "cancel all extension coros";	2951	warn "cancelling all extension coros";
2314	$_->cancel for values %EXT_CORO;	2952	$_->cancel for values %EXT_CORO;
2315	%EXT_CORO = ();	2953	%EXT_CORO = ();
2316		2954
2317	warn "remove commands";	2955	warn "removing commands";
2318	%COMMAND = ();	2956	%COMMAND = ();
2319		2957
2320	warn "remove ext commands";	2958	warn "removing ext/exti commands";
2321	%EXTCMD = ();	2959	%EXTCMD = ();
		2960	%EXTICMD = ();
2322		2961
2323	warn "unload/nuke all extensions";	2962	warn "unloading/nuking all extensions";
2324	for my $pkg (@EXTS) {	2963	for my $pkg (@EXTS) {
2325	warn "... unloading $pkg";	2964	warn "... unloading $pkg";
2326		2965
2327	if (my $cb = $pkg->can ("unload")) {	2966	if (my $cb = $pkg->can ("unload")) {
2328	eval {	2967	eval {
…		…
2333		2972
2334	warn "... nuking $pkg";	2973	warn "... nuking $pkg";
2335	Symbol::delete_package $pkg;	2974	Symbol::delete_package $pkg;
2336	}	2975	}
2337		2976
2338	warn "unload all perl modules loaded from $LIBDIR";	2977	warn "unloading all perl modules loaded from $LIBDIR";
2339	while (my ($k, $v) = each %INC) {	2978	while (my ($k, $v) = each %INC) {
2340	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2979	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2341		2980
2342	warn "removing <$k>";	2981	warn "... unloading $k";
2343	delete $INC{$k};	2982	delete $INC{$k};
2344		2983
2345	$k =~ s/\.pm$//;	2984	$k =~ s/\.pm$//;
2346	$k =~ s/\//::/g;	2985	$k =~ s/\//::/g;
2347		2986
…		…
2350	}	2989	}
2351		2990
2352	Symbol::delete_package $k;	2991	Symbol::delete_package $k;
2353	}	2992	}
2354		2993
2355	warn "get rid of safe::, as good as possible";	2994	warn "getting rid of safe::, as good as possible";
2356	Symbol::delete_package "safe::$_"	2995	Symbol::delete_package "safe::$_"
2357	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2996	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2358		2997
2359	warn "unload cf.pm \"a bit\"";	2998	warn "unloading cf.pm \"a bit\"";
2360	delete $INC{"cf.pm"};	2999	delete $INC{"cf.pm"};
		3000	delete $INC{"cf/pod.pm"};
2361		3001
2362	# don't, removes xs symbols, too,	3002	# don't, removes xs symbols, too,
2363	# and global variables created in xs	3003	# and global variables created in xs
2364	#Symbol::delete_package __PACKAGE__;	3004	#Symbol::delete_package __PACKAGE__;
2365		3005
		3006	warn "unload completed, starting to reload now";
		3007
2366	warn "reloading cf.pm";	3008	warn "reloading cf.pm";
2367	require cf;	3009	require cf;
2368	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3010	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2369		3011
2370	warn "load config and database again";	3012	warn "loading config and database again";
2371	cf::cfg_load;	3013	cf::cfg_load;
2372	cf::db_load;
2373		3014
2374	warn "load extensions";	3015	warn "loading extensions";
2375	cf::load_extensions;	3016	cf::load_extensions;
2376		3017
2377	warn "reattach attachments to objects/players";	3018	warn "reattaching attachments to objects/players";
2378	_global_reattach;	3019	_global_reattach; # objects, sockets
2379	warn "reattach attachments to maps";	3020	warn "reattaching attachments to maps";
2380	reattach $_ for values %MAP;	3021	reattach $_ for values %MAP;
2381	};	3022	warn "reattaching attachments to players";
		3023	reattach $_ for values %PLAYER;
2382		3024
2383	if ($@) {	3025	warn "leaving sync_job";
		3026
		3027	1
		3028	} or do {
2384	warn $@;	3029	warn $@;
2385	warn "error while reloading, exiting.";	3030	warn "error while reloading, exiting.";
2386	exit 1;	3031	exit 1;
2387	}	3032	};
2388		3033
2389	warn "reloaded";	3034	warn "reloaded";
2390	};	3035	};
2391		3036
		3037	our $RELOAD_WATCHER; # used only during reload
		3038
		3039	sub reload_perl() {
		3040	# doing reload synchronously and two reloads happen back-to-back,
		3041	# coro crashes during coro_state_free->destroy here.
		3042
		3043	$RELOAD_WATCHER ||= Event->timer (
		3044	reentrant => 0,
		3045	after => 0,
		3046	data => WF_AUTOCANCEL,
		3047	cb => sub {
		3048	do_reload_perl;
		3049	undef $RELOAD_WATCHER;
		3050	},
		3051	);
		3052	}
		3053
2392	register_command "reload" => sub {	3054	register_command "reload" => sub {
2393	my ($who, $arg) = @_;	3055	my ($who, $arg) = @_;
2394		3056
2395	if ($who->flag (FLAG_WIZ)) {	3057	if ($who->flag (FLAG_WIZ)) {
2396	$who->message ("start of reload.");
2397	reload;
2398	$who->message ("end of reload.");	3058	$who->message ("reloading server.");
		3059	async { reload_perl };
2399	}	3060	}
2400	};	3061	};
2401		3062
2402	unshift @INC, $LIBDIR;	3063	unshift @INC, $LIBDIR;
2403		3064
		3065	my $bug_warning = 0;
		3066
		3067	our @WAIT_FOR_TICK;
		3068	our @WAIT_FOR_TICK_BEGIN;
		3069
		3070	sub wait_for_tick {
		3071	return unless $TICK_WATCHER->is_active;
		3072	return if $Coro::current == $Coro::main;
		3073
		3074	my $signal = new Coro::Signal;
		3075	push @WAIT_FOR_TICK, $signal;
		3076	$signal->wait;
		3077	}
		3078
		3079	sub wait_for_tick_begin {
		3080	return unless $TICK_WATCHER->is_active;
		3081	return if $Coro::current == $Coro::main;
		3082
		3083	my $signal = new Coro::Signal;
		3084	push @WAIT_FOR_TICK_BEGIN, $signal;
		3085	$signal->wait;
		3086	}
		3087
		3088	my $min = 1e6;#d#
		3089	my $avg = 10;
2404	$TICK_WATCHER = Event->timer (	3090	$TICK_WATCHER = Event->timer (
2405	reentrant => 0,	3091	reentrant => 0,
		3092	parked => 1,
2406	prio => 0,	3093	prio => 0,
2407	at => $NEXT_TICK || $TICK,	3094	at => $NEXT_TICK || $TICK,
2408	data => WF_AUTOCANCEL,	3095	data => WF_AUTOCANCEL,
2409	cb => sub {	3096	cb => sub {
		3097	if ($Coro::current != $Coro::main) {
		3098	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3099	unless ++$bug_warning > 10;
		3100	return;
		3101	}
		3102
2410	$NOW = Event::time;	3103	$NOW = $tick_start = Event::time;
2411		3104
2412	cf::server_tick; # one server iteration	3105	cf::server_tick; # one server iteration
		3106
		3107	0 && sync_job {#d#
		3108	for(1..10) {
		3109	my $t = Event::time;
		3110	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3111	or die;
		3112
		3113	$map->width (50);
		3114	$map->height (50);
		3115	$map->alloc;
		3116	$map->_load_objects ("/tmp/x.map", 1);
		3117	my $t = Event::time - $t;
		3118
		3119	#next unless $t < 0.0013;#d#
		3120	if ($t < $min) {
		3121	$min = $t;
		3122	}
		3123	$avg = $avg * 0.99 + $t * 0.01;
		3124	}
		3125	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3126	exit 0;
		3127	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3128	};
		3129
2413	$RUNTIME += $TICK;	3130	$RUNTIME += $TICK;
2414	$NEXT_TICK += $TICK;	3131	$NEXT_TICK += $TICK;
2415		3132
2416	$WAIT_FOR_TICK->broadcast;	3133	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2417	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3134	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3135	Coro::async_pool {
		3136	write_runtime
		3137	or warn "ERROR: unable to write runtime file: $!";
		3138	};
		3139	}
		3140
		3141	# my $AFTER = Event::time;
		3142	# warn $AFTER - $NOW;#d#
		3143
		3144	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3145	$sig->send;
		3146	}
		3147	while (my $sig = shift @WAIT_FOR_TICK) {
		3148	$sig->send;
		3149	}
		3150
		3151	$NOW = Event::time;
2418		3152
2419	# if we are delayed by four ticks or more, skip them all	3153	# if we are delayed by four ticks or more, skip them all
2420	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3154	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2421		3155
2422	$TICK_WATCHER->at ($NEXT_TICK);	3156	$TICK_WATCHER->at ($NEXT_TICK);
2423	$TICK_WATCHER->start;	3157	$TICK_WATCHER->start;
		3158
		3159	$LOAD = ($NOW - $tick_start) / $TICK;
		3160	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3161
		3162	_post_tick;
		3163
		3164
2424	},	3165	},
2425	);	3166	);
2426		3167
		3168	{
		3169	BDB::max_poll_time $TICK * 0.1;
		3170	$BDB_POLL_WATCHER = Event->io (
		3171	reentrant => 0,
		3172	fd => BDB::poll_fileno,
		3173	poll => 'r',
		3174	prio => 0,
		3175	data => WF_AUTOCANCEL,
		3176	cb => \&BDB::poll_cb,
		3177	);
		3178	BDB::min_parallel 8;
		3179
		3180	BDB::set_sync_prepare {
		3181	my $status;
		3182	my $current = $Coro::current;
		3183	(
		3184	sub {
		3185	$status = $!;
		3186	$current->ready; undef $current;
		3187	},
		3188	sub {
		3189	Coro::schedule while defined $current;
		3190	$! = $status;
		3191	},
		3192	)
		3193	};
		3194
		3195	unless ($DB_ENV) {
		3196	$DB_ENV = BDB::db_env_create;
		3197
		3198	cf::sync_job {
		3199	eval {
		3200	BDB::db_env_open
		3201	$DB_ENV,
		3202	$BDBDIR,
		3203	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3204	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3205	0666;
		3206
		3207	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3208
		3209	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3210	$DB_ENV->set_lk_detect;
		3211	};
		3212
		3213	cf::cleanup "db_env_open(db): $@" if $@;
		3214	};
		3215	}
		3216	}
		3217
		3218	{
		3219	IO::AIO::min_parallel 8;
		3220
		3221	undef $Coro::AIO::WATCHER;
2427	IO::AIO::max_poll_time $TICK * 0.2;	3222	IO::AIO::max_poll_time $TICK * 0.1;
2428
2429	$AIO_POLL_WATCHER = Event->io (	3223	$AIO_POLL_WATCHER = Event->io (
2430	fd => IO::AIO::poll_fileno,	3224	reentrant => 0,
2431	poll => 'r',
2432	prio => 5,
2433	data => WF_AUTOCANCEL,
2434	cb => \&IO::AIO::poll_cb,
2435	);
2436
2437	$WRITE_RUNTIME_WATCHER = Event->timer (
2438	data => WF_AUTOCANCEL,	3225	data => WF_AUTOCANCEL,
2439	after => 0,	3226	fd => IO::AIO::poll_fileno,
2440	interval => 10,	3227	poll => 'r',
2441	cb => sub {	3228	prio => 6,
2442	(Coro::unblock_sub {	3229	cb => \&IO::AIO::poll_cb,
2443	write_runtime	3230	);
2444	or warn "ERROR: unable to write runtime file: $!";	3231	}
		3232
		3233	my $_log_backtrace;
		3234
		3235	sub _log_backtrace {
		3236	my ($msg, @addr) = @_;
		3237
		3238	$msg =~ s/\n//;
		3239
		3240	# limit the # of concurrent backtraces
		3241	if ($_log_backtrace < 2) {
		3242	++$_log_backtrace;
		3243	async {
		3244	my @bt = fork_call {
		3245	@addr = map { sprintf "%x", $_ } @addr;
		3246	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3247	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3248	or die "addr2line: $!";
		3249
		3250	my @funcs;
		3251	my @res = <$fh>;
		3252	chomp for @res;
		3253	while (@res) {
		3254	my ($func, $line) = splice @res, 0, 2, ();
		3255	push @funcs, "[$func] $line";
		3256	}
		3257
		3258	@funcs
		3259	};
		3260
		3261	LOG llevInfo, "[ABT] $msg\n";
		3262	LOG llevInfo, "[ABT] $_\n" for @bt;
		3263	--$_log_backtrace;
2445	})->();	3264	};
		3265	} else {
		3266	LOG llevInfo, "[ABT] $msg\n";
		3267	LOG llevInfo, "[ABT] [suppressed]\n";
2446	},	3268	}
2447	);	3269	}
		3270
		3271	# load additional modules
		3272	use cf::pod;
2448		3273
2449	END { cf::emergency_save }	3274	END { cf::emergency_save }
2450		3275
2451	1	3276	1
2452		3277

Diff Legend

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