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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.290 by root, Mon Jul 2 03:15:30 2007 UTC

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

Diff Legend

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