ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 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.5 ();	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 BDB ();
20	use Data::Dumper;	26	use Data::Dumper;
21	use Digest::MD5;	27	use Digest::MD5;
22	use Fcntl;	28	use Fcntl;
		29	use YAML::Syck ();
23	use IO::AIO 2.32 ();	30	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
26		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$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		41
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
33		44
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		46
		47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
35		48
36	our %COMMAND = ();	49	our %COMMAND = ();
37	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
38		51
39	our @EXTS = (); # list of extension package names	52	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	53	our %EXTCMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
43		56
		57	our $RELOAD; # number of reloads so far
44	our @EVENT;	58	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		59
47	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	73	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	74	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	76	our $NEXT_TICK;
52	our $NOW;	77	our $NOW;
53	our $USE_FSYNC = 1; # use fsync to write maps - default off	78	our $USE_FSYNC = 1; # use fsync to write maps - default off
54		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
		82
55	our %CFG;	83	our %CFG;
56		84
57	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
58	our $RUNTIME;	86	our $RUNTIME;
59		87
60	our %PLAYER; # all users	88	our %PLAYER; # all users
61	our %MAP; # all maps	89	our %MAP; # all maps
62	our $LINK_MAP; # the special {link} map, which is always available	90	our $LINK_MAP; # the special {link} map, which is always available
63	our $RANDOM_MAPS = cf::localdir . "/random";
64
65	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
66	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
67		91
68	# used to convert map paths into valid unix filenames by replacing / by ∕	92	# used to convert map paths into valid unix filenames by replacing / by ∕
69	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
70		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
		98
71	binmode STDOUT;	99	binmode STDOUT;
72	binmode STDERR;	100	binmode STDERR;
73		101
74	# read virtual server time, if available	102	# read virtual server time, if available
75	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
76	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
77	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
78	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
79	}	107	}
80		108
81	mkdir cf::localdir;	109	mkdir $_
82	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
83	mkdir cf::localdir . "/" . cf::tmpdir;
84	mkdir cf::localdir . "/" . cf::uniquedir;
85	mkdir $RANDOM_MAPS;
86		111
87	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
88		113
89	sub cf::map::normalise;	114	sub cf::map::normalise;
90		115
…		…
101	=item $cf::RUNTIME	126	=item $cf::RUNTIME
102		127
103	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
104	every server tick.	129	every server tick.
105		130
106	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
107		134
108	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
109	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
110		139
111	=item $cf::NOW	140	=item $cf::NOW
112		141
113	The time of the last (current) server tick.	142	The time of the last (current) server tick.
114		143
115	=item $cf::TICK	144	=item $cf::TICK
116		145
117	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
118		157
119	=item %cf::CFG	158	=item %cf::CFG
120		159
121	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
122	from wherever your confdir points to.	161	from wherever your confdir points to.
123		162
124	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
125		164
126	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
127	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	166	returns directly I<after> the tick processing (and consequently, can only wake one process
128	processing has been done. Call C<< ->wait >> on them to maximise the	167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
129	window of cpu time available, or simply to synchronise to the server tick.
130		168
131	=back	169	=back
132		170
133	=cut	171	=cut
134		172
135	BEGIN {	173	BEGIN {
136	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
137	my $msg = join "", @_;	175	my $msg = join "", @_;
138	utf8::encode $msg;
139		176
140	$msg .= "\n"	177	$msg .= "\n"
141	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
142		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
143	LOG llevError, $msg;	183	LOG llevError, $msg;
144	};	184	};
145	}	185	}
146		186
147	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
148	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
149	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
150	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
151	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
152	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
153		194
154	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
155	# within the Safe compartment.	196	# within the Safe compartment.
156	for my $pkg (qw(	197	for my $pkg (qw(
157	cf::global cf::attachable	198	cf::global cf::attachable
…		…
165	}	206	}
166		207
167	$Event::DIED = sub {	208	$Event::DIED = sub {
168	warn "error in event callback: @_";	209	warn "error in event callback: @_";
169	};	210	};
		211
		212	#############################################################################
170		213
171	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
172		215
173	=over 4	216	=over 4
174		217
…		…
193	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	236	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
194	$d	237	$d
195	} || "[unable to dump $_[0]: '$@']";	238	} || "[unable to dump $_[0]: '$@']";
196	}	239	}
197		240
198	use JSON::Syck (); # TODO# replace by JSON::PC once working	241	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
199		242
200	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
201		244
202	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
203		246
204	=cut
205
206	sub from_json($) {
207	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
208	JSON::Syck::Load $_[0]
209	}
210
211	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
212		248
213	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
214
215	=cut
216
217	sub to_json($) {
218	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
219	JSON::Syck::Dump $_[0]
220	}
221		250
222	=item cf::lock_wait $string	251	=item cf::lock_wait $string
223		252
224	Wait until the given lock is available. See cf::lock_acquire.	253	Wait until the given lock is available. See cf::lock_acquire.
225		254
…		…
231	returned.	260	returned.
232		261
233	Lock names should begin with a unique identifier (for example, cf::map::find	262	Lock names should begin with a unique identifier (for example, cf::map::find
234	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
235		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
236	=cut	269	=cut
237		270
238	our %LOCK;	271	our %LOCK;
239		272
240	sub lock_wait($) {	273	sub lock_wait($) {
…		…
259	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
260	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
261	}	294	}
262	}	295	}
263		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
264	sub freeze_mainloop {	303	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
266		305
267	my $guard = Coro::guard {	306	my $guard = Coro::guard {
268	$TICK_WATCHER->start;	307	$TICK_WATCHER->start;
269	$WRITE_RUNTIME_WATCHER->start;
270	};	308	};
271	$WRITE_RUNTIME_WATCHER->stop;
272	$TICK_WATCHER->stop;	309	$TICK_WATCHER->stop;
273	$guard	310	$guard
274	}	311	}
275		312
276	=item cf::async { BLOCK }	313	=item cf::async { BLOCK }
…		…
283		320
284	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
285		322
286	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
287		324
288	The design of crossfire+ requires that the main coro ($Coro::main) is	325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
289	always able to handle events or runnable, as crossfire+ is only partly	326	is always able to handle events or runnable, as Crossfire TRT is only
290	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
291		329
292	If it must be done, put the blocking parts into C<sync_job>. This will run	330	If it must be done, put the blocking parts into C<sync_job>. This will run
293	the given BLOCK in another coroutine while waiting for the result. The	331	the given BLOCK in another coroutine while waiting for the result. The
294	server will be frozen during this time, so the block should either finish	332	server will be frozen during this time, so the block should either finish
295	fast or be very important.	333	fast or be very important.
…		…
298		336
299	sub sync_job(&) {	337	sub sync_job(&) {
300	my ($job) = @_;	338	my ($job) = @_;
301		339
302	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
303	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
304	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
305		345
306	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
307	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
318		358
319	while ($busy) {	359	while ($busy) {
320	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
321	}	361	}
322		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
323	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
324	} else {	371	} else {
325	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
326		373
327	$job->()	374	$job->()
…		…
346	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
347		394
348	$coro	395	$coro
349	}	396	}
350		397
351	sub write_runtime {	398	=item fork_call { }, $args
352	my $runtime = cf::localdir . "/runtime";
353		399
354	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	400	Executes the given code block with the given arguments in a seperate
355	or return;	401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
356		404
357	my $value = $cf::RUNTIME + 90 + 10;	405	=cut
358	# 10 is the runtime save interval, for a monotonic clock
359	# 60 allows for the watchdog to kill the server.
360		406
361	(aio_write $fh, 0, (length $value), $value, 0) <= 0	407	sub fork_call(&@) {
362	and return;	408	my ($cb, @args) = @_;
363		409
364	# always fsync - this file is important	410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
365	aio_fsync $fh	411	# or die "socketpair: $!";
366	and return;	412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
367		414
		415	if (my $pid = fork) {
368	close $fh	416	close $fh2;
369	or return;
370		417
371	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
372	and return;	419	$res = Coro::Storable::thaw $res;
373		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
374	1	439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
		556	}
		557
		558	=item cf::datalog type => key => value, ...
		559
		560	Log a datalog packet of the given type with the given key-value pairs.
		561
		562	=cut
		563
		564	sub datalog($@) {
		565	my ($type, %kv) = @_;
		566	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
375	}	567	}
376		568
377	=back	569	=back
378		570
379	=cut	571	=cut
…		…
386	attach callbacks/event handlers (a collection of which is called an "attachment")	578	attach callbacks/event handlers (a collection of which is called an "attachment")
387	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
388		580
389	In the following description, CLASS can be any of C<global>, C<object>	581	In the following description, CLASS can be any of C<global>, C<object>
390	C<player>, C<client> or C<map> (i.e. the attachable objects in	582	C<player>, C<client> or C<map> (i.e. the attachable objects in
391	crossfire+).	583	Crossfire TRT).
392		584
393	=over 4	585	=over 4
394		586
395	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
396		588
…		…
559	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
560		752
561	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
562	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
563	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
564	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
565		757
566	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
567	my $pkg = shift @arg;	759	my $pkg = shift @arg;
568		760
569	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
598	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
599	}	791	}
600		792
601	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
602	} else {	794	} else {
603	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
604	}	796	}
605		797
606	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
607	}	799	}
608		800
…		…
610	if (ref $_[0]) {	802	if (ref $_[0]) {
611	_object_attach @_;	803	_object_attach @_;
612	} else {	804	} else {
613	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
614	}	806	}
		807	_recalc_want;
