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.195 by root, Fri Jan 26 20:59:57 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 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;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
53		82
54	our %CFG;	83	our %CFG;
55		84
56	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	86	our $RUNTIME;
58		87
59	our %PLAYER; # all users	88	our %PLAYER; # all users
60	our %MAP; # all maps	89	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	90	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		91
67	# 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 ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		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
70	binmode STDOUT;	99	binmode STDOUT;
71	binmode STDERR;	100	binmode STDERR;
72		101
73	# read virtual server time, if available	102	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
78	}	107	}
79		108
80	mkdir cf::localdir;	109	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		111
86	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
		113
		114	sub cf::map::normalise;
87		115
88	#############################################################################	116	#############################################################################
89		117
90	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
91		119
…		…
98	=item $cf::RUNTIME	126	=item $cf::RUNTIME
99		127
100	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
101	every server tick.	129	every server tick.
102		130
103	=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
104		134
105	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
106	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.
107		139
108	=item $cf::NOW	140	=item $cf::NOW
109		141
110	The time of the last (current) server tick.	142	The time of the last (current) server tick.
111		143
112	=item $cf::TICK	144	=item $cf::TICK
113		145
114	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.
115		157
116	=item %cf::CFG	158	=item %cf::CFG
117		159
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	161	from wherever your confdir points to.
120		162
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		164
123	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
124	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
125	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.
126	window of cpu time available, or simply to synchronise to the server tick.
127		168
128	=back	169	=back
129		170
130	=cut	171	=cut
131		172
132	BEGIN {	173	BEGIN {
133	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	175	my $msg = join "", @_;
135	utf8::encode $msg;
136		176
137	$msg .= "\n"	177	$msg .= "\n"
138	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
139		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
140	LOG llevError, $msg;	183	LOG llevError, $msg;
141	};	184	};
142	}	185	}
143		186
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@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';
149	@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)
150		194
151	# 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
152	# within the Safe compartment.	196	# within the Safe compartment.
153	for my $pkg (qw(	197	for my $pkg (qw(
154	cf::global cf::attachable	198	cf::global cf::attachable
…		…
162	}	206	}
163		207
164	$Event::DIED = sub {	208	$Event::DIED = sub {
165	warn "error in event callback: @_";	209	warn "error in event callback: @_";
166	};	210	};
		211
		212	#############################################################################
167		213
168	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
169		215
170	=over 4	216	=over 4
171		217
…		…
190	$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;
191	$d	237	$d
192	} || "[unable to dump $_[0]: '$@']";	238	} || "[unable to dump $_[0]: '$@']";
193	}	239	}
194		240
195	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
196		242
197	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
198		244
199	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
200		246
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
209		248
210	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
211
212	=cut
213
214	sub to_json($) {
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
216	JSON::Syck::Dump $_[0]
217	}
218		250
219	=item cf::lock_wait $string	251	=item cf::lock_wait $string
220		252
221	Wait until the given lock is available. See cf::lock_acquire.	253	Wait until the given lock is available. See cf::lock_acquire.
222		254
…		…
228	returned.	260	returned.
229		261
230	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
231	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
232		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
233	=cut	269	=cut
234		270
235	our %LOCK;	271	our %LOCK;
236		272
237	sub lock_wait($) {	273	sub lock_wait($) {
…		…
256	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
258	}	294	}
259	}	295	}
260		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
261	sub freeze_mainloop {	303	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
263		305
264	my $guard = Coro::guard {	306	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	307	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	308	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	309	$TICK_WATCHER->stop;
270	$guard	310	$guard
271	}	311	}
272		312
273	=item cf::async { BLOCK }	313	=item cf::async { BLOCK }
…		…
280		320
281	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
282		322
283	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
284		324
285	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)
286	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
287	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.
288		329
289	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
290	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
291	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
292	fast or be very important.	333	fast or be very important.
…		…
295		336
296	sub sync_job(&) {	337	sub sync_job(&) {
297	my ($job) = @_;	338	my ($job) = @_;
298		339
299	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
300	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
302		345
303	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
315		358
316	while ($busy) {	359	while ($busy) {
317	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
318	}	361	}
319		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
320	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
321	} else {	371	} else {
322	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
323		373
324	$job->()	374	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
344		394
345	$coro	395	$coro
346	}	396	}
347		397
348	sub write_runtime {	398	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		399
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	400	Executes the given code block with the given arguments in a seperate
352	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.
353		404
354	my $value = $cf::RUNTIME + 90 + 10;	405	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		406
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	407	sub fork_call(&@) {
359	and return;	408	my ($cb, @args) = @_;
360		409
361	aio_fsync $fh	410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
362	and return;	411	# or die "socketpair: $!";
		412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
363		414
		415	if (my $pid = fork) {
364	close $fh	416	close $fh2;
365	or return;
366		417
367	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
368	and return;	419	$res = Coro::Storable::thaw $res;
369		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;
370	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 });
371	}	567	}
372		568
373	=back	569	=back
374		570
375	=cut	571	=cut
…		…
382	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")
383	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
384		580
385	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>
386	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
387	crossfire+).	583	Crossfire TRT).
388		584
389	=over 4	585	=over 4
390		586
391	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
392		588
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
556		752
557	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		757
562	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	759	my $pkg = shift @arg;
564		760
565	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
595	}	791	}
596		792
597	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
598	} else {	794	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	796	}
601		797
602	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
603	}	799	}
604		800
…		…
606	if (ref $_[0]) {	802	if (ref $_[0]) {
607	_object_attach @_;	803	_object_attach @_;
608	} else {	804	} else {
609	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
610	}	806	}
		807	_recalc_want;
611	};	808	};
612		809
613	# all those should be optimised	810	# all those should be optimised
614	sub cf::attachable::detach {	811	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
619	reattach ($obj);	816	reattach ($obj);
620	} else {	817	} else {
621	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
622	}	819	}
		820	_recalc_want;
623	};	821	};
624		822
625	sub cf::attachable::attached {	823	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
627		825
…		…
750	$filename, length $$rdata, scalar @$objs;	948	$filename, length $$rdata, scalar @$objs;
751		949
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	950	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	951	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	952	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	953	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	954	close $fh;
757		955
758	if (@$objs) {	956	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	957	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	959	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	960	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	961	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	962	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	963	aio_rename "$filename.pst~", "$filename.pst";
766	}	964	}
767	} else {	965	} else {
768	aio_unlink "$filename.pst";	966	aio_unlink "$filename.pst";
…		…
800	or return;	998	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1000	}
803		1001
804	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1004	return ($data, $av);
807	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
808		1012
809	#############################################################################	1013	#############################################################################
810	# command handling &c	1014	# command handling &c
811		1015
812	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1030	}
827		1031
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1033
830	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.
831		1035
832	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
833	called.	1037	called.
834		1038
835	=cut	1039	=cut
…		…
870		1074
871	cf::override;	1075	cf::override;
872	},	1076	},
873	);	1077	);
874		1078
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
910	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1084	next unless -r $path;
912	eval {	1085
913	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;
914	1	1143	}
915	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
916	}	1149	};
917	}	1150	}
918		1151
919	#############################################################################	1152	#############################################################################
920		1153
		1154	=back
		1155
