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.292 by root, Tue Jul 3 00:54:57 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	1 while s/\s*\n\s*\n\s*/\n/;
		1418
		1419	$_
		1420	}
		1421
		1422	sub hintmode {
		1423	$_[0]{hintmode} = $_[1] if @_ > 1;
		1424	$_[0]{hintmode}
		1425	}
		1426
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1427	=item $player->ext_reply ($msgid, %msg)
1088		1428
1089	Sends an ext reply to the player.	1429	Sends an ext reply to the player.
1090		1430
1091	=cut	1431	=cut
1092		1432
1093	sub ext_reply($$$%) {	1433	sub ext_reply($$%) {
1094	my ($self, $id, %msg) = @_;	1434	my ($self, $id, %msg) = @_;
1095		1435
1096	$msg{msgid} = $id;	1436	$msg{msgid} = $id;
1097		1437	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1438	}
1100		1439
1101	package cf;	1440	=item $player->ext_event ($type, %msg)
		1441
		1442	Sends an ext event to the client.
		1443
		1444	=cut
		1445
		1446	sub ext_event($$%) {
		1447	my ($self, $type, %msg) = @_;
		1448
		1449	$self->ns->ext_event ($type, %msg);
		1450	}
		1451
		1452	=head3 cf::region
		1453
		1454	=over 4
		1455
		1456	=cut
		1457
		1458	package cf::region;
		1459
		1460	=item cf::region::find_by_path $path
		1461
		1462	Tries to decuce the likely region for a map knowing only its path.
		1463
		1464	=cut
		1465
		1466	sub find_by_path($) {
		1467	my ($path) = @_;
		1468
		1469	my ($match, $specificity);
		1470
		1471	for my $region (list) {
		1472	if ($region->match && $path =~ $region->match) {
		1473	($match, $specificity) = ($region, $region->specificity)
		1474	if $region->specificity > $specificity;
		1475	}
		1476	}
		1477
		1478	$match
		1479	}
1102		1480
1103	=back	1481	=back
1104
1105		1482
1106	=head3 cf::map	1483	=head3 cf::map
1107		1484
1108	=over 4	1485	=over 4
1109		1486
…		…
1113		1490
1114	use Fcntl;	1491	use Fcntl;
1115	use Coro::AIO;	1492	use Coro::AIO;
1116		1493
1117	use overload	1494	use overload
1118	'""' => \&as_string;	1495	'""' => \&as_string,
		1496	fallback => 1;
1119		1497
1120	our $MAX_RESET = 3600;	1498	our $MAX_RESET = 3600;
1121	our $DEFAULT_RESET = 3000;	1499	our $DEFAULT_RESET = 3000;
1122		1500
1123	sub generate_random_map {	1501	sub generate_random_map {
1124	my ($self, $rmp) = @_;	1502	my ($self, $rmp) = @_;
1125
1126	# mit "rum" bekleckern, nicht	1503	# mit "rum" bekleckern, nicht
1127	$self->_create_random_map (	1504	$self->_create_random_map (
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1505	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1506	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1507	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1514	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1515	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1516	)
1140	}	1517	}
1141		1518
		1519	=item cf::map->register ($regex, $prio)
		1520
		1521	Register a handler for the map path matching the given regex at the
		1522	givne priority (higher is better, built-in handlers have priority 0, the
		1523	default).
		1524
		1525	=cut
		1526
1142	sub register {	1527	sub register {
1143	my (undef, $regex) = @_;	1528	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1529	my $pkg = caller;
1145		1530
1146	no strict;	1531	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1532	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1533
1149	$EXT_MAP{$pkg} = qr<$regex>;	1534	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1535	}
1151		1536
1152	# also paths starting with '/'	1537	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1538	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1539
1155	sub thawer_merge {	1540	sub thawer_merge {
		1541	my ($self, $merge) = @_;
		1542
1156	# we have to keep some variables in memory intact	1543	# we have to keep some variables in memory intact
1157	local $_[0]{path};	1544	local $self->{path};
1158	local $_[0]{deny_save};	1545	local $self->{load_path};
1159	local $_[0]{deny_reset};
1160		1546
1161	$_[0]->SUPER::thawer_merge ($_[1]);	1547	$self->SUPER::thawer_merge ($merge);
1162	}	1548	}
1163		1549
1164	sub normalise {	1550	sub normalise {
1165	my ($path, $base) = @_;	1551	my ($path, $base) = @_;
		1552
		1553	$path = "$path"; # make sure its a string
		1554
		1555	$path =~ s/\.map$//;
1166		1556
1167	# map plan:	1557	# map plan:
1168	#	1558	#
1169	# /! non-realised random map exit (special hack!)	1559	# /! non-realised random map exit (special hack!)
1170	# {... are special paths that are not being touched	1560	# {... are special paths that are not being touched
…		…
1198		1588
1199	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1589	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1200		1590
1201	$path = normalise $path, $base;	1591	$path = normalise $path, $base;
1202		1592
1203	for my $pkg (keys %EXT_MAP) {	1593	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1204	if ($path =~ $EXT_MAP{$pkg}) {	1594	if ($path =~ $EXT_MAP{$pkg}[1]) {
1205	my $self = bless cf::map::new, $pkg;	1595	my $self = bless cf::map::new, $pkg;
1206	$self->{path} = $path; $self->path ($path);	1596	$self->{path} = $path; $self->path ($path);
1207	$self->init; # pass $1 etc.	1597	$self->init; # pass $1 etc.
1208	return $self;	1598	return $self;
1209	}	1599	}
1210	}	1600	}
1211		1601
1212	Carp::carp "unable to resolve path '$path'.";	1602	Carp::carp "unable to resolve path '$path' (base '$base').";
1213	()	1603	()
1214	}	1604	}
1215		1605
1216	sub init {	1606	sub init {
1217	my ($self) = @_;	1607	my ($self) = @_;
…		…
1232		1622
1233	# the original (read-only) location	1623	# the original (read-only) location
1234	sub load_path {	1624	sub load_path {
1235	my ($self) = @_;	1625	my ($self) = @_;
1236		1626
1237	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1627	"$MAPDIR/$self->{path}.map"
1238	}	1628	}
1239		1629
1240	# the temporary/swap location	1630	# the temporary/swap location
1241	sub save_path {	1631	sub save_path {
1242	my ($self) = @_;	1632	my ($self) = @_;
1243		1633
1244	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1634	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1245	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1635	"$TMPDIR/$path.map"
1246	}	1636	}
1247		1637
1248	# the unique path, undef == no special unique path	1638	# the unique path, undef == no special unique path
1249	sub uniq_path {	1639	sub uniq_path {
1250	my ($self) = @_;	1640	my ($self) = @_;
1251		1641
1252	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1642	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1253	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1643	"$UNIQUEDIR/$path"
1254	}	1644	}
1255		1645
1256	# and all this just because we cannot iterate over	1646	# and all this just because we cannot iterate over
1257	# all maps in C++...	1647	# all maps in C++...
1258	sub change_all_map_light {	1648	sub change_all_map_light {
…		…
1260		1650
1261	$_->change_map_light ($change)	1651	$_->change_map_light ($change)
1262	for grep $_->outdoor, values %cf::MAP;	1652	for grep $_->outdoor, values %cf::MAP;
1263	}	1653	}
1264		1654
		1655	sub decay_objects {
		1656	my ($self) = @_;
		1657
		1658	return if $self->{deny_reset};
		1659
		1660	$self->do_decay_objects;
		1661	}
		1662
1265	sub unlink_save {	1663	sub unlink_save {
1266	my ($self) = @_;	1664	my ($self) = @_;
1267		1665
1268	utf8::encode (my $save = $self->save_path);	1666	utf8::encode (my $save = $self->save_path);
1269	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1667	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1272		1670
1273	sub load_header_from($) {	1671	sub load_header_from($) {
1274	my ($self, $path) = @_;	1672	my ($self, $path) = @_;
1275		1673
1276	utf8::encode $path;	1674	utf8::encode $path;
1277	aio_open $path, O_RDONLY, 0	1675	#aio_open $path, O_RDONLY, 0
1278	or return;	1676	# or return;
1279		1677
1280	$self->_load_header ($path)	1678	$self->_load_header ($path)
1281	or return;	1679	or return;
1282		1680
1283	$self->{load_path} = $path;	1681	$self->{load_path} = $path;
1284		1682
1285	1	1683	1
1286	}	1684	}
1287		1685
1288	sub load_orig {	1686	sub load_header_orig {
1289	my ($self) = @_;	1687	my ($self) = @_;
1290		1688
1291	$self->load_header_from ($self->load_path)	1689	$self->load_header_from ($self->load_path)
1292	}	1690	}
1293		1691
1294	sub load_temp {	1692	sub load_header_temp {
1295	my ($self) = @_;	1693	my ($self) = @_;
1296		1694
1297	$self->load_header_from ($self->save_path)	1695	$self->load_header_from ($self->save_path)
		1696	}
		1697
		1698	sub prepare_temp {
		1699	my ($self) = @_;
		1700
		1701	$self->last_access ((delete $self->{last_access})
		1702	|| $cf::RUNTIME); #d#
		1703	# safety
		1704	$self->{instantiate_time} = $cf::RUNTIME
		1705	if $self->{instantiate_time} > $cf::RUNTIME;
		1706	}
		1707
		1708	sub prepare_orig {
		1709	my ($self) = @_;
		1710
		1711	$self->{load_original} = 1;
		1712	$self->{instantiate_time} = $cf::RUNTIME;
		1713	$self->last_access ($cf::RUNTIME);
		1714	$self->instantiate;
1298	}	1715	}
1299		1716
1300	sub load_header {	1717	sub load_header {
1301	my ($self) = @_;	1718	my ($self) = @_;
1302		1719
1303	if ($self->load_temp) {	1720	if ($self->load_header_temp) {
1304	$self->last_access ((delete $self->{last_access})	1721	$self->prepare_temp;
1305	|| $cf::RUNTIME); #d#
1306	# safety
1307	$self->{instantiate_time} = $cf::RUNTIME
1308	if $self->{instantiate_time} > $cf::RUNTIME;
1309	} else {	1722	} else {
1310	$self->load_orig	1723	$self->load_header_orig
1311	or return;	1724	or return;
1312		1725	$self->prepare_orig;
1313	$self->{load_original} = 1;
1314	$self->{instantiate_time} = $cf::RUNTIME;
1315	$self->last_access ($cf::RUNTIME);
1316	$self->instantiate;
1317	}	1726	}
		1727
		1728	$self->{deny_reset} = 1
		1729	if $self->no_reset;
		1730
		1731	$self->default_region (cf::region::find_by_path $self->{path})
		1732	unless $self->default_region;
1318		1733
1319	1	1734	1
1320	}	1735	}
1321		1736
1322	sub find;	1737	sub find;
…		…
1335	$map->{last_save} = $cf::RUNTIME;	1750	$map->{last_save} = $cf::RUNTIME;
1336		1751
1337	$map->load_header	1752	$map->load_header
1338	or return;	1753	or return;
1339		1754
1340	if ($map->should_reset) {	1755	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1756	# doing this can freeze the server in a sync job, obviously
1341	$cf::WAIT_FOR_TICK->wait;	1757	#$cf::WAIT_FOR_TICK->wait;
1342	$map->reset;	1758	$map->reset;
1343	undef $guard;	1759	undef $guard;
1344	$map = find $path	1760	return find $path;
1345	or return;
1346	}	1761	}
1347		1762
1348	$cf::MAP{$path} = $map	1763	$cf::MAP{$path} = $map
1349	}	1764	}
1350	}	1765	}
		1766
		1767	sub pre_load { }
		1768	sub post_load { }
1351		1769
1352	sub load {	1770	sub load {
1353	my ($self) = @_;	1771	my ($self) = @_;
1354		1772
		1773	local $self->{deny_reset} = 1; # loading can take a long time
		1774
1355	my $path = $self->{path};	1775	my $path = $self->{path};
		1776
		1777	{
1356	my $guard = cf::lock_acquire "map_load:$path";	1778	my $guard = cf::lock_acquire "map_load:$path";
1357		1779
1358	return if $self->in_memory != cf::MAP_SWAPPED;	1780	return if $self->in_memory != cf::MAP_SWAPPED;
1359		1781
1360	$self->in_memory (cf::MAP_LOADING);	1782	$self->in_memory (cf::MAP_LOADING);
1361		1783
1362	$self->alloc;	1784	$self->alloc;
1363	$self->_load_objects ($self->{load_path}, 1)
1364	or return;
1365		1785
1366	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1786	$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;	1787	Coro::cede;
1387	$self->set_darkness_map;	1788
		1789	$self->_load_objects ($self->{load_path}, 1)
		1790	or return;
		1791
		1792	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1793	if delete $self->{load_original};
		1794
		1795	if (my $uniq = $self->uniq_path) {
		1796	utf8::encode $uniq;
		1797	if (aio_open $uniq, O_RDONLY, 0) {
		1798	$self->clear_unique_items;
		1799	$self->_load_objects ($uniq, 0);
		1800	}
		1801	}
		1802
		1803	Coro::cede;
		1804	# now do the right thing for maps
		1805	$self->link_multipart_objects;
1388	$self->difficulty ($self->estimate_difficulty)	1806	$self->difficulty ($self->estimate_difficulty)
1389	unless $self->difficulty;	1807	unless $self->difficulty;
1390	Coro::cede;	1808	Coro::cede;
		1809
		1810	unless ($self->{deny_activate}) {
		1811	$self->decay_objects;
		1812	$self->fix_auto_apply;
		1813	$self->update_buttons;
		1814	Coro::cede;
		1815	$self->set_darkness_map;
		1816	Coro::cede;
1391	$self->activate;	1817	$self->activate;
1392	}	1818	}
1393		1819
1394	$self->in_memory (cf::MAP_IN_MEMORY);	1820	$self->in_memory (cf::MAP_IN_MEMORY);
		1821	}
		1822
		1823	$self->post_load;
1395	}	1824	}
1396		1825
1397	sub customise_for {	1826	sub customise_for {
1398	my ($self, $ob) = @_;	1827	my ($self, $ob) = @_;
1399		1828
1400	return find "~" . $ob->name . "/" . $self->{path}	1829	return find "~" . $ob->name . "/" . $self->{path}
1401	if $self->per_player;	1830	if $self->per_player;
		1831
		1832	# return find "?party/" . $ob->name . "/" . $self->{path}
		1833	# if $self->per_party;
1402		1834
1403	$self	1835	$self
1404	}	1836	}
1405		1837
1406	# find and load all maps in the 3x3 area around a map	1838	# find and load all maps in the 3x3 area around a map
…		…
1438		1870
1439	cf::sync_job { $map->load };	1871	cf::sync_job { $map->load };
1440	}	1872	}
1441		1873
1442	our %MAP_PREFETCH;	1874	our %MAP_PREFETCH;
1443	our $MAP_PREFETCHER = Coro::async {	1875	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		1876
1456	sub find_async {	1877	sub find_async {
1457	my ($path, $origin) = @_;	1878	my ($path, $origin) = @_;
1458		1879
1459	$path = normalise $path, $origin && $origin->{path};	1880	$path = normalise $path, $origin && $origin->{path};
1460		1881
1461	if (my $map = $cf::MAP{$path}) {	1882	if (my $map = $cf::MAP{$path}) {
1462	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1883	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1463	}	1884	}
1464		1885
1465	$MAP_PREFETCH{$path} = 0;	1886	undef $MAP_PREFETCH{$path};
		1887	$MAP_PREFETCHER ||= cf::async {
		1888	while (%MAP_PREFETCH) {
		1889	for my $path (keys %MAP_PREFETCH) {
		1890	my $map = find $path
		1891	or next;
		1892	$map->load;
		1893
		1894	delete $MAP_PREFETCH{$path};
		1895	}
		1896	}
		1897	undef $MAP_PREFETCHER;
		1898	};
1466	$MAP_PREFETCHER->ready;	1899	$MAP_PREFETCHER->prio (6);
1467		1900
1468	()	1901	()
1469	}	1902	}
1470		1903
1471	sub save {	1904	sub save {
…		…
1516		1949
1517	sub reset_at {	1950	sub reset_at {
1518	my ($self) = @_;	1951	my ($self) = @_;
1519		1952
1520	# TODO: safety, remove and allow resettable per-player maps	1953	# 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};	1954	return 1e99 if $self->{deny_reset};
1523		1955
1524	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1956	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1525	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1957	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1526		1958
…		…
1531	my ($self) = @_;	1963	my ($self) = @_;
1532		1964
1533	$self->reset_at <= $cf::RUNTIME	1965	$self->reset_at <= $cf::RUNTIME
1534	}	1966	}
1535		1967
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 {	1968	sub reset {
1551	my ($self) = @_;	1969	my ($self) = @_;
1552		1970
1553	my $lock = cf::lock_acquire "map_data:$self->{path}";	1971	my $lock = cf::lock_acquire "map_data:$self->{path}";
1554		1972
1555	return if $self->players;	1973	return if $self->players;
1556	return if $self->isa ("ext::map_per_player");#d#
1557		1974
1558	warn "resetting map ", $self->path;#d#	1975	warn "resetting map ", $self->path;
		1976
		1977	$self->in_memory (cf::MAP_SWAPPED);
		1978
		1979	# need to save uniques path
		1980	unless ($self->{deny_save}) {
		1981	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1982
		1983	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1984	if $uniq;
		1985	}
1559		1986
1560	delete $cf::MAP{$self->path};	1987	delete $cf::MAP{$self->path};
1561		1988
1562	$self->in_memory (cf::MAP_SWAPPED);
1563	$self->clear;	1989	$self->clear;
1564		1990
1565	$_->clear_links_to ($self) for values %cf::MAP;	1991	$_->clear_links_to ($self) for values %cf::MAP;
1566		1992
1567	$self->unlink_save;	1993	$self->unlink_save;
…		…
1571	my $nuke_counter = "aaaa";	1997	my $nuke_counter = "aaaa";
1572		1998
1573	sub nuke {	1999	sub nuke {
1574	my ($self) = @_;	2000	my ($self) = @_;
1575		2001
		2002	delete $cf::MAP{$self->path};
		2003
		2004	$self->unlink_save;
		2005
		2006	bless $self, "cf::map";
		2007	delete $self->{deny_reset};
1576	$self->{deny_save} = 1;	2008	$self->{deny_save} = 1;
1577	$self->reset_timeout (1);	2009	$self->reset_timeout (1);
1578	$self->rename ("{nuke}/" . ($nuke_counter++));	2010	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2011
		2012	$cf::MAP{$self->path} = $self;
		2013
1579	$self->reset; # polite request, might not happen	2014	$self->reset; # polite request, might not happen
		2015	}
		2016
		2017	=item $maps = cf::map::tmp_maps
		2018
		2019	Returns an arrayref with all map paths of currently instantiated and saved
		2020	maps. May block.
		2021
		2022	=cut
		2023
		2024	sub tmp_maps() {
		2025	[
		2026	map {
		2027	utf8::decode $_;
		2028	/\.map$/
		2029	? normalise $_
		2030	: ()
		2031	} @{ aio_readdir $TMPDIR or [] }
		2032	]
		2033	}
		2034
		2035	=item $maps = cf::map::random_maps
		2036
		2037	Returns an arrayref with all map paths of currently instantiated and saved
		2038	random maps. May block.
		2039
		2040	=cut
		2041
		2042	sub random_maps() {
		2043	[
		2044	map {
		2045	utf8::decode $_;
		2046	/\.map$/
		2047	? normalise "?random/$_"
		2048	: ()
		2049	} @{ aio_readdir $RANDOMDIR or [] }
		2050	]
1580	}	2051	}
1581		2052
1582	=item cf::map::unique_maps	2053	=item cf::map::unique_maps
1583		2054
1584	Returns an arrayref of paths of all shared maps that have	2055	Returns an arrayref of paths of all shared maps that have
1585	instantiated unique items. May block.	2056	instantiated unique items. May block.
1586		2057
1587	=cut	2058	=cut
1588		2059
1589	sub unique_maps() {	2060	sub unique_maps() {
1590	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2061	[
1591	or return;	2062	map {
1592
1593	my @paths;
1594
1595	for (@$files) {
1596	utf8::decode $_;	2063	utf8::decode $_;
1597	next if /\.pst$/;
1598	next unless /^$PATH_SEP/o;
1599
1600	s/\.map$//;	2064	/\.map$/
1601	push @paths, $_;	2065	? normalise $_
		2066	: ()
		2067	} @{ aio_readdir $UNIQUEDIR or [] }
1602	}	2068	]
1603
1604	\@paths
1605	}	2069	}
1606		2070
1607	package cf;	2071	package cf;
1608		2072
1609	=back	2073	=back
…		…
1655		2119
1656	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2120	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1657		2121
1658	if ($self->{record_replies}) {	2122	if ($self->{record_replies}) {
1659	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2123	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2124
1660	} else {	2125	} else {
		2126	my $pl = $self->contr;
		2127
		2128	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2129	my $diag = $pl->{npc_dialog};
		2130	$diag->{pl}->ext_reply (
		2131	$diag->{id},
		2132	msgtype => "reply",
		2133	msg => $diag->{pl}->expand_cfpod ($msg),
		2134	add_topics => []
		2135	);
		2136
		2137	} else {
1661	$msg = $npc->name . " says: $msg" if $npc;	2138	$msg = $npc->name . " says: $msg" if $npc;
1662	$self->message ($msg, $flags);	2139	$self->message ($msg, $flags);
		2140	}
1663	}	2141	}
1664	}	2142	}
1665		2143
1666	=item $player_object->may ("access")	2144	=item $player_object->may ("access")
1667		2145
…		…
1700	=cut	2178	=cut
1701		2179
1702	sub link_map {	2180	sub link_map {
1703	unless ($LINK_MAP) {	2181	unless ($LINK_MAP) {
1704	$LINK_MAP = cf::map::find "{link}"	2182	$LINK_MAP = cf::map::find "{link}"
1705	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2183	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1706	$LINK_MAP->load;	2184	$LINK_MAP->load;
1707	}	2185	}
1708		2186
1709	$LINK_MAP	2187	$LINK_MAP
1710	}	2188	}
…		…
1715	$self->deactivate_recursive;	2193	$self->deactivate_recursive;
1716		2194
1717	return if UNIVERSAL::isa $self->map, "ext::map_link";	2195	return if UNIVERSAL::isa $self->map, "ext::map_link";
1718		2196
1719	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2197	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1720	if $self->map;	2198	if $self->map && $self->map->{path} ne "{link}";
1721		2199
1722	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2200	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1723	}	2201	}
1724		2202
1725	sub cf::object::player::leave_link {	2203	sub cf::object::player::leave_link {
1726	my ($self, $map, $x, $y) = @_;	2204	my ($self, $map, $x, $y) = @_;
		2205
		2206	return unless $self->contr->active;
1727		2207
1728	my $link_pos = delete $self->{_link_pos};	2208	my $link_pos = delete $self->{_link_pos};
1729		2209
1730	unless ($map) {	2210	unless ($map) {
1731	# restore original map position	2211	# restore original map position
…		…
1749	$map->load;	2229	$map->load;
1750	$map->load_diag;	2230	$map->load_diag;
1751		2231
1752	return unless $self->contr->active;	2232	return unless $self->contr->active;
1753	$self->activate_recursive;	2233	$self->activate_recursive;
		2234
		2235	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1754	$self->enter_map ($map, $x, $y);	2236	$self->enter_map ($map, $x, $y);
1755	}	2237	}
1756		2238
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)	2239	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1790		2240
		2241	Moves the player to the given map-path and coordinates by first freezing
		2242	her, loading and preparing them map, calling the provided $check callback
		2243	that has to return the map if sucecssful, and then unfreezes the player on
		2244	the new (success) or old (failed) map position.
		2245
1791	=cut	2246	=cut
		2247
		2248	our $GOTOGEN;
1792		2249
1793	sub cf::object::player::goto {	2250	sub cf::object::player::goto {
1794	my ($self, $path, $x, $y) = @_;	2251	my ($self, $path, $x, $y, $check) = @_;
		2252
		2253	# do generation counting so two concurrent goto's will be executed in-order
		2254	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1795		2255
1796	$self->enter_link;	2256	$self->enter_link;
1797		2257
1798	(async {	2258	(async {
		2259	my $map = eval {
1799	my $map = cf::map::find $path;	2260	my $map = cf::map::find $path;
		2261
		2262	if ($map) {
1800	$map = $map->customise_for ($self) if $map;	2263	$map = $map->customise_for ($self);
1801		2264	$map = $check->($map) if $check && $map;
1802	# warn "entering ", $map->path, " at ($x, $y)\n"	2265	} else {
1803	# if $map;
1804
1805	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2266	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2267	}
1806		2268
		2269	$map
		2270	};
		2271
		2272	if ($@) {
		2273	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2274	LOG llevError | logBacktrace, Carp::longmess $@;
		2275	}
		2276
		2277	if ($gen == $self->{_goto_generation}) {
		2278	delete $self->{_goto_generation};
1807	$self->leave_link ($map, $x, $y);	2279	$self->leave_link ($map, $x, $y);
		2280	}
1808	})->prio (1);	2281	})->prio (1);
1809	}	2282	}
1810		2283
1811	=item $player_object->enter_exit ($exit_object)	2284	=item $player_object->enter_exit ($exit_object)
1812		2285
…		…
1814		2287
1815	sub parse_random_map_params {	2288	sub parse_random_map_params {
1816	my ($spec) = @_;	2289	my ($spec) = @_;
1817		2290
1818	my $rmp = { # defaults	2291	my $rmp = { # defaults
1819	xsize => 10,	2292	xsize => (cf::rndm 15, 40),
1820	ysize => 10,	2293	ysize => (cf::rndm 15, 40),
		2294	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2295	#layout => string,
1821	};	2296	};
1822		2297
1823	for (split /\n/, $spec) {	2298	for (split /\n/, $spec) {
1824	my ($k, $v) = split /\s+/, $_, 2;	2299	my ($k, $v) = split /\s+/, $_, 2;
1825		2300
…		…
1829	$rmp	2304	$rmp
1830	}	2305	}
1831		2306
1832	sub prepare_random_map {	2307	sub prepare_random_map {
1833	my ($exit) = @_;	2308	my ($exit) = @_;
		2309
		2310	my $guard = cf::lock_acquire "exit_prepare:$exit";
1834		2311
1835	# all this does is basically replace the /! path by	2312	# all this does is basically replace the /! path by
1836	# a new random map path (?random/...) with a seed	2313	# a new random map path (?random/...) with a seed
1837	# that depends on the exit object	2314	# that depends on the exit object
1838		2315
1839	my $rmp = parse_random_map_params $exit->msg;	2316	my $rmp = parse_random_map_params $exit->msg;
1840		2317
1841	if ($exit->map) {	2318	if ($exit->map) {
1842	$rmp->{region} = $exit->map->region_name;	2319	$rmp->{region} = $exit->region->name;
1843	$rmp->{origin_map} = $exit->map->path;	2320	$rmp->{origin_map} = $exit->map->path;
1844	$rmp->{origin_x} = $exit->x;	2321	$rmp->{origin_x} = $exit->x;
1845	$rmp->{origin_y} = $exit->y;	2322	$rmp->{origin_y} = $exit->y;
1846	}	2323	}
1847		2324
1848	$rmp->{random_seed} ||= $exit->random_seed;	2325	$rmp->{random_seed} ||= $exit->random_seed;
1849		2326
1850	my $data = cf::to_json $rmp;	2327	my $data = cf::to_json $rmp;
1851	my $md5 = Digest::MD5::md5_hex $data;	2328	my $md5 = Digest::MD5::md5_hex $data;
		2329	my $meta = "$RANDOMDIR/$md5.meta";
1852		2330
1853	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2331	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1854	aio_write $fh, 0, (length $data), $data, 0;	2332	aio_write $fh, 0, (length $data), $data, 0;
		2333	undef $fh;
		2334	aio_rename "$meta~", $meta;
1855		2335
1856	$exit->slaying ("?random/$md5");	2336	$exit->slaying ("?random/$md5");
1857	$exit->msg (undef);	2337	$exit->msg (undef);
1858	}	2338	}
1859	}	2339	}
1860		2340
1861	sub cf::object::player::enter_exit {	2341	sub cf::object::player::enter_exit {
1862	my ($self, $exit) = @_;	2342	my ($self, $exit) = @_;
1863		2343
1864	return unless $self->type == cf::PLAYER;	2344	return unless $self->type == cf::PLAYER;
		2345
		2346	if ($exit->slaying eq "/!") {
		2347	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2348	# the problem is that $exit might not survive long enough
		2349	# so it needs to be done right now, right here
		2350	cf::sync_job { prepare_random_map $exit };
		2351	}
		2352
		2353	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2354	my $hp = $exit->stats->hp;
		2355	my $sp = $exit->stats->sp;
1865		2356
1866	$self->enter_link;	2357	$self->enter_link;
1867		2358
1868	(async {	2359	(async {
1869	$self->deactivate_recursive; # just to be sure	2360	$self->deactivate_recursive; # just to be sure
1870	unless (eval {	2361	unless (eval {
1871	prepare_random_map $exit	2362	$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		2363
1877	1;	2364	1;
1878	}) {	2365	}) {
1879	$self->message ("Something went wrong deep within the crossfire server. "	2366	$self->message ("Something went wrong deep within the crossfire server. "
1880	. "I'll try to bring you back to the map you were before. "	2367	. "I'll try to bring you back to the map you were before. "
1881	. "Please report this to the dungeon master!",	2368	. "Please report this to the dungeon master!",
1882	cf::NDI_UNIQUE | cf::NDI_RED);	2369	cf::NDI_UNIQUE | cf::NDI_RED);
1883		2370
1884	warn "ERROR in enter_exit: $@";	2371	warn "ERROR in enter_exit: $@";
1885	$self->leave_link;	2372	$self->leave_link;
1886	}	2373	}
1887	})->prio (1);	2374	})->prio (1);
…		…
1900		2387
1901	sub cf::client::send_drawinfo {	2388	sub cf::client::send_drawinfo {
1902	my ($self, $text, $flags) = @_;	2389	my ($self, $text, $flags) = @_;
1903		2390
1904	utf8::encode $text;	2391	utf8::encode $text;
1905	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2392	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1906	}	2393	}
1907		2394
		2395	=item $client->send_msg ($color, $type, $msg, [extra...])
		2396
		2397	Send a drawinfo or msg packet to the client, formatting the msg for the
		2398	client if neccessary. C<$type> should be a string identifying the type of
		2399	the message, with C<log> being the default. If C<$color> is negative, suppress
		2400	the message unless the client supports the msg packet.
		2401
		2402	=cut
		2403
		2404	sub cf::client::send_msg {
		2405	my ($self, $color, $type, $msg, @extra) = @_;
		2406
		2407	$msg = $self->pl->expand_cfpod ($msg);
		2408
		2409	if ($self->can_msg) {
		2410	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2411	} else {
		2412	# replace some tags by gcfclient-compatible ones
		2413	for ($msg) {
		2414	1 while
		2415	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2416	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2417	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2418	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2419	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2420	}
		2421
		2422	if ($color >= 0) {
		2423	if (0 && $msg =~ /\[/) {
		2424	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2425	} else {
		2426	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2427	$self->send_packet ("drawinfo $color $msg")
		2428	}
		2429	}
		2430	}
		2431	}
		2432
		2433	=item $client->ext_event ($type, %msg)
		2434
		2435	Sends an ext event to the client.
		2436
		2437	=cut
		2438
		2439	sub cf::client::ext_event($$%) {
		2440	my ($self, $type, %msg) = @_;
		2441
		2442	$msg{msgtype} = "event_$type";
		2443	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2444	}
1908		2445
1909	=item $success = $client->query ($flags, "text", \&cb)	2446	=item $success = $client->query ($flags, "text", \&cb)
1910		2447
1911	Queues a query to the client, calling the given callback with	2448	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>,	2449	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>.	2450	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1914		2451
1915	Queries can fail, so check the return code. Or don't, as queries will become	2452	Queries can fail, so check the return code. Or don't, as queries will
1916	reliable at some point in the future.	2453	become reliable at some point in the future.
1917		2454
1918	=cut	2455	=cut
1919		2456
1920	sub cf::client::query {	2457	sub cf::client::query {
1921	my ($self, $flags, $text, $cb) = @_;	2458	my ($self, $flags, $text, $cb) = @_;
…		…
1929	utf8::encode $text;	2466	utf8::encode $text;
1930	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2467	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1931		2468
1932	$self->send_packet ($self->{query_queue}[0][0])	2469	$self->send_packet ($self->{query_queue}[0][0])
1933	if @{ $self->{query_queue} } == 1;	2470	if @{ $self->{query_queue} } == 1;
		2471
		2472	1
1934	}	2473	}
1935		2474
1936	cf::client->attach (	2475	cf::client->attach (
		2476	on_connect => sub {
		2477	my ($ns) = @_;
		2478
		2479	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2480	},
1937	on_reply => sub {	2481	on_reply => sub {
1938	my ($ns, $msg) = @_;	2482	my ($ns, $msg) = @_;
1939		2483
1940	# this weird shuffling is so that direct followup queries	2484	# this weird shuffling is so that direct followup queries
1941	# get handled first	2485	# get handled first
1942	my $queue = delete $ns->{query_queue}	2486	my $queue = delete $ns->{query_queue}
1943	or return; # be conservative, not sure how that can happen, but we saw a crash here	2487	or return; # be conservative, not sure how that can happen, but we saw a crash here
1944		2488
1945	(shift @$queue)->[1]->($msg);	2489	(shift @$queue)->[1]->($msg);
		2490	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1946		2491
1947	push @{ $ns->{query_queue} }, @$queue;	2492	push @{ $ns->{query_queue} }, @$queue;
1948		2493
1949	if (@{ $ns->{query_queue} } == @$queue) {	2494	if (@{ $ns->{query_queue} } == @$queue) {
1950	if (@$queue) {	2495	if (@$queue) {
…		…
1952	} else {	2497	} else {
1953	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2498	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1954	}	2499	}
1955	}	2500	}
1956	},	2501	},
		2502	on_exticmd => sub {
		2503	my ($ns, $buf) = @_;
		2504
		2505	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2506
		2507	if (ref $msg) {
		2508	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2509	if (my %reply = $cb->($ns, $msg)) {
		2510	$reply{msgid} = $msg->{msgid};
		2511	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2512	}
		2513	}
		2514	} else {
		2515	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2516	}
		2517
		2518	cf::override;
		2519	},
1957	);	2520	);
1958		2521
1959	=item $client->async (\&cb)	2522	=item $client->async (\&cb)
1960		2523
1961	Create a new coroutine, running the specified callback. The coroutine will	2524	Create a new coroutine, running the specified callback. The coroutine will
…		…
2008		2571
2009	# here we export the classes and methods available to script code	2572	# here we export the classes and methods available to script code
2010		2573
2011	=pod	2574	=pod
2012		2575
2013	The following fucntions and emthods are available within a safe environment:	2576	The following functions and methods are available within a safe environment:
2014		2577
2015	cf::object contr pay_amount pay_player map	2578	cf::object contr pay_amount pay_player map
2016	cf::object::player player	2579	cf::object::player player
2017	cf::player peaceful	2580	cf::player peaceful
2018	cf::map trigger	2581	cf::map trigger
…		…
2099	=back	2662	=back
2100		2663
2101	=cut	2664	=cut
2102		2665
2103	#############################################################################	2666	#############################################################################
		2667	# the server's init and main functions
2104		2668
2105	=head2 EXTENSION DATABASE SUPPORT	2669	sub load_facedata($) {
		2670	my ($path) = @_;
2106		2671
2107	Crossfire maintains a very simple database for extension use. It can	2672	warn "loading facedata from $path\n";
2108	currently store anything that can be serialised using Storable, which
2109	excludes objects.
2110		2673
2111	The parameter C<$family> should best start with the name of the extension	2674	my $facedata;
2112	using it, it should be unique.	2675	0 < aio_load $path, $facedata
		2676	or die "$path: $!";
2113		2677
2114	=over 4	2678	$facedata = Coro::Storable::thaw $facedata;
2115		2679
2116	=item $hashref = cf::db_get $family	2680	$facedata->{version} == 2
		2681	or cf::cleanup "$path: version mismatch, cannot proceed.";
2117		2682
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	}	2683	{
		2684	my $faces = $facedata->{faceinfo};
2154		2685
2155	my $pid;	2686	while (my ($face, $info) = each %$faces) {
2156		2687	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2157	sub db_save() {	2688	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2158	waitpid $pid, 0 if $pid;	2689	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2159	if (0 == ($pid = fork)) {	2690	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2160	$DB->{_meta}{version} = 1;	2691	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	},	2692	}
2203	);
2204	}
2205		2693
2206	#############################################################################	2694	while (my ($face, $info) = each %$faces) {
2207	# the server's main()	2695	next unless $info->{smooth};
		2696	my $idx = cf::face::find $face
		2697	or next;
		2698	if (my $smooth = cf::face::find $info->{smooth}) {
		2699	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2700	} else {
		2701	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2702	}
		2703	Coro::cede;
		2704	}
		2705	}
		2706
		2707	{
		2708	my $anims = $facedata->{animinfo};
		2709
		2710	while (my ($anim, $info) = each %$anims) {
		2711	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2712	Coro::cede;
		2713	}
		2714
		2715	cf::anim::invalidate_all; # d'oh
		2716	}
		2717
		2718	1
		2719	}
		2720
		2721	sub reload_regions {
		2722	load_resource_file "$MAPDIR/regions"
		2723	or die "unable to load regions file\n";
		2724	}
		2725
		2726	sub reload_facedata {
		2727	load_facedata "$DATADIR/facedata"
		2728	or die "unable to load facedata\n";
		2729	}
		2730
		2731	sub reload_archetypes {
		2732	load_resource_file "$DATADIR/archetypes"
		2733	or die "unable to load archetypes\n";
		2734	#d# NEED to laod twice to resolve forward references
		2735	# this really needs to be done in an extra post-pass
		2736	# (which needs to be synchronous, so solve it differently)
		2737	load_resource_file "$DATADIR/archetypes"
		2738	or die "unable to load archetypes\n";
		2739	}
		2740
		2741	sub reload_treasures {
		2742	load_resource_file "$DATADIR/treasures"
		2743	or die "unable to load treasurelists\n";
		2744	}
		2745
		2746	sub reload_resources {
		2747	warn "reloading resource files...\n";
		2748
		2749	reload_regions;
		2750	reload_facedata;
		2751	#reload_archetypes;#d#
		2752	reload_archetypes;
		2753	reload_treasures;
		2754
		2755	warn "finished reloading resource files\n";
		2756	}
		2757
		2758	sub init {
		2759	reload_resources;
		2760	}