615	};	808	};
616		809
617	# all those should be optimised	810	# all those should be optimised
618	sub cf::attachable::detach {	811	sub cf::attachable::detach {
619	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
622	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
623	reattach ($obj);	816	reattach ($obj);
624	} else {	817	} else {
625	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
626	}	819	}
		820	_recalc_want;
627	};	821	};
628		822
629	sub cf::attachable::attached {	823	sub cf::attachable::attached {
630	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
631		825
…		…
778	}	972	}
779	} else {	973	} else {
780	aio_unlink $filename;	974	aio_unlink $filename;
781	aio_unlink "$filename.pst";	975	aio_unlink "$filename.pst";
782	}	976	}
783
784	#d##TODO# nuke non .map-files if exist
785	if ($filename =~ s/\.map$//) {
786	aio_unlink $filename;
787	aio_unlink "$filename.pst";
788	}
789	}	977	}
790	}	978	}
791		979
792	sub object_freezer_as_string {	980	sub object_freezer_as_string {
793	my ($rdata, $objs) = @_;	981	my ($rdata, $objs) = @_;
…		…
799		987
800	sub object_thawer_load {	988	sub object_thawer_load {
801	my ($filename) = @_;	989	my ($filename) = @_;
802		990
803	my ($data, $av);	991	my ($data, $av);
804
805	#d#TODO remove .map if file does not exist
806	aio_stat $filename and $filename =~ s/\.map$//;
807		992
808	(aio_load $filename, $data) >= 0	993	(aio_load $filename, $data) >= 0
809	or return;	994	or return;
810		995
811	unless (aio_stat "$filename.pst") {	996	unless (aio_stat "$filename.pst") {
…		…
813	or return;	998	or return;
814	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
815	}	1000	}
816		1001
817	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
818	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
819	return ($data, $av);	1004	return ($data, $av);
820	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
821		1012
822	#############################################################################	1013	#############################################################################
823	# command handling &c	1014	# command handling &c
824		1015
825	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
838	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
839	}	1030	}
840		1031
841	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
842		1033
843	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
844		1035
845	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
846	called.	1037	called.
847		1038
848	=cut	1039	=cut
…		…
883		1074
884	cf::override;	1075	cf::override;
885	},	1076	},
886	);	1077	);
887		1078
888	sub load_extension {
889	my ($path) = @_;
890
891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
892	my $base = $1;
893	my $pkg = $1;
894	$pkg =~ s/[^[:word:]]/_/g;
895	$pkg = "ext::$pkg";
896
897	warn "... loading '$path' into '$pkg'\n";
898
899	open my $fh, "<:utf8", $path
900	or die "$path: $!";
901
902	my $source =
903	"package $pkg; use strict; use utf8;\n"
904	. "#line 1 \"$path\"\n{\n"
905	. (do { local $/; <$fh> })
906	. "\n};\n1";
907
908	unless (eval $source) {
909	my $msg = $@ ? "$path: $@\n"
910	: "extension disabled.\n";
911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912	warn $@;
913	warn "mandatory extension failed to load, exiting.\n";
914	exit 1;
915	}
916	die $@;
917	}
918
919	push @EXTS, $pkg;
920	}
921
922	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
923	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
924	next unless -r $ext;	1084	next unless -r $path;
925	eval {	1085
926	load_extension $ext;	1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
927	1	1143	}
928	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
929	}	1149	};
930	}	1150	}
931		1151
932	#############################################################################	1152	#############################################################################
933		1153
		1154	=back
		1155
934	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
935		1157
936	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
937		1159
938	=cut	1160	=cut
…		…
950	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
951		1173
952	=cut	1174	=cut
953		1175
954	sub playerdir($) {	1176	sub playerdir($) {
955	cf::localdir	1177	"$PLAYERDIR/"
956	. "/"
957	. cf::playerdir
958	. "/"
959	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
960	}	1179	}
961		1180
962	sub path($) {	1181	sub path($) {
963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964		1183
965	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
966	}	1185	}
967		1186
968	sub find_active($) {	1187	sub find_active($) {
969	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
970	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
983	my $login = $_[0];	1202	my $login = $_[0];
984		1203
985	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
986		1205
987	$cf::PLAYER{$_[0]} || do {	1206	$cf::PLAYER{$_[0]} || do {
		1207	# rename old playerfiles to new ones
		1208	#TODO: remove when no longer required
		1209	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1210	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1211	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1212	aio_unlink +(playerdir $login) . "/$login.pl";
		1213
988	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
989	or return;	1215	or return;
990	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
991	}	1217	}
992	}	1218	}
…		…
1029		1255
1030	=cut	1256	=cut
1031		1257
1032	sub quit_character {	1258	sub quit_character {
1033	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1034		1262
1035	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1036	$pl->password ("*"); # this should lock out the player until we nuked the dir	1264	$pl->password ("*"); # this should lock out the player until we nuked the dir
1037		1265
1038	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1043	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1044	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1045	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1046	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1047	$pl->destroy;	1275	$pl->destroy;
		1276
		1277	my $prefix = qr<^~\Q$name\E/>;
		1278
		1279	# nuke player maps
		1280	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1281
1048	IO::AIO::aio_rmtree $temp;	1282	IO::AIO::aio_rmtree $temp;
		1283	}
		1284
		1285	=item $pl->kick
		1286
		1287	Kicks a player out of the game. This destroys the connection.
		1288
		1289	=cut
		1290
		1291	sub kick {
		1292	my ($pl, $kicker) = @_;
		1293
		1294	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1295	$pl->killer ("kicked");
		1296	$pl->ns->destroy;
1049	}	1297	}
1050		1298
1051	=item cf::player::list_logins	1299	=item cf::player::list_logins
1052		1300
1053	Returns am arrayref of all valid playernames in the system, can take a	1301	Returns am arrayref of all valid playernames in the system, can take a
1054	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1055		1303
1056	=cut	1304	=cut
1057		1305
1058	sub list_logins {	1306	sub list_logins {
1059	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1060	or return [];	1308	or return [];
1061		1309
1062	my @logins;	1310	my @logins;
1063		1311
1064	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1099	}	1347	}
1100		1348
1101	\@paths	1349	\@paths
1102	}	1350	}
1103		1351
1104	=item $player->ext_reply ($msgid, $msgtype, %msg)	1352	=item $player->ext_reply ($msgid, %msg)
1105		1353
1106	Sends an ext reply to the player.	1354	Sends an ext reply to the player.
1107		1355
1108	=cut	1356	=cut
1109		1357
1110	sub ext_reply($$$%) {	1358	sub ext_reply($$%) {
1111	my ($self, $id, %msg) = @_;	1359	my ($self, $id, %msg) = @_;
1112		1360
1113	$msg{msgid} = $id;	1361	$msg{msgid} = $id;
1114		1362
1115	$self->send ("ext " . cf::to_json \%msg);	1363	$self->send ("ext " . cf::to_json \%msg);
1116	}	1364	}
1117		1365
1118	package cf;	1366	=item $player->ext_event ($type, %msg)
		1367
		1368	Sends an ext event to the client.
		1369
		1370	=cut
		1371
		1372	sub ext_event($$%) {
		1373	my ($self, $type, %msg) = @_;
		1374
		1375	$self->ns->ext_event ($type, %msg);
		1376	}
		1377
		1378	=head3 cf::region
		1379
		1380	=over 4
		1381
		1382	=cut
		1383
		1384	package cf::region;
		1385
		1386	=item cf::region::find_by_path $path
		1387
		1388	Tries to decuce the likely region for a map knowing only its path.
		1389
		1390	=cut
		1391
		1392	sub find_by_path($) {
		1393	my ($path) = @_;
		1394
		1395	my ($match, $specificity);
		1396
		1397	for my $region (list) {
		1398	if ($region->match && $path =~ $region->match) {
		1399	($match, $specificity) = ($region, $region->specificity)
		1400	if $region->specificity > $specificity;
		1401	}
		1402	}
		1403
		1404	$match
		1405	}