921	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
922		1157
923	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
924		1159
925	=cut	1160	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
938		1173
939	=cut	1174	=cut
940		1175
941	sub playerdir($) {	1176	sub playerdir($) {
942	cf::localdir	1177	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1179	}
948		1180
949	sub path($) {	1181	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1183
952	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
953	}	1185	}
954		1186
955	sub find_active($) {	1187	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1202	my $login = $_[0];
971		1203
972	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
973		1205
974	$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
975	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
976	or return;	1215	or return;
977	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
978	}	1217	}
979	}	1218	}
…		…
1016		1255
1017	=cut	1256	=cut
1018		1257
1019	sub quit_character {	1258	sub quit_character {
1020	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1021		1262
1022	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1023	$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
1024		1265
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1297	}
1037		1298
1038	=item cf::player::list_logins	1299	=item cf::player::list_logins
1039		1300
1040	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
1041	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1042		1303
1043	=cut	1304	=cut
1044		1305
1045	sub list_logins {	1306	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1308	or return [];
1048		1309
1049	my @logins;	1310	my @logins;
1050		1311
1051	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1068	=cut	1329	=cut
1069		1330
1070	sub maps($) {	1331	sub maps($) {
1071	my ($pl) = @_;	1332	my ($pl) = @_;
1072		1333
		1334	$pl = ref $pl ? $pl->ob->name : $pl;
		1335
1073	my $files = aio_readdir playerdir $pl	1336	my $files = aio_readdir playerdir $pl
1074	or return;	1337	or return;
1075		1338
1076	my @paths;	1339	my @paths;
1077		1340
1078	for (@$files) {	1341	for (@$files) {
1079	utf8::decode $_;	1342	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1343	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1344	next unless /^$PATH_SEP/o;
1082		1345
1083	s/\.map$//;	1346	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1347	}
1086		1348
1087	\@paths	1349	\@paths
1088	}	1350	}
1089		1351
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1352	=item $player->ext_reply ($msgid, %msg)
1091		1353
1092	Sends an ext reply to the player.	1354	Sends an ext reply to the player.
1093		1355
1094	=cut	1356	=cut
1095		1357
1096	sub ext_reply($$$%) {	1358	sub ext_reply($$%) {
1097	my ($self, $id, %msg) = @_;	1359	my ($self, $id, %msg) = @_;
1098		1360
1099	$msg{msgid} = $id;	1361	$msg{msgid} = $id;
1100		1362
1101	$self->send ("ext " . cf::to_json \%msg);	1363	$self->send ("ext " . cf::to_json \%msg);
1102	}	1364	}
1103		1365
1104	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	}
1105		1406
1106	=back	1407	=back
1107
1108		1408
1109	=head3 cf::map	1409	=head3 cf::map
1110		1410
1111	=over 4	1411	=over 4
1112		1412
…		…
1167	my ($self, $merge) = @_;	1467	my ($self, $merge) = @_;
1168		1468
1169	# we have to keep some variables in memory intact	1469	# we have to keep some variables in memory intact
1170	local $self->{path};	1470	local $self->{path};
1171	local $self->{load_path};	1471	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1472
1175	$self->SUPER::thawer_merge ($merge);	1473	$self->SUPER::thawer_merge ($merge);
1176	}	1474	}
1177		1475
1178	sub normalise {	1476	sub normalise {
1179	my ($path, $base) = @_;	1477	my ($path, $base) = @_;
1180		1478
1181	$path = "$path"; # make sure its a string	1479	$path = "$path"; # make sure its a string
		1480
		1481	$path =~ s/\.map$//;
1182		1482
1183	# map plan:	1483	# map plan:
1184	#	1484	#
1185	# /! non-realised random map exit (special hack!)	1485	# /! non-realised random map exit (special hack!)
1186	# {... are special paths that are not being touched	1486	# {... are special paths that are not being touched
…		…
1248		1548
1249	# the original (read-only) location	1549	# the original (read-only) location
1250	sub load_path {	1550	sub load_path {
1251	my ($self) = @_;	1551	my ($self) = @_;
1252		1552
1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1553	"$MAPDIR/$self->{path}.map"
1254	}	1554	}
1255		1555
1256	# the temporary/swap location	1556	# the temporary/swap location
1257	sub save_path {	1557	sub save_path {
1258	my ($self) = @_;	1558	my ($self) = @_;
1259		1559
1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1560	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1561	"$TMPDIR/$path.map"
1262	}	1562	}
1263		1563
1264	# the unique path, undef == no special unique path	1564	# the unique path, undef == no special unique path
1265	sub uniq_path {	1565	sub uniq_path {
1266	my ($self) = @_;	1566	my ($self) = @_;
1267		1567
1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1568	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1569	"$UNIQUEDIR/$path"
1270	}	1570	}
1271		1571
1272	# and all this just because we cannot iterate over	1572	# and all this just because we cannot iterate over
1273	# all maps in C++...	1573	# all maps in C++...
1274	sub change_all_map_light {	1574	sub change_all_map_light {
…		…
1276		1576
1277	$_->change_map_light ($change)	1577	$_->change_map_light ($change)
1278	for grep $_->outdoor, values %cf::MAP;	1578	for grep $_->outdoor, values %cf::MAP;
1279	}	1579	}
1280		1580
		1581	sub decay_objects {
		1582	my ($self) = @_;
		1583
		1584	return if $self->{deny_reset};
		1585
		1586	$self->do_decay_objects;
		1587	}
		1588
1281	sub unlink_save {	1589	sub unlink_save {
1282	my ($self) = @_;	1590	my ($self) = @_;
1283		1591
1284	utf8::encode (my $save = $self->save_path);	1592	utf8::encode (my $save = $self->save_path);
1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1593	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1288		1596
1289	sub load_header_from($) {	1597	sub load_header_from($) {
1290	my ($self, $path) = @_;	1598	my ($self, $path) = @_;
1291		1599
1292	utf8::encode $path;	1600	utf8::encode $path;
1293	aio_open $path, O_RDONLY, 0	1601	#aio_open $path, O_RDONLY, 0
1294	or return;	1602	# or return;
1295		1603
1296	$self->_load_header ($path)	1604	$self->_load_header ($path)
1297	or return;	1605	or return;
1298		1606
1299	$self->{load_path} = $path;	1607	$self->{load_path} = $path;
…		…
1341	$self->load_header_orig	1649	$self->load_header_orig
1342	or return;	1650	or return;
1343	$self->prepare_orig;	1651	$self->prepare_orig;
1344	}	1652	}
1345		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
1346	1	1660	1
1347	}	1661	}
1348		1662
1349	sub find;	1663	sub find;
1350	sub find {	1664	sub find {
…		…
1362	$map->{last_save} = $cf::RUNTIME;	1676	$map->{last_save} = $cf::RUNTIME;
1363		1677
1364	$map->load_header	1678	$map->load_header
1365	or return;	1679	or return;
1366		1680
1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1681	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368	# doing this can freeze the server in a sync job, obviously	1682	# doing this can freeze the server in a sync job, obviously
1369	#$cf::WAIT_FOR_TICK->wait;	1683	#$cf::WAIT_FOR_TICK->wait;
1370	$map->reset;	1684	$map->reset;
1371	undef $guard;	1685	undef $guard;
1372	return find $path;	1686	return find $path;
…		…
1380	sub post_load { }	1694	sub post_load { }
1381		1695
1382	sub load {	1696	sub load {
1383	my ($self) = @_;	1697	my ($self) = @_;
1384		1698
		1699	local $self->{deny_reset} = 1; # loading can take a long time
		1700
1385	my $path = $self->{path};	1701	my $path = $self->{path};
		1702
		1703	{
1386	my $guard = cf::lock_acquire "map_load:$path";	1704	my $guard = cf::lock_acquire "map_load:$path";
1387		1705
1388	return if $self->in_memory != cf::MAP_SWAPPED;	1706	return if $self->in_memory != cf::MAP_SWAPPED;
1389		1707
1390	$self->in_memory (cf::MAP_LOADING);	1708	$self->in_memory (cf::MAP_LOADING);
1391		1709
1392	$self->alloc;	1710	$self->alloc;
1393		1711
1394	$self->pre_load;	1712	$self->pre_load;
1395
1396	$self->_load_objects ($self->{load_path}, 1)
1397	or return;
1398
1399	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1400	if delete $self->{load_original};
1401
1402	if (my $uniq = $self->uniq_path) {
1403	utf8::encode $uniq;
1404	if (aio_open $uniq, O_RDONLY, 0) {
1405	$self->clear_unique_items;
1406	$self->_load_objects ($uniq, 0);
1407	}
1408	}
1409
1410	Coro::cede;
1411
1412	# now do the right thing for maps
1413	$self->link_multipart_objects;
1414
1415	unless ($self->{deny_activate}) {
1416	$self->decay_objects;
1417	$self->fix_auto_apply;
1418	$self->update_buttons;
1419	Coro::cede;	1713	Coro::cede;
1420	$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;
1421	$self->difficulty ($self->estimate_difficulty)	1732	$self->difficulty ($self->estimate_difficulty)
1422	unless $self->difficulty;	1733	unless $self->difficulty;
1423	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;
1424	$self->activate;	1743	$self->activate;
		1744	}
		1745
		1746	$self->in_memory (cf::MAP_IN_MEMORY);
1425	}	1747	}
1426		1748
1427	$self->post_load;	1749	$self->post_load;
1428
1429	$self->in_memory (cf::MAP_IN_MEMORY);
1430	}	1750	}
1431		1751
1432	sub customise_for {	1752	sub customise_for {
1433	my ($self, $ob) = @_;	1753	my ($self, $ob) = @_;
1434		1754
1435	return find "~" . $ob->name . "/" . $self->{path}	1755	return find "~" . $ob->name . "/" . $self->{path}
1436	if $self->per_player;	1756	if $self->per_player;
		1757
		1758	# return find "?party/" . $ob->name . "/" . $self->{path}
		1759	# if $self->per_party;
1437		1760
1438	$self	1761	$self
1439	}	1762	}
1440		1763
1441	# 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
…		…
1552		1875
1553	sub reset_at {	1876	sub reset_at {
1554	my ($self) = @_;	1877	my ($self) = @_;
1555		1878
1556	# TODO: safety, remove and allow resettable per-player maps	1879	# TODO: safety, remove and allow resettable per-player maps
1557	return 1e99 if $self->isa ("ext::map_per_player");#d#
1558	return 1e99 if $self->{deny_reset};	1880	return 1e99 if $self->{deny_reset};
1559		1881
1560	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1882	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561	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;
1562		1884
…		…
1573	my ($self) = @_;	1895	my ($self) = @_;
1574		1896
1575	my $lock = cf::lock_acquire "map_data:$self->{path}";	1897	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		1898
1577	return if $self->players;	1899	return if $self->players;
1578	return if $self->isa ("ext::map_per_player");#d#
1579		1900
1580	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	}
1581		1912
1582	delete $cf::MAP{$self->path};	1913	delete $cf::MAP{$self->path};
1583		1914
1584	$self->in_memory (cf::MAP_SWAPPED);
1585	$self->clear;	1915	$self->clear;
1586		1916
1587	$_->clear_links_to ($self) for values %cf::MAP;	1917	$_->clear_links_to ($self) for values %cf::MAP;
1588		1918
1589	$self->unlink_save;	1919	$self->unlink_save;
…		…
1608	$cf::MAP{$self->path} = $self;	1938	$cf::MAP{$self->path} = $self;
1609		1939
1610	$self->reset; # polite request, might not happen	1940	$self->reset; # polite request, might not happen
1611	}	1941	}
1612		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
1613	=item cf::map::unique_maps	1979	=item cf::map::unique_maps
1614		1980
1615	Returns an arrayref of paths of all shared maps that have	1981	Returns an arrayref of paths of all shared maps that have
1616	instantiated unique items. May block.	1982	instantiated unique items. May block.
1617		1983
1618	=cut	1984	=cut
1619		1985
1620	sub unique_maps() {	1986	sub unique_maps() {
1621	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	1987	[
1622	or return;	1988	map {
1623
1624	my @paths;
1625
1626	for (@$files) {
1627	utf8::decode $_;	1989	utf8::decode $_;
1628	next if /\.pst$/;
1629	next unless /^$PATH_SEP/o;
1630
1631	s/\.map$//;	1990	/\.map$/
1632	push @paths, $_;	1991	? normalise $_
		1992	: ()
		1993	} @{ aio_readdir $UNIQUEDIR or [] }
1633	}	1994	]
1634
1635	\@paths
1636	}	1995	}
1637		1996
1638	package cf;	1997	package cf;
1639		1998
1640	=back	1999	=back
…		…
1731	=cut	2090	=cut
1732		2091
1733	sub link_map {	2092	sub link_map {
1734	unless ($LINK_MAP) {	2093	unless ($LINK_MAP) {
1735	$LINK_MAP = cf::map::find "{link}"	2094	$LINK_MAP = cf::map::find "{link}"
1736	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2095	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1737	$LINK_MAP->load;	2096	$LINK_MAP->load;
1738	}	2097	}
1739		2098
1740	$LINK_MAP	2099	$LINK_MAP
1741	}	2100	}
…		…
1746	$self->deactivate_recursive;	2105	$self->deactivate_recursive;
1747		2106
1748	return if UNIVERSAL::isa $self->map, "ext::map_link";	2107	return if UNIVERSAL::isa $self->map, "ext::map_link";
1749		2108
1750	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2109	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751	if $self->map;	2110	if $self->map && $self->map->{path} ne "{link}";
1752		2111
1753	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2112	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1754	}	2113	}
1755		2114
1756	sub cf::object::player::leave_link {	2115	sub cf::object::player::leave_link {
1757	my ($self, $map, $x, $y) = @_;	2116	my ($self, $map, $x, $y) = @_;
		2117
		2118	return unless $self->contr->active;
1758		2119
1759	my $link_pos = delete $self->{_link_pos};	2120	my $link_pos = delete $self->{_link_pos};
1760		2121
1761	unless ($map) {	2122	unless ($map) {
1762	# restore original map position	2123	# restore original map position
…		…
1780	$map->load;	2141	$map->load;
1781	$map->load_diag;	2142	$map->load_diag;
1782		2143
1783	return unless $self->contr->active;	2144	return unless $self->contr->active;
1784	$self->activate_recursive;	2145	$self->activate_recursive;
		2146
		2147	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1785	$self->enter_map ($map, $x, $y);	2148	$self->enter_map ($map, $x, $y);
1786	}	2149	}
1787		2150
1788	cf::player->attach (
1789	on_logout => sub {
1790	my ($pl) = @_;
1791
1792	# abort map switching before logout
1793	if ($pl->ob->{_link_pos}) {
1794	cf::sync_job {
1795	$pl->ob->leave_link
1796	};
1797	}
1798	},
1799	on_login => sub {
1800	my ($pl) = @_;
1801
1802	# try to abort aborted map switching on player login :)
1803	# should happen only on crashes
1804	if ($pl->ob->{_link_pos}) {
1805	$pl->ob->enter_link;
1806	(async {
1807	# we need this sleep as the login has a concurrent enter_exit running
1808	# and this sleep increases chances of the player not ending up in scorn
1809	$pl->ob->reply (undef,
1810	"There was an internal problem at your last logout, "
1811	. "the server will try to bring you to your intended destination in a second.",
1812	cf::NDI_RED);
1813	Coro::Timer::sleep 1;
1814	$pl->ob->leave_link;
1815	})->prio (2);
1816	}
1817	},
1818	);
1819
1820	=item $player_object->goto ($path, $x, $y)	2151	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1821		2152
		2153	Moves the player to the given map-path and coordinates by first freezing
		2154	her, loading and preparing them map, calling the provided $check callback
		2155	that has to return the map if sucecssful, and then unfreezes the player on
		2156	the new (success) or old (failed) map position.
		2157
1822	=cut	2158	=cut
		2159
		2160	our $GOTOGEN;
1823		2161
1824	sub cf::object::player::goto {	2162	sub cf::object::player::goto {
1825	my ($self, $path, $x, $y) = @_;	2163	my ($self, $path, $x, $y, $check) = @_;
		2164
		2165	# do generation counting so two concurrent goto's will be executed in-order
		2166	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1826		2167
1827	$self->enter_link;	2168	$self->enter_link;
1828		2169
1829	(async {	2170	(async {
		2171	my $map = eval {
1830	my $map = cf::map::find $path;	2172	my $map = cf::map::find $path;
		2173
		2174	if ($map) {
1831	$map = $map->customise_for ($self) if $map;	2175	$map = $map->customise_for ($self);
1832		2176	$map = $check->($map) if $check && $map;
1833	# warn "entering ", $map->path, " at ($x, $y)\n"	2177	} else {
1834	# if $map;
1835
1836	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2178	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2179	}
1837		2180
		2181	$map
		2182	};
		2183
		2184	if ($@) {
		2185	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2186	LOG llevError | logBacktrace, Carp::longmess $@;
		2187	}
		2188
		2189	if ($gen == $self->{_goto_generation}) {
		2190	delete $self->{_goto_generation};
1838	$self->leave_link ($map, $x, $y);	2191	$self->leave_link ($map, $x, $y);
		2192	}
1839	})->prio (1);	2193	})->prio (1);
1840	}	2194	}
1841		2195
1842	=item $player_object->enter_exit ($exit_object)	2196	=item $player_object->enter_exit ($exit_object)
1843		2197
…		…
1872	# that depends on the exit object	2226	# that depends on the exit object
1873		2227
1874	my $rmp = parse_random_map_params $exit->msg;	2228	my $rmp = parse_random_map_params $exit->msg;
1875		2229
1876	if ($exit->map) {	2230	if ($exit->map) {
1877	$rmp->{region} = $exit->map->region_name;	2231	$rmp->{region} = $exit->region->name;
1878	$rmp->{origin_map} = $exit->map->path;	2232	$rmp->{origin_map} = $exit->map->path;
1879	$rmp->{origin_x} = $exit->x;	2233	$rmp->{origin_x} = $exit->x;
1880	$rmp->{origin_y} = $exit->y;	2234	$rmp->{origin_y} = $exit->y;
1881	}	2235	}
1882		2236
1883	$rmp->{random_seed} ||= $exit->random_seed;	2237	$rmp->{random_seed} ||= $exit->random_seed;
1884		2238
1885	my $data = cf::to_json $rmp;	2239	my $data = cf::to_json $rmp;
1886	my $md5 = Digest::MD5::md5_hex $data;	2240	my $md5 = Digest::MD5::md5_hex $data;
1887	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2241	my $meta = "$RANDOMDIR/$md5.meta";
1888		2242
1889	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2243	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890	aio_write $fh, 0, (length $data), $data, 0;	2244	aio_write $fh, 0, (length $data), $data, 0;
1891	undef $fh;	2245	undef $fh;
1892	aio_rename "$meta~", $meta;	2246	aio_rename "$meta~", $meta;
…		…
1901		2255
1902	return unless $self->type == cf::PLAYER;	2256	return unless $self->type == cf::PLAYER;
1903		2257
1904	if ($exit->slaying eq "/!") {	2258	if ($exit->slaying eq "/!") {
1905	#TODO: this should de-fi-ni-te-ly not be a sync-job	2259	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2260	# the problem is that $exit might not survive long enough
		2261	# so it needs to be done right now, right here
1906	cf::sync_job { prepare_random_map $exit };	2262	cf::sync_job { prepare_random_map $exit };
1907	}	2263	}
1908		2264
1909	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2265	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1910	my $hp = $exit->stats->hp;	2266	my $hp = $exit->stats->hp;
…		…
1918	$self->goto ($slaying, $hp, $sp);	2274	$self->goto ($slaying, $hp, $sp);
1919		2275
1920	1;	2276	1;
1921	}) {	2277	}) {
1922	$self->message ("Something went wrong deep within the crossfire server. "	2278	$self->message ("Something went wrong deep within the crossfire server. "
1923	. "I'll try to bring you back to the map you were before. "	2279	. "I'll try to bring you back to the map you were before. "
1924	. "Please report this to the dungeon master!",	2280	. "Please report this to the dungeon master!",
1925	cf::NDI_UNIQUE | cf::NDI_RED);	2281	cf::NDI_UNIQUE | cf::NDI_RED);
1926		2282
1927	warn "ERROR in enter_exit: $@";	2283	warn "ERROR in enter_exit: $@";
1928	$self->leave_link;	2284	$self->leave_link;
1929	}	2285	}
1930	})->prio (1);	2286	})->prio (1);
…		…
1943		2299
1944	sub cf::client::send_drawinfo {	2300	sub cf::client::send_drawinfo {
1945	my ($self, $text, $flags) = @_;	2301	my ($self, $text, $flags) = @_;
1946		2302
1947	utf8::encode $text;	2303	utf8::encode $text;
1948	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2304	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1949	}	2305	}
1950		2306
		2307	=item $client->ext_event ($type, %msg)
		2308
		2309	Sends an exti event to the client.
		2310
		2311	=cut
		2312
		2313	sub cf::client::ext_event($$%) {
		2314	my ($self, $type, %msg) = @_;
		2315
		2316	$msg{msgtype} = "event_$type";
		2317	$self->send_packet ("ext " . cf::to_json \%msg);
		2318	}