2208		2761
2209	sub cfg_load {	2762	sub cfg_load {
2210	open my $fh, "<:utf8", cf::confdir . "/config"	2763	open my $fh, "<:utf8", "$CONFDIR/config"
2211	or return;	2764	or return;
2212		2765
2213	local $/;	2766	local $/;
2214	*CFG = YAML::Syck::Load <$fh>;	2767	*CFG = YAML::Syck::Load <$fh>;
2215		2768
…		…
2229		2782
2230	sub main {	2783	sub main {
2231	# we must not ever block the main coroutine	2784	# we must not ever block the main coroutine
2232	local $Coro::idle = sub {	2785	local $Coro::idle = sub {
2233	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2786	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2787	(async {
2234	async { Event::one_event };	2788	Event::one_event;
		2789	})->prio (Coro::PRIO_MAX);
2235	};	2790	};
2236		2791
2237	cfg_load;	2792	cfg_load;
2238	db_load;	2793	db_init;
2239	load_extensions;	2794	load_extensions;
		2795
		2796	$TICK_WATCHER->start;
2240	Event::loop;	2797	Event::loop;
2241	}	2798	}
2242		2799
2243	#############################################################################	2800	#############################################################################
2244	# initialisation and cleanup	2801	# initialisation and cleanup
2245		2802
2246	# install some emergency cleanup handlers	2803	# install some emergency cleanup handlers
2247	BEGIN {	2804	BEGIN {
2248	for my $signal (qw(INT HUP TERM)) {	2805	for my $signal (qw(INT HUP TERM)) {
2249	Event->signal (	2806	Event->signal (
		2807	reentrant => 0,
2250	data => WF_AUTOCANCEL,	2808	data => WF_AUTOCANCEL,
2251	signal => $signal,	2809	signal => $signal,
		2810	prio => 0,
2252	cb => sub {	2811	cb => sub {
2253	cf::cleanup "SIG$signal";	2812	cf::cleanup "SIG$signal";
2254	},	2813	},
2255	);	2814	);
2256	}	2815	}
		2816	}
		2817
		2818	sub write_runtime {
		2819	my $runtime = "$LOCALDIR/runtime";
		2820
		2821	# first touch the runtime file to show we are still running:
		2822	# the fsync below can take a very very long time.
		2823
		2824	IO::AIO::aio_utime $runtime, undef, undef;
		2825
		2826	my $guard = cf::lock_acquire "write_runtime";
		2827
		2828	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2829	or return;
		2830
		2831	my $value = $cf::RUNTIME + 90 + 10;
		2832	# 10 is the runtime save interval, for a monotonic clock
		2833	# 60 allows for the watchdog to kill the server.
		2834
		2835	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2836	and return;
		2837
		2838	# always fsync - this file is important
		2839	aio_fsync $fh
		2840	and return;
		2841
		2842	# touch it again to show we are up-to-date
		2843	aio_utime $fh, undef, undef;
		2844
		2845	close $fh
		2846	or return;
		2847
		2848	aio_rename "$runtime~", $runtime
		2849	and return;
		2850
		2851	warn "runtime file written.\n";
		2852
		2853	1
2257	}	2854	}
2258		2855
2259	sub emergency_save() {	2856	sub emergency_save() {
2260	my $freeze_guard = cf::freeze_mainloop;	2857	my $freeze_guard = cf::freeze_mainloop;
2261		2858
…		…
2278	my $map = $cf::MAP{$path} or next;	2875	my $map = $cf::MAP{$path} or next;
2279	$map->valid or next;	2876	$map->valid or next;
2280	$map->save;	2877	$map->save;
2281	}	2878	}
2282	warn "end emergency map save\n";	2879	warn "end emergency map save\n";
		2880
		2881	warn "begin emergency database checkpoint\n";
		2882	BDB::db_env_txn_checkpoint $DB_ENV;
		2883	warn "end emergency database checkpoint\n";
2283	};	2884	};
2284		2885
2285	warn "leave emergency perl save\n";	2886	warn "leave emergency perl save\n";
2286	}	2887	}
2287		2888
		2889	sub post_cleanup {
		2890	my ($make_core) = @_;
		2891
		2892	warn Carp::longmess "post_cleanup backtrace"
		2893	if $make_core;
		2894	}
		2895