1119		1406
1120	=back	1407	=back
1121
1122		1408
1123	=head3 cf::map	1409	=head3 cf::map
1124		1410
1125	=over 4	1411	=over 4
1126		1412
…		…
1181	my ($self, $merge) = @_;	1467	my ($self, $merge) = @_;
1182		1468
1183	# we have to keep some variables in memory intact	1469	# we have to keep some variables in memory intact
1184	local $self->{path};	1470	local $self->{path};
1185	local $self->{load_path};	1471	local $self->{load_path};
1186	local $self->{deny_save};
1187	local $self->{deny_reset};
1188		1472
1189	$self->SUPER::thawer_merge ($merge);	1473	$self->SUPER::thawer_merge ($merge);
1190	}	1474	}
1191		1475
1192	sub normalise {	1476	sub normalise {
…		…
1264		1548
1265	# the original (read-only) location	1549	# the original (read-only) location
1266	sub load_path {	1550	sub load_path {
1267	my ($self) = @_;	1551	my ($self) = @_;
1268		1552
1269	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1553	"$MAPDIR/$self->{path}.map"
1270	}	1554	}
1271		1555
1272	# the temporary/swap location	1556	# the temporary/swap location
1273	sub save_path {	1557	sub save_path {
1274	my ($self) = @_;	1558	my ($self) = @_;
1275		1559
1276	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1560	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1561	"$TMPDIR/$path.map"
1278	}	1562	}
1279		1563
1280	# the unique path, undef == no special unique path	1564	# the unique path, undef == no special unique path
1281	sub uniq_path {	1565	sub uniq_path {
1282	my ($self) = @_;	1566	my ($self) = @_;
1283		1567
1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1568	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1569	"$UNIQUEDIR/$path"
1286	}	1570	}
1287		1571
1288	# and all this just because we cannot iterate over	1572	# and all this just because we cannot iterate over
1289	# all maps in C++...	1573	# all maps in C++...
1290	sub change_all_map_light {	1574	sub change_all_map_light {
…		…
1292		1576
1293	$_->change_map_light ($change)	1577	$_->change_map_light ($change)
1294	for grep $_->outdoor, values %cf::MAP;	1578	for grep $_->outdoor, values %cf::MAP;
1295	}	1579	}
1296		1580
		1581	sub decay_objects {
		1582	my ($self) = @_;
		1583
		1584	return if $self->{deny_reset};
		1585
		1586	$self->do_decay_objects;
		1587	}
		1588
1297	sub unlink_save {	1589	sub unlink_save {
1298	my ($self) = @_;	1590	my ($self) = @_;
1299		1591
1300	utf8::encode (my $save = $self->save_path);	1592	utf8::encode (my $save = $self->save_path);
1301	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1593	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1302	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1594	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1303
1304	#d#TODO remove .map and also nuke
1305	$save =~ s/\.map// or return;#d#
1306	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1307	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1308	}	1595	}
1309		1596
1310	sub load_header_from($) {	1597	sub load_header_from($) {
1311	my ($self, $path) = @_;	1598	my ($self, $path) = @_;
1312		1599
…		…
1362	$self->load_header_orig	1649	$self->load_header_orig
1363	or return;	1650	or return;
1364	$self->prepare_orig;	1651	$self->prepare_orig;
1365	}	1652	}
1366		1653
		1654	$self->{deny_reset} = 1
		1655	if $self->no_reset;
		1656
		1657	$self->default_region (cf::region::find_by_path $self->{path})
		1658	unless $self->default_region;
		1659
1367	1	1660	1
1368	}	1661	}
1369		1662
1370	sub find;	1663	sub find;
1371	sub find {	1664	sub find {
…		…
1383	$map->{last_save} = $cf::RUNTIME;	1676	$map->{last_save} = $cf::RUNTIME;
1384		1677
1385	$map->load_header	1678	$map->load_header
1386	or return;	1679	or return;
1387		1680
1388	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1681	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1389	# doing this can freeze the server in a sync job, obviously	1682	# doing this can freeze the server in a sync job, obviously
1390	#$cf::WAIT_FOR_TICK->wait;	1683	#$cf::WAIT_FOR_TICK->wait;
1391	$map->reset;	1684	$map->reset;
1392	undef $guard;	1685	undef $guard;
1393	return find $path;	1686	return find $path;
…		…
1404	my ($self) = @_;	1697	my ($self) = @_;
1405		1698
1406	local $self->{deny_reset} = 1; # loading can take a long time	1699	local $self->{deny_reset} = 1; # loading can take a long time
1407		1700
1408	my $path = $self->{path};	1701	my $path = $self->{path};
		1702
		1703	{
1409	my $guard = cf::lock_acquire "map_load:$path";	1704	my $guard = cf::lock_acquire "map_load:$path";
1410		1705
1411	return if $self->in_memory != cf::MAP_SWAPPED;	1706	return if $self->in_memory != cf::MAP_SWAPPED;
1412		1707
1413	$self->in_memory (cf::MAP_LOADING);	1708	$self->in_memory (cf::MAP_LOADING);
1414		1709
1415	$self->alloc;	1710	$self->alloc;
1416		1711
1417	$self->pre_load;	1712	$self->pre_load;
1418
1419	$self->_load_objects ($self->{load_path}, 1)
1420	or return;
1421
1422	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423	if delete $self->{load_original};
1424
1425	if (my $uniq = $self->uniq_path) {
1426	utf8::encode $uniq;
1427	if (aio_open $uniq, O_RDONLY, 0) {
1428	$self->clear_unique_items;
1429	$self->_load_objects ($uniq, 0);
1430	}
1431	}
1432
1433	Coro::cede;
1434
1435	# now do the right thing for maps
1436	$self->link_multipart_objects;
1437
1438	unless ($self->{deny_activate}) {
1439	$self->decay_objects;
1440	$self->fix_auto_apply;
1441	$self->update_buttons;
1442	Coro::cede;	1713	Coro::cede;
1443	$self->set_darkness_map;	1714
		1715	$self->_load_objects ($self->{load_path}, 1)
		1716	or return;
		1717
		1718	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1719	if delete $self->{load_original};
		1720
		1721	if (my $uniq = $self->uniq_path) {
		1722	utf8::encode $uniq;
		1723	if (aio_open $uniq, O_RDONLY, 0) {
		1724	$self->clear_unique_items;
		1725	$self->_load_objects ($uniq, 0);
		1726	}
		1727	}
		1728
		1729	Coro::cede;
		1730	# now do the right thing for maps
		1731	$self->link_multipart_objects;
1444	$self->difficulty ($self->estimate_difficulty)	1732	$self->difficulty ($self->estimate_difficulty)
1445	unless $self->difficulty;	1733	unless $self->difficulty;
1446	Coro::cede;	1734	Coro::cede;
		1735
		1736	unless ($self->{deny_activate}) {
		1737	$self->decay_objects;
		1738	$self->fix_auto_apply;
		1739	$self->update_buttons;
		1740	Coro::cede;
		1741	$self->set_darkness_map;
		1742	Coro::cede;
1447	$self->activate;	1743	$self->activate;
		1744	}
		1745
		1746	$self->in_memory (cf::MAP_IN_MEMORY);
1448	}	1747	}
1449		1748
1450	$self->post_load;	1749	$self->post_load;
1451
1452	$self->in_memory (cf::MAP_IN_MEMORY);
1453	}	1750	}
1454		1751
1455	sub customise_for {	1752	sub customise_for {
1456	my ($self, $ob) = @_;	1753	my ($self, $ob) = @_;
1457		1754
1458	return find "~" . $ob->name . "/" . $self->{path}	1755	return find "~" . $ob->name . "/" . $self->{path}
1459	if $self->per_player;	1756	if $self->per_player;
		1757
		1758	# return find "?party/" . $ob->name . "/" . $self->{path}
		1759	# if $self->per_party;
1460		1760
1461	$self	1761	$self
1462	}	1762	}
1463		1763
1464	# find and load all maps in the 3x3 area around a map	1764	# find and load all maps in the 3x3 area around a map
…		…
1575		1875
1576	sub reset_at {	1876	sub reset_at {
1577	my ($self) = @_;	1877	my ($self) = @_;
1578		1878
1579	# TODO: safety, remove and allow resettable per-player maps	1879	# TODO: safety, remove and allow resettable per-player maps
1580	return 1e99 if $self->isa ("ext::map_per_player");#d#
1581	return 1e99 if $self->{deny_reset};	1880	return 1e99 if $self->{deny_reset};
1582		1881
1583	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1882	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1584	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1883	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1585		1884
…		…
1596	my ($self) = @_;	1895	my ($self) = @_;
1597		1896
1598	my $lock = cf::lock_acquire "map_data:$self->{path}";	1897	my $lock = cf::lock_acquire "map_data:$self->{path}";
1599		1898
1600	return if $self->players;	1899	return if $self->players;
1601	return if $self->isa ("ext::map_per_player");#d#
1602		1900
1603	warn "resetting map ", $self->path;#d#	1901	warn "resetting map ", $self->path;
		1902
		1903	$self->in_memory (cf::MAP_SWAPPED);
		1904
		1905	# need to save uniques path
		1906	unless ($self->{deny_save}) {
		1907	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1908
		1909	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1910	if $uniq;
		1911	}
1604		1912
1605	delete $cf::MAP{$self->path};	1913	delete $cf::MAP{$self->path};
1606		1914
1607	$self->in_memory (cf::MAP_SWAPPED);
1608	$self->clear;	1915	$self->clear;
1609		1916
1610	$_->clear_links_to ($self) for values %cf::MAP;	1917	$_->clear_links_to ($self) for values %cf::MAP;
1611		1918
1612	$self->unlink_save;	1919	$self->unlink_save;
…		…
1631	$cf::MAP{$self->path} = $self;	1938	$cf::MAP{$self->path} = $self;
1632		1939
1633	$self->reset; # polite request, might not happen	1940	$self->reset; # polite request, might not happen
1634	}	1941	}
1635		1942
		1943	=item $maps = cf::map::tmp_maps
		1944
		1945	Returns an arrayref with all map paths of currently instantiated and saved
		1946	maps. May block.
		1947
		1948	=cut
		1949
		1950	sub tmp_maps() {
		1951	[
		1952	map {
		1953	utf8::decode $_;
		1954	/\.map$/
		1955	? normalise $_
		1956	: ()
		1957	} @{ aio_readdir $TMPDIR or [] }
		1958	]
		1959	}
		1960
		1961	=item $maps = cf::map::random_maps
		1962
		1963	Returns an arrayref with all map paths of currently instantiated and saved
		1964	random maps. May block.
		1965
		1966	=cut
		1967
		1968	sub random_maps() {
		1969	[
		1970	map {
		1971	utf8::decode $_;
		1972	/\.map$/
		1973	? normalise "?random/$_"
		1974	: ()
		1975	} @{ aio_readdir $RANDOMDIR or [] }
		1976	]
		1977	}
		1978
