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.173 by root, Sun Jan 14 18:00:34 2007 UTC vs.
Revision 1.294 by root, Tue Jul 3 06:00:48 2007 UTC

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

Diff Legend

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