ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.291 by root, Tue Jul 3 00:54:44 2007 UTC

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

Diff Legend

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