1636	=item cf::map::unique_maps	1979	=item cf::map::unique_maps
1637		1980
1638	Returns an arrayref of paths of all shared maps that have	1981	Returns an arrayref of paths of all shared maps that have
1639	instantiated unique items. May block.	1982	instantiated unique items. May block.
1640		1983
1641	=cut	1984	=cut
1642		1985
1643	sub unique_maps() {	1986	sub unique_maps() {
1644	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	1987	[
1645	or return;	1988	map {
1646
1647	my @paths;
1648
1649	for (@$files) {
1650	utf8::decode $_;	1989	utf8::decode $_;
1651	next if /\.pst$/;	1990	/\.map$/
1652	next unless /^$PATH_SEP/o;	1991	? normalise $_
1653		1992	: ()
1654	push @paths, cf::map::normalise $_;	1993	} @{ aio_readdir $UNIQUEDIR or [] }
1655	}	1994	]
1656
1657	\@paths
1658	}	1995	}
1659		1996
1660	package cf;	1997	package cf;
1661		1998
1662	=back	1999	=back
…		…
1708		2045
1709	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2046	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1710		2047
1711	if ($self->{record_replies}) {	2048	if ($self->{record_replies}) {
1712	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2049	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2050
1713	} else {	2051	} else {
		2052	my $pl = $self->contr;
		2053
		2054	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2055	my $diag = $pl->{npc_dialog};
		2056	$diag->{pl}->ext_reply (
		2057	$diag->{id}, msgtype => "reply", msg => $msg, add_topics => []
		2058	);
		2059
		2060	} else {
1714	$msg = $npc->name . " says: $msg" if $npc;	2061	$msg = $npc->name . " says: $msg" if $npc;
1715	$self->message ($msg, $flags);	2062	$self->message ($msg, $flags);
		2063	}
1716	}	2064	}
1717	}	2065	}
1718		2066
1719	=item $player_object->may ("access")	2067	=item $player_object->may ("access")
1720		2068
…		…
1768	$self->deactivate_recursive;	2116	$self->deactivate_recursive;
1769		2117
1770	return if UNIVERSAL::isa $self->map, "ext::map_link";	2118	return if UNIVERSAL::isa $self->map, "ext::map_link";
1771		2119
1772	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2120	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1773	if $self->map;	2121	if $self->map && $self->map->{path} ne "{link}";
1774		2122
1775	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2123	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1776	}	2124	}
1777		2125
1778	sub cf::object::player::leave_link {	2126	sub cf::object::player::leave_link {
1779	my ($self, $map, $x, $y) = @_;	2127	my ($self, $map, $x, $y) = @_;
		2128
		2129	return unless $self->contr->active;
1780		2130
1781	my $link_pos = delete $self->{_link_pos};	2131	my $link_pos = delete $self->{_link_pos};
1782		2132
1783	unless ($map) {	2133	unless ($map) {
1784	# restore original map position	2134	# restore original map position
…		…
1802	$map->load;	2152	$map->load;
1803	$map->load_diag;	2153	$map->load_diag;
1804		2154
1805	return unless $self->contr->active;	2155	return unless $self->contr->active;
1806	$self->activate_recursive;	2156	$self->activate_recursive;
		2157
		2158	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1807	$self->enter_map ($map, $x, $y);	2159	$self->enter_map ($map, $x, $y);
1808	}	2160	}
1809		2161
1810	cf::player->attach (
1811	on_logout => sub {
1812	my ($pl) = @_;
1813
1814	# abort map switching before logout
1815	if ($pl->ob->{_link_pos}) {
1816	cf::sync_job {
1817	$pl->ob->leave_link
1818	};
1819	}
1820	},
1821	on_login => sub {
1822	my ($pl) = @_;
1823
1824	# try to abort aborted map switching on player login :)
1825	# should happen only on crashes
1826	if ($pl->ob->{_link_pos}) {
1827	$pl->ob->enter_link;
1828	(async {
1829	# we need this sleep as the login has a concurrent enter_exit running
1830	# and this sleep increases chances of the player not ending up in scorn
1831	$pl->ob->reply (undef,
1832	"There was an internal problem at your last logout, "
1833	. "the server will try to bring you to your intended destination in a second.",
1834	cf::NDI_RED);
1835	Coro::Timer::sleep 1;
1836	$pl->ob->leave_link;
1837	})->prio (2);
1838	}
1839	},
1840	);
1841
1842	=item $player_object->goto ($path, $x, $y)	2162	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1843		2163
		2164	Moves the player to the given map-path and coordinates by first freezing
		2165	her, loading and preparing them map, calling the provided $check callback
		2166	that has to return the map if sucecssful, and then unfreezes the player on
		2167	the new (success) or old (failed) map position.
		2168
1844	=cut	2169	=cut
		2170
		2171	our $GOTOGEN;
1845		2172
1846	sub cf::object::player::goto {	2173	sub cf::object::player::goto {
1847	my ($self, $path, $x, $y) = @_;	2174	my ($self, $path, $x, $y, $check) = @_;
		2175
		2176	# do generation counting so two concurrent goto's will be executed in-order
		2177	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1848		2178
1849	$self->enter_link;	2179	$self->enter_link;
1850		2180
1851	(async {	2181	(async {
1852	my $map = eval {	2182	my $map = eval {
1853	my $map = cf::map::find $path;	2183	my $map = cf::map::find $path;
		2184
		2185	if ($map) {
1854	$map = $map->customise_for ($self) if $map;	2186	$map = $map->customise_for ($self);
		2187	$map = $check->($map) if $check && $map;
		2188	} else {
		2189	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2190	}
		2191
1855	$map	2192	$map
		2193	};
		2194
		2195	if ($@) {
		2196	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2197	LOG llevError | logBacktrace, Carp::longmess $@;
1856	} or	2198	}
1857	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1858		2199
		2200	if ($gen == $self->{_goto_generation}) {
		2201	delete $self->{_goto_generation};
1859	$self->leave_link ($map, $x, $y);	2202	$self->leave_link ($map, $x, $y);
		2203	}
1860	})->prio (1);	2204	})->prio (1);
1861	}	2205	}
1862		2206
1863	=item $player_object->enter_exit ($exit_object)	2207	=item $player_object->enter_exit ($exit_object)
1864		2208
…		…
1903		2247
1904	$rmp->{random_seed} ||= $exit->random_seed;	2248	$rmp->{random_seed} ||= $exit->random_seed;
1905		2249
1906	my $data = cf::to_json $rmp;	2250	my $data = cf::to_json $rmp;
1907	my $md5 = Digest::MD5::md5_hex $data;	2251	my $md5 = Digest::MD5::md5_hex $data;
1908	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2252	my $meta = "$RANDOMDIR/$md5.meta";
1909		2253
1910	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2254	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1911	aio_write $fh, 0, (length $data), $data, 0;	2255	aio_write $fh, 0, (length $data), $data, 0;
1912	undef $fh;	2256	undef $fh;
1913	aio_rename "$meta~", $meta;	2257	aio_rename "$meta~", $meta;
…		…
1922		2266
1923	return unless $self->type == cf::PLAYER;	2267	return unless $self->type == cf::PLAYER;
1924		2268
1925	if ($exit->slaying eq "/!") {	2269	if ($exit->slaying eq "/!") {
1926	#TODO: this should de-fi-ni-te-ly not be a sync-job	2270	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2271	# the problem is that $exit might not survive long enough
		2272	# so it needs to be done right now, right here
1927	cf::sync_job { prepare_random_map $exit };	2273	cf::sync_job { prepare_random_map $exit };
1928	}	2274	}
1929		2275
1930	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2276	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1931	my $hp = $exit->stats->hp;	2277	my $hp = $exit->stats->hp;
…		…
1939	$self->goto ($slaying, $hp, $sp);	2285	$self->goto ($slaying, $hp, $sp);
1940		2286
1941	1;	2287	1;
1942	}) {	2288	}) {
1943	$self->message ("Something went wrong deep within the crossfire server. "	2289	$self->message ("Something went wrong deep within the crossfire server. "
1944	. "I'll try to bring you back to the map you were before. "	2290	. "I'll try to bring you back to the map you were before. "
1945	. "Please report this to the dungeon master!",	2291	. "Please report this to the dungeon master!",
1946	cf::NDI_UNIQUE | cf::NDI_RED);	2292	cf::NDI_UNIQUE | cf::NDI_RED);
1947		2293
1948	warn "ERROR in enter_exit: $@";	2294	warn "ERROR in enter_exit: $@";
1949	$self->leave_link;	2295	$self->leave_link;
1950	}	2296	}
1951	})->prio (1);	2297	})->prio (1);
…		…
1964		2310
1965	sub cf::client::send_drawinfo {	2311	sub cf::client::send_drawinfo {
1966	my ($self, $text, $flags) = @_;	2312	my ($self, $text, $flags) = @_;
1967		2313
1968	utf8::encode $text;	2314	utf8::encode $text;
1969	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2315	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1970	}	2316	}
1971		2317
		2318	=item $client->ext_event ($type, %msg)
		2319
		2320	Sends an exti event to the client.
		2321
		2322	=cut
		2323
		2324	sub cf::client::ext_event($$%) {
		2325	my ($self, $type, %msg) = @_;
		2326
		2327	$msg{msgtype} = "event_$type";
		2328	$self->send_packet ("ext " . cf::to_json \%msg);
		2329	}