1951		2319
1952	=item $success = $client->query ($flags, "text", \&cb)	2320	=item $success = $client->query ($flags, "text", \&cb)
1953		2321
1954	Queues a query to the client, calling the given callback with	2322	Queues a query to the client, calling the given callback with
1955	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2323	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1984	# get handled first	2352	# get handled first
1985	my $queue = delete $ns->{query_queue}	2353	my $queue = delete $ns->{query_queue}
1986	or return; # be conservative, not sure how that can happen, but we saw a crash here	2354	or return; # be conservative, not sure how that can happen, but we saw a crash here
1987		2355
1988	(shift @$queue)->[1]->($msg);	2356	(shift @$queue)->[1]->($msg);
		2357	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1989		2358
1990	push @{ $ns->{query_queue} }, @$queue;	2359	push @{ $ns->{query_queue} }, @$queue;
1991		2360
1992	if (@{ $ns->{query_queue} } == @$queue) {	2361	if (@{ $ns->{query_queue} } == @$queue) {
1993	if (@$queue) {	2362	if (@$queue) {
…		…
2051		2420
2052	# here we export the classes and methods available to script code	2421	# here we export the classes and methods available to script code
2053		2422
2054	=pod	2423	=pod
2055		2424
2056	The following fucntions and emthods are available within a safe environment:	2425	The following functions and methods are available within a safe environment:
2057		2426
2058	cf::object contr pay_amount pay_player map	2427	cf::object contr pay_amount pay_player map
2059	cf::object::player player	2428	cf::object::player player
2060	cf::player peaceful	2429	cf::player peaceful
2061	cf::map trigger	2430	cf::map trigger
…		…
2142	=back	2511	=back
2143		2512
2144	=cut	2513	=cut
2145		2514
2146	#############################################################################	2515	#############################################################################
		2516	# the server's init and main functions
2147		2517
2148	=head2 EXTENSION DATABASE SUPPORT	2518	sub load_facedata($) {
		2519	my ($path) = @_;
2149		2520
2150	Crossfire maintains a very simple database for extension use. It can	2521	warn "loading facedata from $path\n";
2151	currently store anything that can be serialised using Storable, which
2152	excludes objects.
2153		2522
2154	The parameter C<$family> should best start with the name of the extension	2523	my $facedata;
2155	using it, it should be unique.	2524	0 < aio_load $path, $facedata
		2525	or die "$path: $!";
2156		2526
2157	=over 4	2527	$facedata = Coro::Storable::thaw $facedata;
2158		2528
2159	=item $hashref = cf::db_get $family	2529	$facedata->{version} == 2
		2530	or cf::cleanup "$path: version mismatch, cannot proceed.";
2160		2531
2161	Return a hashref for use by the extension C<$family>, which can be
2162	modified. After modifications, you have to call C<cf::db_dirty> or
2163	C<cf::db_sync>.
2164
2165	=item $value = cf::db_get $family => $key
2166
2167	Returns a single value from the database
2168
2169	=item cf::db_put $family => $hashref
2170
2171	Stores the given family hashref into the database. Updates are delayed, if
2172	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2173
2174	=item cf::db_put $family => $key => $value
2175
2176	Stores the given C<$value> in the family hash. Updates are delayed, if you
2177	want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179	=item cf::db_dirty
2180
2181	Marks the database as dirty, to be updated at a later time.
2182
2183	=item cf::db_sync
2184
2185	Immediately write the database to disk I<if it is dirty>.
2186
2187	=cut
2188
2189	our $DB;
2190
2191	{
2192	my $path = cf::localdir . "/database.pst";
2193
2194	sub db_load() {
2195	$DB = stat $path ? Storable::retrieve $path : { };
2196	}	2532	{
		2533	my $faces = $facedata->{faceinfo};
2197		2534
2198	my $pid;	2535	while (my ($face, $info) = each %$faces) {
2199		2536	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2200	sub db_save() {	2537	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2201	waitpid $pid, 0 if $pid;	2538	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2202	if (0 == ($pid = fork)) {	2539	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2203	$DB->{_meta}{version} = 1;	2540	Coro::cede;
2204	Storable::nstore $DB, "$path~";
2205	rename "$path~", $path;
2206	cf::_exit 0 if defined $pid;
2207	}
2208	}
2209
2210	my $dirty;
2211
2212	sub db_sync() {
2213	db_save if $dirty;
2214	undef $dirty;
2215	}
2216
2217	my $idle = Event->idle (
2218	reentrant => 0,
2219	min => 10,
2220	max => 20,
2221	repeat => 0,
2222	data => WF_AUTOCANCEL,
2223	cb => \&db_sync,
2224	);
2225
2226	sub db_dirty() {
2227	$dirty = 1;
2228	$idle->start;
2229	}
2230
2231	sub db_get($;$) {
2232	@_ >= 2
2233	? $DB->{$_[0]}{$_[1]}
2234	: ($DB->{$_[0]} ||= { })
2235	}
2236
2237	sub db_put($$;$) {
2238	if (@_ >= 3) {
2239	$DB->{$_[0]}{$_[1]} = $_[2];
2240	} else {
2241	$DB->{$_[0]} = $_[1];
2242	}
2243	db_dirty;
2244	}
2245
2246	cf::global->attach (
2247	prio => 10000,
2248	on_cleanup => sub {
2249	db_sync;
2250	},	2541	}
2251	);
2252	}
2253		2542
2254	#############################################################################	2543	while (my ($face, $info) = each %$faces) {
2255	# the server's main()	2544	next unless $info->{smooth};
		2545	my $idx = cf::face::find $face
		2546	or next;
		2547	if (my $smooth = cf::face::find $info->{smooth}) {
		2548	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2549	} else {
		2550	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2551	}
		2552	Coro::cede;
		2553	}
		2554	}
		2555
		2556	{
		2557	my $anims = $facedata->{animinfo};
		2558
		2559	while (my ($anim, $info) = each %$anims) {
		2560	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2561	Coro::cede;
		2562	}
		2563
		2564	cf::anim::invalidate_all; # d'oh
		2565	}
		2566
		2567	1
		2568	}
		2569
		2570	sub reload_regions {
		2571	load_resource_file "$MAPDIR/regions"
		2572	or die "unable to load regions file\n";
		2573	}
		2574
		2575	sub reload_facedata {
		2576	load_facedata "$DATADIR/facedata"
		2577	or die "unable to load facedata\n";
		2578	}
		2579
		2580	sub reload_archetypes {
		2581	load_resource_file "$DATADIR/archetypes"
		2582	or die "unable to load archetypes\n";
		2583	}
		2584
		2585	sub reload_treasures {
		2586	load_resource_file "$DATADIR/treasures"
		2587	or die "unable to load treasurelists\n";
		2588	}
		2589
		2590	sub reload_resources {
		2591	warn "reloading resource files...\n";
		2592
		2593	reload_regions;
		2594	reload_facedata;
		2595	#reload_archetypes;#d#
		2596	reload_archetypes;
		2597	reload_treasures;
		2598
		2599	warn "finished reloading resource files\n";
		2600	}
		2601
		2602	sub init {
		2603	reload_resources;
		2604	}
2256		2605
2257	sub cfg_load {	2606	sub cfg_load {
2258	open my $fh, "<:utf8", cf::confdir . "/config"	2607	open my $fh, "<:utf8", "$CONFDIR/config"
2259	or return;	2608	or return;
2260		2609
2261	local $/;	2610	local $/;
2262	*CFG = YAML::Syck::Load <$fh>;	2611	*CFG = YAML::Syck::Load <$fh>;
2263		2612
…		…
2283	Event::one_event;	2632	Event::one_event;
2284	})->prio (Coro::PRIO_MAX);	2633	})->prio (Coro::PRIO_MAX);
2285	};	2634	};
2286		2635
2287	cfg_load;	2636	cfg_load;
2288	db_load;	2637	db_init;
2289	load_extensions;	2638	load_extensions;
2290		2639
2291	$TICK_WATCHER->start;	2640	$TICK_WATCHER->start;
2292	Event::loop;	2641	Event::loop;
2293	}	2642	}
…		…
2308	},	2657	},
2309	);	2658	);
2310	}	2659	}
2311	}	2660	}
2312		2661
		2662	sub write_runtime {
		2663	my $runtime = "$LOCALDIR/runtime";
		2664
		2665	# first touch the runtime file to show we are still running:
		2666	# the fsync below can take a very very long time.
		2667
		2668	IO::AIO::aio_utime $runtime, undef, undef;
		2669
		2670	my $guard = cf::lock_acquire "write_runtime";
		2671
		2672	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2673	or return;
		2674
		2675	my $value = $cf::RUNTIME + 90 + 10;
		2676	# 10 is the runtime save interval, for a monotonic clock
		2677	# 60 allows for the watchdog to kill the server.
		2678
		2679	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2680	and return;
		2681
		2682	# always fsync - this file is important
		2683	aio_fsync $fh
		2684	and return;
		2685
		2686	# touch it again to show we are up-to-date
		2687	aio_utime $fh, undef, undef;
		2688
		2689	close $fh
		2690	or return;
		2691
		2692	aio_rename "$runtime~", $runtime
		2693	and return;
		2694
		2695	warn "runtime file written.\n";
		2696
		2697	1
		2698	}
		2699