2288	sub reload() {	2896	sub do_reload_perl() {
2289	# can/must only be called in main	2897	# can/must only be called in main
2290	if ($Coro::current != $Coro::main) {	2898	if ($Coro::current != $Coro::main) {
2291	warn "can only reload from main coroutine\n";	2899	warn "can only reload from main coroutine";
2292	return;	2900	return;
2293	}	2901	}
2294		2902
2295	warn "reloading...";	2903	warn "reloading...";
2296		2904
2297	warn "freezing server";	2905	warn "entering sync_job";
2298	my $guard = freeze_mainloop;	2906
		2907	cf::sync_job {
		2908	cf::write_runtime; # external watchdog should not bark
2299	cf::emergency_save;	2909	cf::emergency_save;
		2910	cf::write_runtime; # external watchdog should not bark
2300		2911
2301	warn "sync database to disk";	2912	warn "syncing database to disk";
2302	cf::db_sync;	2913	BDB::db_env_txn_checkpoint $DB_ENV;
2303	IO::AIO::flush;
2304		2914
2305	eval {
2306	# if anything goes wrong in here, we should simply crash as we already saved	2915	# if anything goes wrong in here, we should simply crash as we already saved
2307		2916
2308	warn "cancel all watchers";	2917	warn "cancelling all WF_AUTOCANCEL watchers";
2309	for (Event::all_watchers) {	2918	for (Event::all_watchers) {
2310	$_->cancel if $_->data & WF_AUTOCANCEL;	2919	$_->cancel if $_->data & WF_AUTOCANCEL;
2311	}	2920	}
2312		2921
		2922	warn "flushing outstanding aio requests";
		2923	for (;;) {
		2924	BDB::flush;
		2925	IO::AIO::flush;
		2926	Coro::cede;
		2927	last unless IO::AIO::nreqs || BDB::nreqs;
		2928	warn "iterate...";
		2929	}
		2930
		2931	++$RELOAD;
		2932
2313	warn "cancel all extension coros";	2933	warn "cancelling all extension coros";
2314	$_->cancel for values %EXT_CORO;	2934	$_->cancel for values %EXT_CORO;
2315	%EXT_CORO = ();	2935	%EXT_CORO = ();
2316		2936
2317	warn "remove commands";	2937	warn "removing commands";
2318	%COMMAND = ();	2938	%COMMAND = ();
2319		2939
2320	warn "remove ext commands";	2940	warn "removing ext/exti commands";
2321	%EXTCMD = ();	2941	%EXTCMD = ();
		2942	%EXTICMD = ();
2322		2943
2323	warn "unload/nuke all extensions";	2944	warn "unloading/nuking all extensions";
2324	for my $pkg (@EXTS) {	2945	for my $pkg (@EXTS) {
2325	warn "... unloading $pkg";	2946	warn "... unloading $pkg";
2326		2947
2327	if (my $cb = $pkg->can ("unload")) {	2948	if (my $cb = $pkg->can ("unload")) {
2328	eval {	2949	eval {
…		…
2333		2954
2334	warn "... nuking $pkg";	2955	warn "... nuking $pkg";
2335	Symbol::delete_package $pkg;	2956	Symbol::delete_package $pkg;
2336	}	2957	}
2337		2958
2338	warn "unload all perl modules loaded from $LIBDIR";	2959	warn "unloading all perl modules loaded from $LIBDIR";
2339	while (my ($k, $v) = each %INC) {	2960	while (my ($k, $v) = each %INC) {
2340	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2961	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2341		2962
2342	warn "removing <$k>";	2963	warn "... unloading $k";
2343	delete $INC{$k};	2964	delete $INC{$k};
2344		2965
2345	$k =~ s/\.pm$//;	2966	$k =~ s/\.pm$//;
2346	$k =~ s/\//::/g;	2967	$k =~ s/\//::/g;
2347		2968
…		…
2350	}	2971	}
2351		2972
2352	Symbol::delete_package $k;	2973	Symbol::delete_package $k;
2353	}	2974	}
2354		2975
2355	warn "get rid of safe::, as good as possible";	2976	warn "getting rid of safe::, as good as possible";
2356	Symbol::delete_package "safe::$_"	2977	Symbol::delete_package "safe::$_"
2357	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2978	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2358		2979
2359	warn "unload cf.pm \"a bit\"";	2980	warn "unloading cf.pm \"a bit\"";
2360	delete $INC{"cf.pm"};	2981	delete $INC{"cf.pm"};
		2982	delete $INC{"cf/pod.pm"};
2361		2983
2362	# don't, removes xs symbols, too,	2984	# don't, removes xs symbols, too,
2363	# and global variables created in xs	2985	# and global variables created in xs
2364	#Symbol::delete_package __PACKAGE__;	2986	#Symbol::delete_package __PACKAGE__;
2365		2987
		2988	warn "unload completed, starting to reload now";
		2989
2366	warn "reloading cf.pm";	2990	warn "reloading cf.pm";
2367	require cf;	2991	require cf;
2368	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2992	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2369		2993
2370	warn "load config and database again";	2994	warn "loading config and database again";
2371	cf::cfg_load;	2995	cf::cfg_load;
2372	cf::db_load;
2373		2996
2374	warn "load extensions";	2997	warn "loading extensions";
2375	cf::load_extensions;	2998	cf::load_extensions;
2376		2999
2377	warn "reattach attachments to objects/players";	3000	warn "reattaching attachments to objects/players";
2378	_global_reattach;	3001	_global_reattach; # objects, sockets
2379	warn "reattach attachments to maps";	3002	warn "reattaching attachments to maps";
2380	reattach $_ for values %MAP;	3003	reattach $_ for values %MAP;
2381	};	3004	warn "reattaching attachments to players";
		3005	reattach $_ for values %PLAYER;
2382		3006
2383	if ($@) {	3007	warn "leaving sync_job";
		3008
		3009	1
		3010	} or do {
2384	warn $@;	3011	warn $@;
2385	warn "error while reloading, exiting.";	3012	warn "error while reloading, exiting.";
2386	exit 1;	3013	exit 1;
2387	}	3014	};
2388		3015
2389	warn "reloaded";	3016	warn "reloaded";
2390	};	3017	};
2391		3018
		3019	our $RELOAD_WATCHER; # used only during reload
		3020
		3021	sub reload_perl() {
		3022	# doing reload synchronously and two reloads happen back-to-back,
		3023	# coro crashes during coro_state_free->destroy here.
		3024
		3025	$RELOAD_WATCHER ||= Event->timer (
		3026	reentrant => 0,
		3027	after => 0,
		3028	data => WF_AUTOCANCEL,
		3029	cb => sub {
		3030	do_reload_perl;
		3031	undef $RELOAD_WATCHER;
		3032	},
		3033	);
		3034	}
		3035
2392	register_command "reload" => sub {	3036	register_command "reload" => sub {
2393	my ($who, $arg) = @_;	3037	my ($who, $arg) = @_;
2394		3038
2395	if ($who->flag (FLAG_WIZ)) {	3039	if ($who->flag (FLAG_WIZ)) {
2396	$who->message ("start of reload.");
2397	reload;
2398	$who->message ("end of reload.");	3040	$who->message ("reloading server.");
		3041	async { reload_perl };
2399	}	3042	}
2400	};	3043	};
2401		3044
2402	unshift @INC, $LIBDIR;	3045	unshift @INC, $LIBDIR;
2403		3046
		3047	my $bug_warning = 0;
		3048
		3049	our @WAIT_FOR_TICK;
		3050	our @WAIT_FOR_TICK_BEGIN;
		3051
		3052	sub wait_for_tick {
		3053	return unless $TICK_WATCHER->is_active;
		3054	return if $Coro::current == $Coro::main;
		3055
		3056	my $signal = new Coro::Signal;
		3057	push @WAIT_FOR_TICK, $signal;
		3058	$signal->wait;
		3059	}
		3060
		3061	sub wait_for_tick_begin {
		3062	return unless $TICK_WATCHER->is_active;
		3063	return if $Coro::current == $Coro::main;
		3064
		3065	my $signal = new Coro::Signal;
		3066	push @WAIT_FOR_TICK_BEGIN, $signal;
		3067	$signal->wait;
		3068	}
		3069
		3070	my $min = 1e6;#d#
		3071	my $avg = 10;
2404	$TICK_WATCHER = Event->timer (	3072	$TICK_WATCHER = Event->timer (
2405	reentrant => 0,	3073	reentrant => 0,
		3074	parked => 1,
2406	prio => 0,	3075	prio => 0,
2407	at => $NEXT_TICK || $TICK,	3076	at => $NEXT_TICK || $TICK,
2408	data => WF_AUTOCANCEL,	3077	data => WF_AUTOCANCEL,
2409	cb => sub {	3078	cb => sub {
		3079	if ($Coro::current != $Coro::main) {
		3080	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3081	unless ++$bug_warning > 10;
		3082	return;
		3083	}
		3084
2410	$NOW = Event::time;	3085	$NOW = $tick_start = Event::time;
2411		3086
2412	cf::server_tick; # one server iteration	3087	cf::server_tick; # one server iteration
		3088
		3089	0 && sync_job {#d#
		3090	for(1..10) {
		3091	my $t = Event::time;
		3092	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3093	or die;
		3094
		3095	$map->width (50);
		3096	$map->height (50);
		3097	$map->alloc;
		3098	$map->_load_objects ("/tmp/x.map", 1);
		3099	my $t = Event::time - $t;
		3100
		3101	#next unless $t < 0.0013;#d#
		3102	if ($t < $min) {
		3103	$min = $t;
		3104	}
		3105	$avg = $avg * 0.99 + $t * 0.01;
		3106	}
		3107	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3108	exit 0;
		3109	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3110	};
		3111
2413	$RUNTIME += $TICK;	3112	$RUNTIME += $TICK;
2414	$NEXT_TICK += $TICK;	3113	$NEXT_TICK += $TICK;
2415		3114
2416	$WAIT_FOR_TICK->broadcast;	3115	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2417	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3116	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3117	Coro::async_pool {
		3118	write_runtime
		3119	or warn "ERROR: unable to write runtime file: $!";
		3120	};
		3121	}
		3122
		3123	# my $AFTER = Event::time;
		3124	# warn $AFTER - $NOW;#d#
		3125
		3126	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3127	$sig->send;
		3128	}
		3129	while (my $sig = shift @WAIT_FOR_TICK) {
		3130	$sig->send;
		3131	}
		3132
		3133	$NOW = Event::time;
2418		3134
2419	# if we are delayed by four ticks or more, skip them all	3135	# if we are delayed by four ticks or more, skip them all
2420	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3136	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2421		3137
2422	$TICK_WATCHER->at ($NEXT_TICK);	3138	$TICK_WATCHER->at ($NEXT_TICK);
2423	$TICK_WATCHER->start;	3139	$TICK_WATCHER->start;
		3140
		3141	$LOAD = ($NOW - $tick_start) / $TICK;
		3142	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3143
		3144	_post_tick;
		3145
		3146
2424	},	3147	},
2425	);	3148	);
2426		3149
		3150	{
		3151	BDB::max_poll_time $TICK * 0.1;
		3152	$BDB_POLL_WATCHER = Event->io (
		3153	reentrant => 0,
		3154	fd => BDB::poll_fileno,
		3155	poll => 'r',
		3156	prio => 0,
		3157	data => WF_AUTOCANCEL,
		3158	cb => \&BDB::poll_cb,
		3159	);
		3160	BDB::min_parallel 8;
		3161
		3162	BDB::set_sync_prepare {
		3163	my $status;
		3164	my $current = $Coro::current;
		3165	(
		3166	sub {
		3167	$status = $!;
		3168	$current->ready; undef $current;
		3169	},
		3170	sub {
		3171	Coro::schedule while defined $current;
		3172	$! = $status;
		3173	},
		3174	)
		3175	};
		3176
		3177	unless ($DB_ENV) {
		3178	$DB_ENV = BDB::db_env_create;
		3179
		3180	cf::sync_job {
		3181	eval {
		3182	BDB::db_env_open
		3183	$DB_ENV,
		3184	$BDBDIR,
		3185	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3186	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3187	0666;
		3188
		3189	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3190
		3191	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3192	$DB_ENV->set_lk_detect;
		3193	};
		3194
		3195	cf::cleanup "db_env_open(db): $@" if $@;
		3196	};
		3197	}
		3198	}
		3199
		3200	{
		3201	IO::AIO::min_parallel 8;
		3202
		3203	undef $Coro::AIO::WATCHER;
2427	IO::AIO::max_poll_time $TICK * 0.2;	3204	IO::AIO::max_poll_time $TICK * 0.1;
2428
2429	$AIO_POLL_WATCHER = Event->io (	3205	$AIO_POLL_WATCHER = Event->io (
2430	fd => IO::AIO::poll_fileno,	3206	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,	3207	data => WF_AUTOCANCEL,
2439	after => 0,	3208	fd => IO::AIO::poll_fileno,
2440	interval => 10,	3209	poll => 'r',
2441	cb => sub {	3210	prio => 6,
2442	(Coro::unblock_sub {	3211	cb => \&IO::AIO::poll_cb,
2443	write_runtime	3212	);
2444	or warn "ERROR: unable to write runtime file: $!";	3213	}
		3214
		3215	my $_log_backtrace;
		3216
		3217	sub _log_backtrace {
		3218	my ($msg, @addr) = @_;
		3219
		3220	$msg =~ s/\n//;
		3221
		3222	# limit the # of concurrent backtraces
		3223	if ($_log_backtrace < 2) {
		3224	++$_log_backtrace;
		3225	async {
		3226	my @bt = fork_call {
		3227	@addr = map { sprintf "%x", $_ } @addr;
		3228	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3229	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3230	or die "addr2line: $!";
		3231
		3232	my @funcs;
		3233	my @res = <$fh>;
		3234	chomp for @res;
		3235	while (@res) {
		3236	my ($func, $line) = splice @res, 0, 2, ();
		3237	push @funcs, "[$func] $line";
		3238	}
		3239
		3240	@funcs
		3241	};
		3242
		3243	LOG llevInfo, "[ABT] $msg\n";
		3244	LOG llevInfo, "[ABT] $_\n" for @bt;
		3245	--$_log_backtrace;
2445	})->();	3246	};
		3247	} else {
		3248	LOG llevInfo, "[ABT] $msg\n";
		3249	LOG llevInfo, "[ABT] [suppressed]\n";
2446	},	3250	}
2447	);	3251	}
		3252
		3253	# load additional modules
		3254	use cf::pod;
2448		3255
2449	END { cf::emergency_save }	3256	END { cf::emergency_save }
2450		3257
2451	1	3258	1
2452		3259

Diff Legend

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