ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.292 by root, Tue Jul 3 00:54:57 2007 UTC

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

Diff Legend

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