2313	sub emergency_save() {	2700	sub emergency_save() {
2314	my $freeze_guard = cf::freeze_mainloop;	2701	my $freeze_guard = cf::freeze_mainloop;
2315		2702
2316	warn "enter emergency perl save\n";	2703	warn "enter emergency perl save\n";
2317		2704
…		…
2332	my $map = $cf::MAP{$path} or next;	2719	my $map = $cf::MAP{$path} or next;
2333	$map->valid or next;	2720	$map->valid or next;
2334	$map->save;	2721	$map->save;
2335	}	2722	}
2336	warn "end emergency map save\n";	2723	warn "end emergency map save\n";
		2724
		2725	warn "begin emergency database checkpoint\n";
		2726	BDB::db_env_txn_checkpoint $DB_ENV;
		2727	warn "end emergency database checkpoint\n";
2337	};	2728	};
2338		2729
2339	warn "leave emergency perl save\n";	2730	warn "leave emergency perl save\n";
2340	}	2731	}
2341		2732
		2733	sub post_cleanup {
		2734	my ($make_core) = @_;
		2735
		2736	warn Carp::longmess "post_cleanup backtrace"
		2737	if $make_core;
		2738	}
		2739
2342	sub reload() {	2740	sub do_reload_perl() {
2343	# can/must only be called in main	2741	# can/must only be called in main
2344	if ($Coro::current != $Coro::main) {	2742	if ($Coro::current != $Coro::main) {
2345	warn "can only reload from main coroutine";	2743	warn "can only reload from main coroutine";
2346	return;	2744	return;
2347	}	2745	}
2348		2746
2349	warn "reloading...";	2747	warn "reloading...";
2350		2748
2351	warn "cancelling server ticker";	2749	warn "entering sync_job";
2352	$TICK_WATCHER->cancel;
2353		2750
		2751	cf::sync_job {
		2752	cf::write_runtime; # external watchdog should not bark
2354	cf::emergency_save;	2753	cf::emergency_save;
		2754	cf::write_runtime; # external watchdog should not bark
2355		2755
2356	eval {	2756	warn "syncing database to disk";
		2757	BDB::db_env_txn_checkpoint $DB_ENV;
		2758
2357	# if anything goes wrong in here, we should simply crash as we already saved	2759	# if anything goes wrong in here, we should simply crash as we already saved
2358
2359	warn "syncing database to disk";
2360	cf::db_sync;
2361		2760
2362	warn "cancelling all WF_AUTOCANCEL watchers";	2761	warn "cancelling all WF_AUTOCANCEL watchers";
2363	for (Event::all_watchers) {	2762	for (Event::all_watchers) {
2364	$_->cancel if $_->data & WF_AUTOCANCEL;	2763	$_->cancel if $_->data & WF_AUTOCANCEL;
2365	}	2764	}
2366		2765
2367	warn "flushing outstanding aio requests";	2766	warn "flushing outstanding aio requests";
2368	for (;;) {	2767	for (;;) {
		2768	BDB::flush;
2369	IO::AIO::flush;	2769	IO::AIO::flush;
2370	Coro::cede;	2770	Coro::cede;
2371	last unless IO::AIO::nreqs;	2771	last unless IO::AIO::nreqs || BDB::nreqs;
2372	warn "iterate...";	2772	warn "iterate...";
2373	}	2773	}
		2774
		2775	++$RELOAD;
2374		2776
2375	warn "cancelling all extension coros";	2777	warn "cancelling all extension coros";
2376	$_->cancel for values %EXT_CORO;	2778	$_->cancel for values %EXT_CORO;
2377	%EXT_CORO = ();	2779	%EXT_CORO = ();
2378		2780
…		…
2418	Symbol::delete_package "safe::$_"	2820	Symbol::delete_package "safe::$_"
2419	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2821	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2420		2822
2421	warn "unloading cf.pm \"a bit\"";	2823	warn "unloading cf.pm \"a bit\"";
2422	delete $INC{"cf.pm"};	2824	delete $INC{"cf.pm"};
		2825	delete $INC{"cf/pod.pm"};
2423		2826
2424	# don't, removes xs symbols, too,	2827	# don't, removes xs symbols, too,
2425	# and global variables created in xs	2828	# and global variables created in xs
2426	#Symbol::delete_package __PACKAGE__;	2829	#Symbol::delete_package __PACKAGE__;
2427		2830
…		…
2431	require cf;	2834	require cf;
2432	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2433		2836
2434	warn "loading config and database again";	2837	warn "loading config and database again";
2435	cf::cfg_load;	2838	cf::cfg_load;
2436	cf::db_load;
2437		2839
2438	warn "loading extensions";	2840	warn "loading extensions";
2439	cf::load_extensions;	2841	cf::load_extensions;
2440		2842
2441	warn "reattaching attachments to objects/players";	2843	warn "reattaching attachments to objects/players";
2442	_global_reattach;	2844	_global_reattach; # objects, sockets
2443	warn "reattaching attachments to maps";	2845	warn "reattaching attachments to maps";
2444	reattach $_ for values %MAP;	2846	reattach $_ for values %MAP;
		2847	warn "reattaching attachments to players";
		2848	reattach $_ for values %PLAYER;
2445		2849
2446	warn "restarting server ticker";	2850	warn "leaving sync_job";
2447		2851
2448	$TICK_WATCHER->start;	2852	1
2449	};	2853	} or do {
2450
2451	if ($@) {
2452	warn $@;	2854	warn $@;
2453	warn "error while reloading, exiting.";	2855	warn "error while reloading, exiting.";
2454	exit 1;	2856	exit 1;
2455	}	2857	};
2456		2858
2457	warn "reloaded";	2859	warn "reloaded";
2458	};	2860	};
2459		2861
2460	our $RELOAD_WATCHER; # used only during reload	2862	our $RELOAD_WATCHER; # used only during reload
2461		2863
		2864	sub reload_perl() {
		2865	# doing reload synchronously and two reloads happen back-to-back,
		2866	# coro crashes during coro_state_free->destroy here.
		2867
		2868	$RELOAD_WATCHER ||= Event->timer (
		2869	reentrant => 0,
		2870	after => 0,
		2871	data => WF_AUTOCANCEL,
		2872	cb => sub {
		2873	do_reload_perl;
		2874	undef $RELOAD_WATCHER;
		2875	},
		2876	);
		2877	}
		2878