1972		2330
1973	=item $success = $client->query ($flags, "text", \&cb)	2331	=item $success = $client->query ($flags, "text", \&cb)
1974		2332
1975	Queues a query to the client, calling the given callback with	2333	Queues a query to the client, calling the given callback with
1976	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2334	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
2073		2431
2074	# here we export the classes and methods available to script code	2432	# here we export the classes and methods available to script code
2075		2433
2076	=pod	2434	=pod
2077		2435
2078	The following fucntions and emthods are available within a safe environment:	2436	The following functions and methods are available within a safe environment:
2079		2437
2080	cf::object contr pay_amount pay_player map	2438	cf::object contr pay_amount pay_player map
2081	cf::object::player player	2439	cf::object::player player
2082	cf::player peaceful	2440	cf::player peaceful
2083	cf::map trigger	2441	cf::map trigger
…		…
2164	=back	2522	=back
2165		2523
2166	=cut	2524	=cut
2167		2525
2168	#############################################################################	2526	#############################################################################
2169
2170	=head2 EXTENSION DATABASE SUPPORT
2171
2172	Crossfire maintains a very simple database for extension use. It can
2173	currently store anything that can be serialised using Storable, which
2174	excludes objects.
2175
2176	The parameter C<$family> should best start with the name of the extension
2177	using it, it should be unique.
2178
2179	=over 4
2180
2181	=item $hashref = cf::db_get $family
2182
2183	Return a hashref for use by the extension C<$family>, which can be
2184	modified. After modifications, you have to call C<cf::db_dirty> or
2185	C<cf::db_sync>.
2186
2187	=item $value = cf::db_get $family => $key
2188
2189	Returns a single value from the database
2190
2191	=item cf::db_put $family => $hashref
2192
2193	Stores the given family hashref into the database. Updates are delayed, if
2194	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196	=item cf::db_put $family => $key => $value
2197
2198	Stores the given C<$value> in the family hash. Updates are delayed, if you
2199	want the data to be synced to disk immediately, use C<cf::db_sync>.
2200
2201	=item cf::db_dirty
2202
2203	Marks the database as dirty, to be updated at a later time.
2204
2205	=item cf::db_sync
2206
2207	Immediately write the database to disk I<if it is dirty>.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	{
2214	my $path = cf::localdir . "/database.pst";
2215
2216	sub db_load() {
2217	$DB = stat $path ? Storable::retrieve $path : { };
2218	}
2219
2220	my $pid;
2221
2222	sub db_save() {
2223	waitpid $pid, 0 if $pid;
2224	if (0 == ($pid = fork)) {
2225	$DB->{_meta}{version} = 1;
2226	Storable::nstore $DB, "$path~";
2227	rename "$path~", $path;
2228	cf::_exit 0 if defined $pid;
2229	}
2230	}
2231
2232	my $dirty;
2233
2234	sub db_sync() {
2235	db_save if $dirty;
2236	undef $dirty;
2237	}
2238
2239	my $idle = Event->idle (
2240	reentrant => 0,
2241	min => 10,
2242	max => 20,
2243	repeat => 0,
2244	data => WF_AUTOCANCEL,
2245	cb => \&db_sync,
2246	);
2247
2248	sub db_dirty() {
2249	$dirty = 1;
2250	$idle->start;
2251	}
2252
2253	sub db_get($;$) {
2254	@_ >= 2
2255	? $DB->{$_[0]}{$_[1]}
2256	: ($DB->{$_[0]} ||= { })
2257	}
2258
2259	sub db_put($$;$) {
2260	if (@_ >= 3) {
2261	$DB->{$_[0]}{$_[1]} = $_[2];
2262	} else {
2263	$DB->{$_[0]} = $_[1];
2264	}
2265	db_dirty;
2266	}
2267
2268	cf::global->attach (
2269	prio => 10000,
2270	on_cleanup => sub {
2271	db_sync;
2272	},
2273	);
2274	}
2275
2276	#############################################################################
2277	# the server's init and main functions	2527	# the server's init and main functions
2278		2528
2279	sub load_resources {	2529	sub load_facedata($) {
2280	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2530	my ($path) = @_;
		2531
		2532	warn "loading facedata from $path\n";
		2533
		2534	my $facedata;
		2535	0 < aio_load $path, $facedata
		2536	or die "$path: $!";
		2537
		2538	$facedata = Coro::Storable::thaw $facedata;
		2539
		2540	$facedata->{version} == 2
		2541	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2542
		2543	{
		2544	my $faces = $facedata->{faceinfo};
		2545
		2546	while (my ($face, $info) = each %$faces) {
		2547	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2548	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2549	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2550	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2551	Coro::cede;
		2552	}
		2553
		2554	while (my ($face, $info) = each %$faces) {
		2555	next unless $info->{smooth};
		2556	my $idx = cf::face::find $face
		2557	or next;
		2558	if (my $smooth = cf::face::find $info->{smooth}) {
		2559	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2560	} else {
		2561	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2562	}
		2563	Coro::cede;
		2564	}
		2565	}
		2566
		2567	{
		2568	my $anims = $facedata->{animinfo};
		2569
		2570	while (my ($anim, $info) = each %$anims) {
		2571	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2572	Coro::cede;
		2573	}
		2574
		2575	cf::anim::invalidate_all; # d'oh
		2576	}
		2577
		2578	1
		2579	}
		2580
		2581	sub reload_regions {
		2582	load_resource_file "$MAPDIR/regions"
2281	or die "unable to load regions file\n";#d#	2583	or die "unable to load regions file\n";
		2584	}
		2585
		2586	sub reload_facedata {
		2587	load_facedata "$DATADIR/facedata"
		2588	or die "unable to load facedata\n";
		2589	}
		2590
		2591	sub reload_archetypes {
		2592	load_resource_file "$DATADIR/archetypes"
		2593	or die "unable to load archetypes\n";
		2594	}
		2595
		2596	sub reload_treasures {
		2597	load_resource_file "$DATADIR/treasures"
		2598	or die "unable to load treasurelists\n";
		2599	}
		2600
		2601	sub reload_resources {
		2602	warn "reloading resource files...\n";
		2603
		2604	reload_regions;
		2605	reload_facedata;
		2606	#reload_archetypes;#d#
		2607	reload_archetypes;
		2608	reload_treasures;
		2609
		2610	warn "finished reloading resource files\n";
		2611	}
		2612
		2613	sub init {
		2614	reload_resources;
2282	}	2615	}
2283		2616
2284	sub cfg_load {	2617	sub cfg_load {
2285	open my $fh, "<:utf8", cf::confdir . "/config"	2618	open my $fh, "<:utf8", "$CONFDIR/config"
2286	or return;	2619	or return;
2287		2620
2288	local $/;	2621	local $/;
2289	*CFG = YAML::Syck::Load <$fh>;	2622	*CFG = YAML::Syck::Load <$fh>;
2290		2623
…		…
2298	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2631	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2299	and die "WARNING: m(un)lockall failed: $!\n";	2632	and die "WARNING: m(un)lockall failed: $!\n";
2300	};	2633	};
2301	warn $@ if $@;	2634	warn $@ if $@;
2302	}	2635	}
2303	}
2304
2305	sub init {
2306	load_resources;
2307	}	2636	}
2308		2637
2309	sub main {	2638	sub main {
2310	# we must not ever block the main coroutine	2639	# we must not ever block the main coroutine
2311	local $Coro::idle = sub {	2640	local $Coro::idle = sub {
…		…
2314	Event::one_event;	2643	Event::one_event;
2315	})->prio (Coro::PRIO_MAX);	2644	})->prio (Coro::PRIO_MAX);
2316	};	2645	};
2317		2646
2318	cfg_load;	2647	cfg_load;
2319	db_load;	2648	db_init;
2320	load_extensions;	2649	load_extensions;
2321		2650
2322	$TICK_WATCHER->start;	2651	$TICK_WATCHER->start;
2323	Event::loop;	2652	Event::loop;
2324	}	2653	}
…		…
2339	},	2668	},
2340	);	2669	);
2341	}	2670	}
2342	}	2671	}
2343		2672
		2673	sub write_runtime {
		2674	my $runtime = "$LOCALDIR/runtime";
		2675
		2676	# first touch the runtime file to show we are still running:
		2677	# the fsync below can take a very very long time.
		2678
		2679	IO::AIO::aio_utime $runtime, undef, undef;
		2680
		2681	my $guard = cf::lock_acquire "write_runtime";
		2682
		2683	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2684	or return;
		2685
		2686	my $value = $cf::RUNTIME + 90 + 10;
		2687	# 10 is the runtime save interval, for a monotonic clock
		2688	# 60 allows for the watchdog to kill the server.
		2689
		2690	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2691	and return;
		2692
		2693	# always fsync - this file is important
		2694	aio_fsync $fh
		2695	and return;
		2696
		2697	# touch it again to show we are up-to-date
		2698	aio_utime $fh, undef, undef;
		2699
		2700	close $fh
		2701	or return;
		2702
		2703	aio_rename "$runtime~", $runtime
		2704	and return;
		2705
		2706	warn "runtime file written.\n";
		2707
		2708	1
		2709	}
		2710
