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

Diff Legend

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