2462	register_command "reload" => sub {	2879	register_command "reload" => sub {
2463	my ($who, $arg) = @_;	2880	my ($who, $arg) = @_;
2464		2881
2465	if ($who->flag (FLAG_WIZ)) {	2882	if ($who->flag (FLAG_WIZ)) {
2466	$who->message ("reloading server.");	2883	$who->message ("reloading server.");
2467		2884	async { reload_perl };
2468	# doing reload synchronously and two reloads happen back-to-back,
2469	# coro crashes during coro_state_free->destroy here.
2470
2471	$RELOAD_WATCHER ||= Event->timer (
2472	reentrant => 0,
2473	after => 0,
2474	data => WF_AUTOCANCEL,
2475	cb => sub {
2476	reload;
2477	undef $RELOAD_WATCHER;
2478	},
2479	);
2480	}	2885	}
2481	};	2886	};
2482		2887
2483	unshift @INC, $LIBDIR;	2888	unshift @INC, $LIBDIR;
2484		2889
2485	my $bug_warning = 0;	2890	my $bug_warning = 0;
2486		2891
		2892	our @WAIT_FOR_TICK;
		2893	our @WAIT_FOR_TICK_BEGIN;
		2894
		2895	sub wait_for_tick {
		2896	return unless $TICK_WATCHER->is_active;
		2897	return if $Coro::current == $Coro::main;
		2898
		2899	my $signal = new Coro::Signal;
		2900	push @WAIT_FOR_TICK, $signal;
		2901	$signal->wait;
		2902	}
		2903
		2904	sub wait_for_tick_begin {
		2905	return unless $TICK_WATCHER->is_active;
		2906	return if $Coro::current == $Coro::main;
		2907
		2908	my $signal = new Coro::Signal;
		2909	push @WAIT_FOR_TICK_BEGIN, $signal;
		2910	$signal->wait;
		2911	}
		2912
		2913	my $min = 1e6;#d#
		2914	my $avg = 10;