2344	sub emergency_save() {	2711	sub emergency_save() {
2345	my $freeze_guard = cf::freeze_mainloop;	2712	my $freeze_guard = cf::freeze_mainloop;
2346		2713
2347	warn "enter emergency perl save\n";	2714	warn "enter emergency perl save\n";
2348		2715
…		…
2363	my $map = $cf::MAP{$path} or next;	2730	my $map = $cf::MAP{$path} or next;
2364	$map->valid or next;	2731	$map->valid or next;
2365	$map->save;	2732	$map->save;
2366	}	2733	}
2367	warn "end emergency map save\n";	2734	warn "end emergency map save\n";
		2735
		2736	warn "begin emergency database checkpoint\n";
		2737	BDB::db_env_txn_checkpoint $DB_ENV;
		2738	warn "end emergency database checkpoint\n";
2368	};	2739	};
2369		2740
2370	warn "leave emergency perl save\n";	2741	warn "leave emergency perl save\n";
2371	}	2742	}
2372		2743
		2744	sub post_cleanup {
		2745	my ($make_core) = @_;
		2746
		2747	warn Carp::longmess "post_cleanup backtrace"
		2748	if $make_core;
		2749	}
		2750
2373	sub reload() {	2751	sub do_reload_perl() {
2374	# can/must only be called in main	2752	# can/must only be called in main
2375	if ($Coro::current != $Coro::main) {	2753	if ($Coro::current != $Coro::main) {
2376	warn "can only reload from main coroutine";	2754	warn "can only reload from main coroutine";
2377	return;	2755	return;
2378	}	2756	}
2379		2757
2380	warn "reloading...";	2758	warn "reloading...";
2381		2759
2382	warn "cancelling server ticker";	2760	warn "entering sync_job";
2383	$TICK_WATCHER->cancel;
2384		2761
		2762	cf::sync_job {
		2763	cf::write_runtime; # external watchdog should not bark
2385	cf::emergency_save;	2764	cf::emergency_save;
		2765	cf::write_runtime; # external watchdog should not bark
2386		2766
2387	eval {	2767	warn "syncing database to disk";
		2768	BDB::db_env_txn_checkpoint $DB_ENV;
		2769
2388	# if anything goes wrong in here, we should simply crash as we already saved	2770	# if anything goes wrong in here, we should simply crash as we already saved
2389
2390	warn "syncing database to disk";
2391	cf::db_sync;
2392		2771
2393	warn "cancelling all WF_AUTOCANCEL watchers";	2772	warn "cancelling all WF_AUTOCANCEL watchers";
2394	for (Event::all_watchers) {	2773	for (Event::all_watchers) {
2395	$_->cancel if $_->data & WF_AUTOCANCEL;	2774	$_->cancel if $_->data & WF_AUTOCANCEL;
2396	}	2775	}
2397		2776
2398	warn "flushing outstanding aio requests";	2777	warn "flushing outstanding aio requests";
2399	for (;;) {	2778	for (;;) {
		2779	BDB::flush;
2400	IO::AIO::flush;	2780	IO::AIO::flush;
2401	Coro::cede;	2781	Coro::cede;
2402	last unless IO::AIO::nreqs;	2782	last unless IO::AIO::nreqs || BDB::nreqs;
2403	warn "iterate...";	2783	warn "iterate...";
2404	}	2784	}
		2785
		2786	++$RELOAD;
2405		2787
2406	warn "cancelling all extension coros";	2788	warn "cancelling all extension coros";
2407	$_->cancel for values %EXT_CORO;	2789	$_->cancel for values %EXT_CORO;
2408	%EXT_CORO = ();	2790	%EXT_CORO = ();
2409		2791
…		…
2449	Symbol::delete_package "safe::$_"	2831	Symbol::delete_package "safe::$_"
2450	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2832	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2451		2833
2452	warn "unloading cf.pm \"a bit\"";	2834	warn "unloading cf.pm \"a bit\"";
2453	delete $INC{"cf.pm"};	2835	delete $INC{"cf.pm"};
		2836	delete $INC{"cf/pod.pm"};
2454		2837
2455	# don't, removes xs symbols, too,	2838	# don't, removes xs symbols, too,
2456	# and global variables created in xs	2839	# and global variables created in xs
2457	#Symbol::delete_package __PACKAGE__;	2840	#Symbol::delete_package __PACKAGE__;
2458		2841
…		…
2462	require cf;	2845	require cf;
2463	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2846	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2464		2847
2465	warn "loading config and database again";	2848	warn "loading config and database again";
2466	cf::cfg_load;	2849	cf::cfg_load;
2467	cf::db_load;
2468		2850
2469	warn "loading extensions";	2851	warn "loading extensions";
2470	cf::load_extensions;	2852	cf::load_extensions;
2471		2853
2472	warn "reattaching attachments to objects/players";	2854	warn "reattaching attachments to objects/players";
2473	_global_reattach;	2855	_global_reattach; # objects, sockets
2474	warn "reattaching attachments to maps";	2856	warn "reattaching attachments to maps";
2475	reattach $_ for values %MAP;	2857	reattach $_ for values %MAP;
		2858	warn "reattaching attachments to players";
		2859	reattach $_ for values %PLAYER;
2476		2860
2477	warn "loading reloadable resources";	2861	warn "leaving sync_job";
2478	load_resources;
2479		2862
2480	warn "restarting server ticker";	2863	1
2481		2864	} or do {
2482	$TICK_WATCHER->start;
2483	};
2484
2485	if ($@) {
2486	warn $@;	2865	warn $@;
2487	warn "error while reloading, exiting.";	2866	warn "error while reloading, exiting.";
2488	exit 1;	2867	exit 1;
2489	}	2868	};
2490		2869
2491	warn "reloaded";	2870	warn "reloaded";
2492	};	2871	};
2493		2872
2494	our $RELOAD_WATCHER; # used only during reload	2873	our $RELOAD_WATCHER; # used only during reload
2495		2874
		2875	sub reload_perl() {
		2876	# doing reload synchronously and two reloads happen back-to-back,
		2877	# coro crashes during coro_state_free->destroy here.
		2878
		2879	$RELOAD_WATCHER ||= Event->timer (
		2880	reentrant => 0,
		2881	after => 0,
		2882	data => WF_AUTOCANCEL,
		2883	cb => sub {
		2884	do_reload_perl;
		2885	undef $RELOAD_WATCHER;
		2886	},
		2887	);
		2888	}
		2889
