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.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.293 by root, Tue Jul 3 05:14:15 2007 UTC

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

Diff Legend

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