2487	$TICK_WATCHER = Event->timer (	2915	$TICK_WATCHER = Event->timer (
2488	reentrant => 0,	2916	reentrant => 0,
2489	parked => 1,	2917	parked => 1,
2490	prio => 0,	2918	prio => 0,
2491	at => $NEXT_TICK || $TICK,	2919	at => $NEXT_TICK || $TICK,
…		…
2495	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2496	unless ++$bug_warning > 10;	2924	unless ++$bug_warning > 10;
2497	return;	2925	return;
2498	}	2926	}
2499		2927
2500	$NOW = Event::time;	2928	$NOW = $tick_start = Event::time;
2501		2929
2502	cf::server_tick; # one server iteration	2930	cf::server_tick; # one server iteration
		2931
		2932	0 && sync_job {#d#
		2933	for(1..10) {
		2934	my $t = Event::time;
		2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2936	or die;
		2937
		2938	$map->width (50);
		2939	$map->height (50);
		2940	$map->alloc;
		2941	$map->_load_objects ("/tmp/x.map", 1);
		2942	my $t = Event::time - $t;
		2943
		2944	#next unless $t < 0.0013;#d#
		2945	if ($t < $min) {
		2946	$min = $t;
		2947	}
		2948	$avg = $avg * 0.99 + $t * 0.01;
		2949	}
		2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2951	exit 0;
		2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2953	};
		2954