2496	register_command "reload" => sub {	2890	register_command "reload" => sub {
2497	my ($who, $arg) = @_;	2891	my ($who, $arg) = @_;
2498		2892
2499	if ($who->flag (FLAG_WIZ)) {	2893	if ($who->flag (FLAG_WIZ)) {
2500	$who->message ("reloading server.");	2894	$who->message ("reloading server.");
2501		2895	async { reload_perl };
2502	# doing reload synchronously and two reloads happen back-to-back,
2503	# coro crashes during coro_state_free->destroy here.
2504
2505	$RELOAD_WATCHER ||= Event->timer (
2506	reentrant => 0,
2507	after => 0,
2508	data => WF_AUTOCANCEL,
2509	cb => sub {
2510	reload;
2511	undef $RELOAD_WATCHER;
2512	},
2513	);
2514	}	2896	}
2515	};	2897	};
2516		2898
2517	unshift @INC, $LIBDIR;	2899	unshift @INC, $LIBDIR;
2518		2900
2519	my $bug_warning = 0;	2901	my $bug_warning = 0;
2520		2902
		2903	our @WAIT_FOR_TICK;
		2904	our @WAIT_FOR_TICK_BEGIN;
		2905
		2906	sub wait_for_tick {
		2907	return unless $TICK_WATCHER->is_active;
		2908	return if $Coro::current == $Coro::main;
		2909
		2910	my $signal = new Coro::Signal;
		2911	push @WAIT_FOR_TICK, $signal;
		2912	$signal->wait;
		2913	}
		2914
		2915	sub wait_for_tick_begin {
		2916	return unless $TICK_WATCHER->is_active;
		2917	return if $Coro::current == $Coro::main;
		2918
		2919	my $signal = new Coro::Signal;
		2920	push @WAIT_FOR_TICK_BEGIN, $signal;
		2921	$signal->wait;
		2922	}
		2923
		2924	my $min = 1e6;#d#
		2925	my $avg = 10;
2521	$TICK_WATCHER = Event->timer (	2926	$TICK_WATCHER = Event->timer (
2522	reentrant => 0,	2927	reentrant => 0,
2523	parked => 1,	2928	parked => 1,
2524	prio => 0,	2929	prio => 0,
2525	at => $NEXT_TICK || $TICK,	2930	at => $NEXT_TICK || $TICK,
…		…
2529	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	2934	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2530	unless ++$bug_warning > 10;	2935	unless ++$bug_warning > 10;
2531	return;	2936	return;
2532	}	2937	}
2533		2938
2534	$NOW = Event::time;	2939	$NOW = $tick_start = Event::time;
2535		2940
2536	cf::server_tick; # one server iteration	2941	cf::server_tick; # one server iteration
		2942
		2943	0 && sync_job {#d#
		2944	for(1..10) {
		2945	my $t = Event::time;
		2946	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2947	or die;
		2948
		2949	$map->width (50);
		2950	$map->height (50);
		2951	$map->alloc;
		2952	$map->_load_objects ("/tmp/x.map", 1);
		2953	my $t = Event::time - $t;
		2954
		2955	#next unless $t < 0.0013;#d#
		2956	if ($t < $min) {
		2957	$min = $t;
		2958	}
		2959	$avg = $avg * 0.99 + $t * 0.01;
		2960	}
		2961	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2962	exit 0;
		2963	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2964	};
		2965
2537	$RUNTIME += $TICK;	2966	$RUNTIME += $TICK;
2538	$NEXT_TICK += $TICK;	2967	$NEXT_TICK += $TICK;
2539		2968
2540	$WAIT_FOR_TICK->broadcast;	2969	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2541	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	2970	$NEXT_RUNTIME_WRITE = $NOW + 10;
2542		2971	Coro::async_pool {
2543	Event::sweep;	2972	write_runtime
2544	Coro::cede_notself;	2973	or warn "ERROR: unable to write runtime file: $!";
		2974	};
2545		2975	}
		2976
2546	# my $AFTER = Event::time;	2977	# my $AFTER = Event::time;
2547	# warn $AFTER - $NOW;#d#	2978	# warn $AFTER - $NOW;#d#
2548		2979
		2980	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2981	$sig->send;
		2982	}
		2983	while (my $sig = shift @WAIT_FOR_TICK) {
		2984	$sig->send;
		2985	}
		2986
		2987	$NOW = Event::time;
		2988
2549	# if we are delayed by four ticks or more, skip them all	2989	# if we are delayed by four ticks or more, skip them all
2550	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2990	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2551		2991
2552	$TICK_WATCHER->at ($NEXT_TICK);	2992	$TICK_WATCHER->at ($NEXT_TICK);
2553	$TICK_WATCHER->start;	2993	$TICK_WATCHER->start;
		2994
		2995	$LOAD = ($NOW - $tick_start) / $TICK;
		2996	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2997
		2998	_post_tick;
		2999
		3000
2554	},	3001	},
2555	);	3002	);
2556		3003
		3004	{
		3005	BDB::max_poll_time $TICK * 0.1;
		3006	$BDB_POLL_WATCHER = Event->io (
		3007	reentrant => 0,
		3008	fd => BDB::poll_fileno,
		3009	poll => 'r',
		3010	prio => 0,
		3011	data => WF_AUTOCANCEL,
		3012	cb => \&BDB::poll_cb,
		3013	);
		3014	BDB::min_parallel 8;
		3015
		3016	BDB::set_sync_prepare {
		3017	my $status;
		3018	my $current = $Coro::current;
		3019	(
		3020	sub {
		3021	$status = $!;
		3022	$current->ready; undef $current;
		3023	},
		3024	sub {
		3025	Coro::schedule while defined $current;
		3026	$! = $status;
		3027	},
		3028	)
		3029	};
		3030
		3031	unless ($DB_ENV) {
		3032	$DB_ENV = BDB::db_env_create;
		3033
		3034	cf::sync_job {
		3035	eval {
		3036	BDB::db_env_open
		3037	$DB_ENV,
		3038	$BDBDIR,
		3039	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3040	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3041	0666;
		3042
		3043	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3044
		3045	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3046	$DB_ENV->set_lk_detect;
		3047	};
		3048
		3049	cf::cleanup "db_env_open(db): $@" if $@;
		3050	};
		3051	}
		3052	}
		3053
		3054	{
		3055	IO::AIO::min_parallel 8;
		3056
		3057	undef $Coro::AIO::WATCHER;
2557	IO::AIO::max_poll_time $TICK * 0.1;	3058	IO::AIO::max_poll_time $TICK * 0.1;
2558
2559	undef $Coro::AIO::WATCHER;
2560	$AIO_POLL_WATCHER = Event->io (	3059	$AIO_POLL_WATCHER = Event->io (
2561	reentrant => 0,	3060	reentrant => 0,
		3061	data => WF_AUTOCANCEL,
2562	fd => IO::AIO::poll_fileno,	3062	fd => IO::AIO::poll_fileno,
2563	poll => 'r',	3063	poll => 'r',
2564	prio => 6,	3064	prio => 6,
2565	data => WF_AUTOCANCEL,
2566	cb => \&IO::AIO::poll_cb,	3065	cb => \&IO::AIO::poll_cb,
2567	);	3066	);
		3067	}
2568		3068
2569	$WRITE_RUNTIME_WATCHER = Event->timer (	3069	my $_log_backtrace;
2570	reentrant => 0,	3070
2571	data => WF_AUTOCANCEL,	3071	sub _log_backtrace {
2572	after => 1,	3072	my ($msg, @addr) = @_;
2573	interval => 10,	3073
2574	prio => 6, # keep it lowest so it acts like a watchdog	3074	$msg =~ s/\n//;
2575	cb => Coro::unblock_sub {	3075
2576	write_runtime	3076	# limit the # of concurrent backtraces
2577	or warn "ERROR: unable to write runtime file: $!";	3077	if ($_log_backtrace < 2) {
		3078	++$_log_backtrace;
		3079	async {
		3080	my @bt = fork_call {
		3081	@addr = map { sprintf "%x", $_ } @addr;
		3082	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3083	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3084	or die "addr2line: $!";
		3085
		3086	my @funcs;
		3087	my @res = <$fh>;
		3088	chomp for @res;
		3089	while (@res) {
		3090	my ($func, $line) = splice @res, 0, 2, ();
		3091	push @funcs, "[$func] $line";
		3092	}
		3093
		3094	@funcs
		3095	};
		3096
		3097	LOG llevInfo, "[ABT] $msg\n";
		3098	LOG llevInfo, "[ABT] $_\n" for @bt;
		3099	--$_log_backtrace;
		3100	};
		3101	} else {
		3102	LOG llevInfo, "[ABT] $msg\n";
		3103	LOG llevInfo, "[ABT] [suppressed]\n";
2578	},	3104	}
2579	);	3105	}
		3106
		3107	# load additional modules
		3108	use cf::pod;
2580		3109
2581	END { cf::emergency_save }	3110	END { cf::emergency_save }
2582		3111
2583	1	3112	1
2584		3113

Diff Legend

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