2503	$RUNTIME += $TICK;	2955	$RUNTIME += $TICK;
2504	$NEXT_TICK += $TICK;	2956	$NEXT_TICK += $TICK;
2505		2957
2506	$WAIT_FOR_TICK->broadcast;	2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2507	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	2959	$NEXT_RUNTIME_WRITE = $NOW + 10;
2508		2960	Coro::async_pool {
2509	Event::sweep;	2961	write_runtime
2510	Coro::cede_notself;	2962	or warn "ERROR: unable to write runtime file: $!";
		2963	};
2511		2964	}
		2965
2512	# my $AFTER = Event::time;	2966	# my $AFTER = Event::time;
2513	# warn $AFTER - $NOW;#d#	2967	# warn $AFTER - $NOW;#d#
2514		2968
		2969	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2970	$sig->send;
		2971	}
		2972	while (my $sig = shift @WAIT_FOR_TICK) {
		2973	$sig->send;
		2974	}
		2975
		2976	$NOW = Event::time;
		2977
2515	# if we are delayed by four ticks or more, skip them all	2978	# if we are delayed by four ticks or more, skip them all
2516	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2979	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2517		2980
2518	$TICK_WATCHER->at ($NEXT_TICK);	2981	$TICK_WATCHER->at ($NEXT_TICK);
2519	$TICK_WATCHER->start;	2982	$TICK_WATCHER->start;
		2983
		2984	$LOAD = ($NOW - $tick_start) / $TICK;
		2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2986
		2987	_post_tick;
		2988
		2989
2520	},	2990	},
2521	);	2991	);
2522		2992
		2993	{
		2994	BDB::max_poll_time $TICK * 0.1;
		2995	$BDB_POLL_WATCHER = Event->io (
		2996	reentrant => 0,
		2997	fd => BDB::poll_fileno,
		2998	poll => 'r',
		2999	prio => 0,
		3000	data => WF_AUTOCANCEL,
		3001	cb => \&BDB::poll_cb,
		3002	);
		3003	BDB::min_parallel 8;
		3004
		3005	BDB::set_sync_prepare {
		3006	my $status;
		3007	my $current = $Coro::current;
		3008	(
		3009	sub {
		3010	$status = $!;
		3011	$current->ready; undef $current;
		3012	},
		3013	sub {
		3014	Coro::schedule while defined $current;
		3015	$! = $status;
		3016	},
		3017	)
		3018	};
		3019
		3020	unless ($DB_ENV) {
		3021	$DB_ENV = BDB::db_env_create;
		3022
		3023	cf::sync_job {
		3024	eval {
		3025	BDB::db_env_open
		3026	$DB_ENV,
		3027	$BDBDIR,
		3028	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3030	0666;
		3031
		3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3033
		3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3035	$DB_ENV->set_lk_detect;
		3036	};
		3037
		3038	cf::cleanup "db_env_open(db): $@" if $@;
		3039	};
		3040	}
		3041	}
		3042
		3043	{
		3044	IO::AIO::min_parallel 8;
		3045
		3046	undef $Coro::AIO::WATCHER;
2523	IO::AIO::max_poll_time $TICK * 0.1;	3047	IO::AIO::max_poll_time $TICK * 0.1;
2524
2525	undef $Coro::AIO::WATCHER;
2526	$AIO_POLL_WATCHER = Event->io (	3048	$AIO_POLL_WATCHER = Event->io (
2527	reentrant => 0,	3049	reentrant => 0,
		3050	data => WF_AUTOCANCEL,
2528	fd => IO::AIO::poll_fileno,	3051	fd => IO::AIO::poll_fileno,
2529	poll => 'r',	3052	poll => 'r',
2530	prio => 6,	3053	prio => 6,
2531	data => WF_AUTOCANCEL,
2532	cb => \&IO::AIO::poll_cb,	3054	cb => \&IO::AIO::poll_cb,
2533	);	3055	);
		3056	}
2534		3057
2535	$WRITE_RUNTIME_WATCHER = Event->timer (	3058	my $_log_backtrace;
2536	reentrant => 0,	3059
2537	data => WF_AUTOCANCEL,	3060	sub _log_backtrace {
2538	after => 1,	3061	my ($msg, @addr) = @_;
2539	interval => 10,	3062
2540	prio => 6, # keep it lowest so it acts like a watchdog	3063	$msg =~ s/\n//;
2541	cb => Coro::unblock_sub {	3064
2542	write_runtime	3065	# limit the # of concurrent backtraces
2543	or warn "ERROR: unable to write runtime file: $!";	3066	if ($_log_backtrace < 2) {
		3067	++$_log_backtrace;
		3068	async {
		3069	my @bt = fork_call {
		3070	@addr = map { sprintf "%x", $_ } @addr;
		3071	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3072	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3073	or die "addr2line: $!";
		3074
		3075	my @funcs;
		3076	my @res = <$fh>;
		3077	chomp for @res;
		3078	while (@res) {
		3079	my ($func, $line) = splice @res, 0, 2, ();
		3080	push @funcs, "[$func] $line";
		3081	}
		3082
		3083	@funcs
		3084	};
		3085
		3086	LOG llevInfo, "[ABT] $msg\n";
		3087	LOG llevInfo, "[ABT] $_\n" for @bt;
		3088	--$_log_backtrace;
		3089	};
		3090	} else {
		3091	LOG llevInfo, "[ABT] $msg\n";
		3092	LOG llevInfo, "[ABT] [suppressed]\n";
2544	},	3093	}
2545	);	3094	}
		3095
		3096	# load additional modules
		3097	use cf::pod;
2546		3098
2547	END { cf::emergency_save }	3099	END { cf::emergency_save }
2548		3100
2549	1	3101	1
2550		3102

Diff Legend

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