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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.288 by root, Mon Jun 25 07:40:53 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 JSON::XS 1.4 ();
20	use BDB ();	26	use BDB ();
21	use Data::Dumper;	27	use Data::Dumper;
22	use Digest::MD5;	28	use Digest::MD5;
23	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
24	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	32	use Time::HiRes;
27	use Compress::LZF;	33	use Compress::LZF;
28		34
		35	# configure various modules to our taste
		36	#
		37	$Storable::canonical = 1; # reduce rsync transfers
		38	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	39	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		40
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	41	$Event::Eval = 1; # no idea why this is required, but it is
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		42
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	43	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;	44	$YAML::Syck::ImplicitUnicode = 1;
37		45
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	46	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		47
		48	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		49
40	our %COMMAND = ();	50	our %COMMAND = ();
41	our %COMMAND_TIME = ();	51	our %COMMAND_TIME = ();
42		52
43	our @EXTS = (); # list of extension package names	53	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	54	our %EXTCMD = ();
		55	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	56	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	57	our %EXT_MAP = (); # pluggable maps
47		58
		59	our $RELOAD; # number of reloads so far
48	our @EVENT;	60	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		61
51	our $TICK = MAX_TIME * 1e-6;	62	our $CONFDIR = confdir;
		63	our $DATADIR = datadir;
		64	our $LIBDIR = "$DATADIR/ext";
		65	our $PODDIR = "$DATADIR/pod";
		66	our $MAPDIR = "$DATADIR/" . mapdir;
		67	our $LOCALDIR = localdir;
		68	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		69	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		70	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		71	our $RANDOMDIR = "$LOCALDIR/random";
		72	our $BDBDIR = "$LOCALDIR/db";
		73
		74	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52	our $TICK_WATCHER;	75	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	76	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	77	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	78	our $NEXT_TICK;
56	our $NOW;	79	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	80	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		81
59	our $BDB_POLL_WATCHER;	82	our $BDB_POLL_WATCHER;
…		…
65	our $RUNTIME;	88	our $RUNTIME;
66		89
67	our %PLAYER; # all users	90	our %PLAYER; # all users
68	our %MAP; # all maps	91	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	92	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		93
76	# used to convert map paths into valid unix filenames by replacing / by ∕	94	# used to convert map paths into valid unix filenames by replacing / by ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	95	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		96
		97	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		98	our $LOADAVG; # same thing, but with alpha-smoothing
		99	our $tick_start; # for load detecting purposes
		100
79	binmode STDOUT;	101	binmode STDOUT;
80	binmode STDERR;	102	binmode STDERR;
81		103
82	# read virtual server time, if available	104	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	105	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	106	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	107	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	108	$RUNTIME = <$fh> + 0.;
87	}	109	}
88		110
89	mkdir cf::localdir;	111	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	112	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		113
96	our $EMERGENCY_POSITION;	114	our $EMERGENCY_POSITION;
97		115
98	sub cf::map::normalise;	116	sub cf::map::normalise;
99		117
…		…
110	=item $cf::RUNTIME	128	=item $cf::RUNTIME
111		129
112	The time this server has run, starts at 0 and is increased by $cf::TICK on	130	The time this server has run, starts at 0 and is increased by $cf::TICK on
113	every server tick.	131	every server tick.
114		132
115	=item $cf::LIBDIR	133	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		134	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		135	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116		136
117	The perl library directory, where extensions and cf-specific modules can	137	Various directories - "/etc", read-only install directory, perl-library
118	be found. It will be added to C<@INC> automatically.	138	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		139	unique-items directory, player file directory, random maps directory and
		140	database environment.
119		141
120	=item $cf::NOW	142	=item $cf::NOW
121		143
122	The time of the last (current) server tick.	144	The time of the last (current) server tick.
123		145
124	=item $cf::TICK	146	=item $cf::TICK
125		147
126	The interval between server ticks, in seconds.	148	The interval between server ticks, in seconds.
		149
		150	=item $cf::LOADAVG
		151
		152	The current CPU load on the server (alpha-smoothed), as a value between 0
		153	(none) and 1 (overloaded), indicating how much time is spent on processing
		154	objects per tick. Healthy values are < 0.5.
		155
		156	=item $cf::LOAD
		157
		158	The raw value load value from the last tick.
127		159
128	=item %cf::CFG	160	=item %cf::CFG
129		161
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	162	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	163	from wherever your confdir points to.
132		164
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	165	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		166
135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	167	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	168	returns directly I<after> the tick processing (and consequently, can only wake one process
137	processing has been done. Call C<< ->wait >> on them to maximise the	169	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138	window of cpu time available, or simply to synchronise to the server tick.
139		170
140	=back	171	=back
141		172
142	=cut	173	=cut
143		174
144	BEGIN {	175	BEGIN {
145	*CORE::GLOBAL::warn = sub {	176	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	177	my $msg = join "", @_;
147	utf8::encode $msg;
148		178
149	$msg .= "\n"	179	$msg .= "\n"
150	unless $msg =~ /\n$/;	180	unless $msg =~ /\n$/;
151		181
		182	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		183
		184	utf8::encode $msg;
152	LOG llevError, $msg;	185	LOG llevError, $msg;
153	};	186	};
154	}	187	}
155		188
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	189	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	190	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	191	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	192	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	193	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		194	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	195	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162		196
163	# we bless all objects into (empty) derived classes to force a method lookup	197	# we bless all objects into (empty) derived classes to force a method lookup
164	# within the Safe compartment.	198	# within the Safe compartment.
165	for my $pkg (qw(	199	for my $pkg (qw(
166	cf::global cf::attachable	200	cf::global cf::attachable
…		…
174	}	208	}
175		209
176	$Event::DIED = sub {	210	$Event::DIED = sub {
177	warn "error in event callback: @_";	211	warn "error in event callback: @_";
178	};	212	};
		213
		214	#############################################################################
179		215
180	=head2 UTILITY FUNCTIONS	216	=head2 UTILITY FUNCTIONS
181		217
182	=over 4	218	=over 4
183		219
…		…
202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	238	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203	$d	239	$d
204	} || "[unable to dump $_[0]: '$@']";	240	} || "[unable to dump $_[0]: '$@']";
205	}	241	}
206		242
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
210		244
211	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
212		246
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
221		248
222	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
223		250
224	=cut	251	=cut
225		252
226	sub to_json($) {	253	our $json_coder = JSON::XS->new->convert_blessed->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	254
228	JSON::Syck::Dump $_[0]	255	sub to_json ($) { $json_coder->encode ($_[0]) }
229	}	256	sub from_json ($) { $json_coder->decode ($_[0]) }
230		257
231	=item cf::lock_wait $string	258	=item cf::lock_wait $string
232		259
233	Wait until the given lock is available. See cf::lock_acquire.	260	Wait until the given lock is available. See cf::lock_acquire.
234		261
…		…
240	returned.	267	returned.
241		268
242	Lock names should begin with a unique identifier (for example, cf::map::find	269	Lock names should begin with a unique identifier (for example, cf::map::find
243	uses map_find and cf::map::load uses map_load).	270	uses map_find and cf::map::load uses map_load).
244		271
		272	=item $locked = cf::lock_active $string
		273
		274	Return true if the lock is currently active, i.e. somebody has locked it.
		275
245	=cut	276	=cut
246		277
247	our %LOCK;	278	our %LOCK;
248		279
249	sub lock_wait($) {	280	sub lock_wait($) {
…		…
268	# wake up all waiters, to be on the safe side	299	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	300	$_->ready for @{ delete $LOCK{$key} };
270	}	301	}
271	}	302	}
272		303
		304	sub lock_active($) {
		305	my ($key) = @_;
		306
		307	! ! $LOCK{$key}
		308	}
		309
273	sub freeze_mainloop {	310	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	311	return unless $TICK_WATCHER->is_active;
275		312
276	my $guard = Coro::guard {	313	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	314	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	315	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	316	$TICK_WATCHER->stop;
282	$guard	317	$guard
283	}	318	}
284		319
285	=item cf::async { BLOCK }	320	=item cf::async { BLOCK }
…		…
292		327
293	BEGIN { *async = \&Coro::async_pool }	328	BEGIN { *async = \&Coro::async_pool }
294		329
295	=item cf::sync_job { BLOCK }	330	=item cf::sync_job { BLOCK }
296		331
297	The design of crossfire+ requires that the main coro ($Coro::main) is	332	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298	always able to handle events or runnable, as crossfire+ is only partly	333	is always able to handle events or runnable, as Crossfire TRT is only
299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	334	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		335	acceptable.
300		336
301	If it must be done, put the blocking parts into C<sync_job>. This will run	337	If it must be done, put the blocking parts into C<sync_job>. This will run
302	the given BLOCK in another coroutine while waiting for the result. The	338	the given BLOCK in another coroutine while waiting for the result. The
303	server will be frozen during this time, so the block should either finish	339	server will be frozen during this time, so the block should either finish
304	fast or be very important.	340	fast or be very important.
…		…
307		343
308	sub sync_job(&) {	344	sub sync_job(&) {
309	my ($job) = @_;	345	my ($job) = @_;
310		346
311	if ($Coro::current == $Coro::main) {	347	if ($Coro::current == $Coro::main) {
		348	my $time = Event::time;
		349
312	# this is the main coro, too bad, we have to block	350	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	351	# till the operation succeeds, freezing the server :/
314		352
315	# TODO: use suspend/resume instead	353	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	354	# (but this is cancel-safe)
…		…
327		365
328	while ($busy) {	366	while ($busy) {
329	Coro::cede or Event::one_event;	367	Coro::cede or Event::one_event;
330	}	368	}
331		369
		370	$time = Event::time - $time;
		371
		372	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		373	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		374
		375	$tick_start += $time; # do not account sync jobs to server load
		376
332	wantarray ? @res : $res[0]	377	wantarray ? @res : $res[0]
333	} else {	378	} else {
334	# we are in another coroutine, how wonderful, everything just works	379	# we are in another coroutine, how wonderful, everything just works
335		380
336	$job->()	381	$job->()
…		…
355	$EXT_CORO{$coro+0} = $coro;	400	$EXT_CORO{$coro+0} = $coro;
356		401
357	$coro	402	$coro
358	}	403	}
359		404
360	sub write_runtime {	405	=item fork_call { }, $args
361	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362		406
363	my $runtime = cf::localdir . "/runtime";	407	Executes the given code block with the given arguments in a seperate
		408	process, returning the results. Everything must be serialisable with
		409	Coro::Storable. May, of course, block. Note that the executed sub may
		410	never block itself or use any form of Event handling.
364		411
365	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	412	=cut
366	or return;
367		413
368	my $value = $cf::RUNTIME + 90 + 10;	414	sub fork_call(&@) {
369	# 10 is the runtime save interval, for a monotonic clock	415	my ($cb, @args) = @_;
370	# 60 allows for the watchdog to kill the server.
371		416
372	(aio_write $fh, 0, (length $value), $value, 0) <= 0	417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
373	and return;	418	# or die "socketpair: $!";
		419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
374		421
375	# always fsync - this file is important	422	if (my $pid = fork) {
376	aio_fsync $fh
377	and return;
378
379	close $fh	423	close $fh2;
380	or return;
381		424
382	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
383	and return;	426	$res = Coro::Storable::thaw $res;
384		427
		428	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		429
		430	die $$res unless "ARRAY" eq ref $res;
		431
		432	return wantarray ? @$res : $res->[-1];
		433	} else {
		434	reset_signals;
		435	local $SIG{__WARN__};
		436	local $SIG{__DIE__};
		437	eval {
		438	close $fh1;
		439
		440	my @res = eval { $cb->(@args) };
		441	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		442	};
		443
		444	warn $@ if $@;
		445	_exit 0;
385	1	446	}
		447	}
		448
		449	=item $value = cf::db_get $family => $key
		450
		451	Returns a single value from the environment database.
		452
		453	=item cf::db_put $family => $key => $value
		454
		455	Stores the given C<$value> in the family. It can currently store binary
		456	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		457
		458	=cut
		459
		460	our $DB;
		461
		462	sub db_init {
		463	unless ($DB) {
		464	$DB = BDB::db_create $DB_ENV;
		465
		466	cf::sync_job {
		467	eval {
		468	$DB->set_flags (BDB::CHKSUM);
		469
		470	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		471	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		472	cf::cleanup "db_open(db): $!" if $!;
		473	};
		474	cf::cleanup "db_open(db): $@" if $@;
		475	};
		476	}
		477	}
		478
		479	sub db_get($$) {
		480	my $key = "$_[0]/$_[1]";
		481
		482	cf::sync_job {
		483	BDB::db_get $DB, undef, $key, my $data;
		484
		485	$! ? ()
		486	: $data
		487	}
		488	}
		489
		490	sub db_put($$$) {
		491	BDB::dbreq_pri 4;
		492	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		493	}
		494
		495	=item cf::cache $id => [$paths...], $processversion => $process
		496
		497	Generic caching function that returns the value of the resource $id,
		498	caching and regenerating as required.
		499
		500	This function can block.
		501
		502	=cut
		503
		504	sub cache {
		505	my ($id, $src, $processversion, $process) = @_;
		506
		507	my $meta =
		508	join "\x00",
		509	$processversion,
		510	map {
		511	aio_stat $_
		512	and Carp::croak "$_: $!";
		513
		514	($_, (stat _)[7,9])
		515	} @$src;
		516
		517	my $dbmeta = db_get cache => "$id/meta";
		518	if ($dbmeta ne $meta) {
		519	# changed, we may need to process
		520
		521	my @data;
		522	my $md5;
		523
		524	for (0 .. $#$src) {
		525	0 <= aio_load $src->[$_], $data[$_]
		526	or Carp::croak "$src->[$_]: $!";
		527	}
		528
		529	# if processing is expensive, check
		530	# checksum first
		531	if (1) {
		532	$md5 =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	Coro::cede;
		537	($src->[$_], Digest::MD5::md5_hex $data[$_])
		538	} 0.. $#$src;
		539
		540
		541	my $dbmd5 = db_get cache => "$id/md5";
		542	if ($dbmd5 eq $md5) {
		543	db_put cache => "$id/meta", $meta;
		544
		545	return db_get cache => "$id/data";
		546	}
		547	}
		548
		549	my $t1 = Time::HiRes::time;
		550	my $data = $process->(\@data);
		551	my $t2 = Time::HiRes::time;
		552
		553	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		554
		555	db_put cache => "$id/data", $data;
		556	db_put cache => "$id/md5" , $md5;
		557	db_put cache => "$id/meta", $meta;
		558
		559	return $data;
		560	}
		561
		562	db_get cache => "$id/data"
		563	}
		564
		565	=item cf::datalog type => key => value, ...
		566
		567	Log a datalog packet of the given type with the given key-value pairs.
		568
		569	=cut
		570
		571	sub datalog($@) {
		572	my ($type, %kv) = @_;
		573	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
386	}	574	}
387		575
388	=back	576	=back
389		577
390	=cut	578	=cut
…		…
397	attach callbacks/event handlers (a collection of which is called an "attachment")	585	attach callbacks/event handlers (a collection of which is called an "attachment")
398	to it. All such attachable objects support the following methods.	586	to it. All such attachable objects support the following methods.
399		587
400	In the following description, CLASS can be any of C<global>, C<object>	588	In the following description, CLASS can be any of C<global>, C<object>
401	C<player>, C<client> or C<map> (i.e. the attachable objects in	589	C<player>, C<client> or C<map> (i.e. the attachable objects in
402	crossfire+).	590	Crossfire TRT).
403		591
404	=over 4	592	=over 4
405		593
406	=item $attachable->attach ($attachment, key => $value...)	594	=item $attachable->attach ($attachment, key => $value...)
407		595
…		…
570	$registry = $CB_TYPE[$object_type] ||= [];	758	$registry = $CB_TYPE[$object_type] ||= [];
571		759
572	} elsif ($type eq "subtype") {	760	} elsif ($type eq "subtype") {
573	defined $object_type or Carp::croak "subtype specified without type";	761	defined $object_type or Carp::croak "subtype specified without type";
574	my $object_subtype = shift @arg;	762	my $object_subtype = shift @arg;
575	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	763	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576		764
577	} elsif ($type eq "package") {	765	} elsif ($type eq "package") {
578	my $pkg = shift @arg;	766	my $pkg = shift @arg;
579		767
580	while (my ($name, $id) = each %cb_id) {	768	while (my ($name, $id) = each %cb_id) {
…		…
609	_attach $registry, $klass, @attach;	797	_attach $registry, $klass, @attach;
610	}	798	}
611		799
612	$obj->{$name} = \%arg;	800	$obj->{$name} = \%arg;
613	} else {	801	} else {
614	warn "object uses attachment '$name' that is not available, postponing.\n";	802	warn "object uses attachment '$name' which is not available, postponing.\n";
615	}	803	}
616		804
617	$obj->{_attachment}{$name} = undef;	805	$obj->{_attachment}{$name} = undef;
618	}	806	}
619		807
…		…
621	if (ref $_[0]) {	809	if (ref $_[0]) {
622	_object_attach @_;	810	_object_attach @_;
623	} else {	811	} else {
624	_attach shift->_attach_registry, @_;	812	_attach shift->_attach_registry, @_;
625	}	813	}
		814	_recalc_want;
626	};	815	};
627		816
628	# all those should be optimised	817	# all those should be optimised
629	sub cf::attachable::detach {	818	sub cf::attachable::detach {
630	my ($obj, $name) = @_;	819	my ($obj, $name) = @_;
…		…
633	delete $obj->{_attachment}{$name};	822	delete $obj->{_attachment}{$name};
634	reattach ($obj);	823	reattach ($obj);
635	} else {	824	} else {
636	Carp::croak "cannot, currently, detach class attachments";	825	Carp::croak "cannot, currently, detach class attachments";
637	}	826	}
		827	_recalc_want;
638	};	828	};
639		829
640	sub cf::attachable::attached {	830	sub cf::attachable::attached {
641	my ($obj, $name) = @_;	831	my ($obj, $name) = @_;
642		832
…		…
789	}	979	}
790	} else {	980	} else {
791	aio_unlink $filename;	981	aio_unlink $filename;
792	aio_unlink "$filename.pst";	982	aio_unlink "$filename.pst";
793	}	983	}
794
795	#d##TODO# nuke non .map-files if exist
796	if ($filename =~ s/\.map$//) {
797	aio_unlink $filename;
798	aio_unlink "$filename.pst";
799	}
800	}	984	}
801	}	985	}
802		986
803	sub object_freezer_as_string {	987	sub object_freezer_as_string {
804	my ($rdata, $objs) = @_;	988	my ($rdata, $objs) = @_;
…		…
810		994
811	sub object_thawer_load {	995	sub object_thawer_load {
812	my ($filename) = @_;	996	my ($filename) = @_;
813		997
814	my ($data, $av);	998	my ($data, $av);
815
816	#d#TODO remove .map if file does not exist
817	aio_stat $filename and $filename =~ s/\.map$//;
818		999
819	(aio_load $filename, $data) >= 0	1000	(aio_load $filename, $data) >= 0
820	or return;	1001	or return;
821		1002
822	unless (aio_stat "$filename.pst") {	1003	unless (aio_stat "$filename.pst") {
…		…
824	or return;	1005	or return;
825	$av = eval { (Storable::thaw $av)->{objs} };	1006	$av = eval { (Storable::thaw $av)->{objs} };
826	}	1007	}
827		1008
828	warn sprintf "loading %s (%d)\n",	1009	warn sprintf "loading %s (%d)\n",
829	$filename, length $data, scalar @{$av || []};#d#	1010	$filename, length $data, scalar @{$av || []};
830	return ($data, $av);	1011	return ($data, $av);
831	}	1012	}
		1013
		1014	=head2 COMMAND CALLBACKS
		1015
		1016	=over 4
		1017
		1018	=cut
832		1019
833	#############################################################################	1020	#############################################################################
834	# command handling &c	1021	# command handling &c
835		1022
836	=item cf::register_command $name => \&callback($ob,$args);	1023	=item cf::register_command $name => \&callback($ob,$args);
…		…
849	push @{ $COMMAND{$name} }, [$caller, $cb];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
850	}	1037	}
851		1038
852	=item cf::register_extcmd $name => \&callback($pl,$packet);	1039	=item cf::register_extcmd $name => \&callback($pl,$packet);
853		1040
854	Register a callbackf ro execution when the client sends an extcmd packet.	1041	Register a callback for execution when the client sends an (synchronous)
		1042	extcmd packet. Ext commands will be processed in the order they are
		1043	received by the server, like other user commands. The first argument is
		1044	the logged-in player. Ext commands can only be processed after a player
		1045	has logged in successfully.
855		1046
856	If the callback returns something, it is sent back as if reply was being	1047	If the callback returns something, it is sent back as if reply was being
857	called.	1048	called.
858		1049
		1050	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1051
		1052	Register a callback for execution when the client sends an (asynchronous)
		1053	exticmd packet. Exti commands are processed by the server as soon as they
		1054	are received, i.e. out of order w.r.t. other commands. The first argument
		1055	is a client socket. Exti commands can be received anytime, even before
		1056	log-in.
		1057
		1058	If the callback returns something, it is sent back as if reply was being
		1059	called.
		1060
859	=cut	1061	=cut
860		1062
861	sub register_extcmd {	1063	sub register_extcmd {
862	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
863		1065
864	$EXTCMD{$name} = $cb;	1066	$EXTCMD{$name} = $cb;
		1067	}
		1068
		1069	sub register_exticmd {
		1070	my ($name, $cb) = @_;
		1071
		1072	$EXTICMD{$name} = $cb;
865	}	1073	}
866		1074
867	cf::player->attach (	1075	cf::player->attach (
868	on_command => sub {	1076	on_command => sub {
869	my ($pl, $name, $params) = @_;	1077	my ($pl, $name, $params) = @_;
…		…
894		1102
895	cf::override;	1103	cf::override;
896	},	1104	},
897	);	1105	);
898		1106
899	sub load_extension {
900	my ($path) = @_;
901
902	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
903	my $base = $1;
904	my $pkg = $1;
905	$pkg =~ s/[^[:word:]]/_/g;
906	$pkg = "ext::$pkg";
907
908	warn "... loading '$path' into '$pkg'\n";
909
910	open my $fh, "<:utf8", $path
911	or die "$path: $!";
912
913	my $source =
914	"package $pkg; use strict; use utf8;\n"
915	. "#line 1 \"$path\"\n{\n"
916	. (do { local $/; <$fh> })
917	. "\n};\n1";
918
919	unless (eval $source) {
920	my $msg = $@ ? "$path: $@\n"
921	: "extension disabled.\n";
922	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923	warn $@;
924	warn "mandatory extension failed to load, exiting.\n";
925	exit 1;
926	}
927	die $@;
928	}
929
930	push @EXTS, $pkg;
931	}
932
933	sub load_extensions {	1107	sub load_extensions {
		1108	cf::sync_job {
		1109	my %todo;
		1110
934	for my $ext (<$LIBDIR/*.ext>) {	1111	for my $path (<$LIBDIR/*.ext>) {
935	next unless -r $ext;	1112	next unless -r $path;
936	eval {	1113
937	load_extension $ext;	1114	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1115	my $base = $1;
		1116	my $pkg = $1;
		1117	$pkg =~ s/[^[:word:]]/_/g;
		1118	$pkg = "ext::$pkg";
		1119
		1120	open my $fh, "<:utf8", $path
		1121	or die "$path: $!";
		1122
		1123	my $source = do { local $/; <$fh> };
		1124
		1125	my %ext = (
		1126	path => $path,
		1127	base => $base,
		1128	pkg => $pkg,
		1129	);
		1130
		1131	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1132	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1133
		1134	$ext{source} =
		1135	"package $pkg; use strict; use utf8;\n"
		1136	. "#line 1 \"$path\"\n{\n"
		1137	. $source
		1138	. "\n};\n1";
		1139
		1140	$todo{$base} = \%ext;
		1141	}
		1142
		1143	my %done;
		1144	while (%todo) {
		1145	my $progress;
		1146
		1147	while (my ($k, $v) = each %todo) {
		1148	for (split /,\s*/, $v->{meta}{depends}) {
		1149	goto skip
		1150	unless exists $done{$_};
		1151	}
		1152
		1153	warn "... loading '$k' into '$v->{pkg}'\n";
		1154
		1155	unless (eval $v->{source}) {
		1156	my $msg = $@ ? "$v->{path}: $@\n"
		1157	: "$v->{base}: extension inactive.\n";
		1158
		1159	if (exists $v->{meta}{mandatory}) {
		1160	warn $msg;
		1161	warn "mandatory extension failed to load, exiting.\n";
		1162	exit 1;
		1163	}
		1164
		1165	warn $msg;
		1166	}
		1167
		1168	$done{$k} = delete $todo{$k};
		1169	push @EXTS, $v->{pkg};
		1170	$progress = 1;
938	1	1171	}
939	} or warn "$ext not loaded: $@";	1172
		1173	skip:
		1174	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1175	unless $progress;
		1176	}
940	}	1177	};
941	}	1178	}
942		1179
943	#############################################################################	1180	#############################################################################
944		1181
		1182	=back
		1183
945	=head2 CORE EXTENSIONS	1184	=head2 CORE EXTENSIONS
946		1185
947	Functions and methods that extend core crossfire objects.	1186	Functions and methods that extend core crossfire objects.
948		1187
949	=cut	1188	=cut
…		…
961	Returns the given player object, loading it if necessary (might block).	1200	Returns the given player object, loading it if necessary (might block).
962		1201
963	=cut	1202	=cut
964		1203
965	sub playerdir($) {	1204	sub playerdir($) {
966	cf::localdir	1205	"$PLAYERDIR/"
967	. "/"
968	. cf::playerdir
969	. "/"
970	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1206	. (ref $_[0] ? $_[0]->ob->name : $_[0])
971	}	1207	}
972		1208
973	sub path($) {	1209	sub path($) {
974	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1210	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975		1211
976	(playerdir $login) . "/$login.pl"	1212	(playerdir $login) . "/playerdata"
977	}	1213	}
978		1214
979	sub find_active($) {	1215	sub find_active($) {
980	$cf::PLAYER{$_[0]}	1216	$cf::PLAYER{$_[0]}
981	and $cf::PLAYER{$_[0]}->active	1217	and $cf::PLAYER{$_[0]}->active
…		…
994	my $login = $_[0];	1230	my $login = $_[0];
995		1231
996	my $guard = cf::lock_acquire "user_find:$login";	1232	my $guard = cf::lock_acquire "user_find:$login";
997		1233
998	$cf::PLAYER{$_[0]} || do {	1234	$cf::PLAYER{$_[0]} || do {
		1235	# rename old playerfiles to new ones
		1236	#TODO: remove when no longer required
		1237	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1238	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1239	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1240	aio_unlink +(playerdir $login) . "/$login.pl";
		1241
999	my $pl = load_pl path $login	1242	my $pl = load_pl path $login
1000	or return;	1243	or return;
1001	$cf::PLAYER{$login} = $pl	1244	$cf::PLAYER{$login} = $pl
1002	}	1245	}
1003	}	1246	}
…		…
1040		1283
1041	=cut	1284	=cut
1042		1285
1043	sub quit_character {	1286	sub quit_character {
1044	my ($pl) = @_;	1287	my ($pl) = @_;
		1288
		1289	my $name = $pl->ob->name;
1045		1290
1046	$pl->{deny_save} = 1;	1291	$pl->{deny_save} = 1;
1047	$pl->password ("*"); # this should lock out the player until we nuked the dir	1292	$pl->password ("*"); # this should lock out the player until we nuked the dir
1048		1293
1049	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1294	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1054	my $path = playerdir $pl;	1299	my $path = playerdir $pl;
1055	my $temp = "$path~$cf::RUNTIME~deleting~";	1300	my $temp = "$path~$cf::RUNTIME~deleting~";
1056	aio_rename $path, $temp;	1301	aio_rename $path, $temp;
1057	delete $cf::PLAYER{$pl->ob->name};	1302	delete $cf::PLAYER{$pl->ob->name};
1058	$pl->destroy;	1303	$pl->destroy;
		1304
		1305	my $prefix = qr<^~\Q$name\E/>;
		1306
		1307	# nuke player maps
		1308	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1309
1059	IO::AIO::aio_rmtree $temp;	1310	IO::AIO::aio_rmtree $temp;
		1311	}
		1312
		1313	=item $pl->kick
		1314
		1315	Kicks a player out of the game. This destroys the connection.
		1316
		1317	=cut
		1318
		1319	sub kick {
		1320	my ($pl, $kicker) = @_;
		1321
		1322	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1323	$pl->killer ("kicked");
		1324	$pl->ns->destroy;
1060	}	1325	}
1061		1326
1062	=item cf::player::list_logins	1327	=item cf::player::list_logins
1063		1328
1064	Returns am arrayref of all valid playernames in the system, can take a	1329	Returns am arrayref of all valid playernames in the system, can take a
1065	while and may block, so not sync_job-capable, ever.	1330	while and may block, so not sync_job-capable, ever.
1066		1331
1067	=cut	1332	=cut
1068		1333
1069	sub list_logins {	1334	sub list_logins {
1070	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1335	my $dirs = aio_readdir $PLAYERDIR
1071	or return [];	1336	or return [];
1072		1337
1073	my @logins;	1338	my @logins;
1074		1339
1075	for my $login (@$dirs) {	1340	for my $login (@$dirs) {
…		…
1110	}	1375	}
1111		1376
1112	\@paths	1377	\@paths
1113	}	1378	}
1114		1379
		1380	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1381
		1382	Expand crossfire pod fragments into protocol xml.
		1383
		1384	=cut
		1385
		1386	sub expand_cfpod {
		1387	((my $self), (local $_)) = @_;
		1388
		1389	# escape & and <
		1390	s/&/&amp;/g;
		1391	s/(?<![BIUGH])</&lt;/g;
		1392
		1393	# this is buggy, it needs to properly take care of nested <'s
		1394
		1395	1 while
		1396	# replace B<>, I<>, U<> etc.
		1397	s/B<([^\>]*)>/<b>$1<\/b>/
		1398	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1399	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1400	# replace G<male|female> tags
		1401	|| s{G<([^>|]*)\|([^>]*)>}{
		1402	$self->gender ? $2 : $1
		1403	}ge
		1404	# replace H<hint text>
		1405	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1406
		1407	# create single paragraphs (very hackish)
		1408	s/(?<=\S)\n(?=\w)/ /g;
		1409
		1410	$_
		1411	}
		1412
1115	=item $player->ext_reply ($msgid, $msgtype, %msg)	1413	=item $player->ext_reply ($msgid, %msg)
1116		1414
1117	Sends an ext reply to the player.	1415	Sends an ext reply to the player.
1118		1416
1119	=cut	1417	=cut
1120		1418
1121	sub ext_reply($$$%) {	1419	sub ext_reply($$%) {
1122	my ($self, $id, %msg) = @_;	1420	my ($self, $id, %msg) = @_;
1123		1421
1124	$msg{msgid} = $id;	1422	$msg{msgid} = $id;
1125
1126	$self->send ("ext " . cf::to_json \%msg);	1423	$self->send ("ext " . cf::to_json \%msg);
1127	}	1424	}
1128		1425
1129	package cf;	1426	=item $player->ext_event ($type, %msg)
		1427
		1428	Sends an ext event to the client.
		1429
		1430	=cut
		1431
		1432	sub ext_event($$%) {
		1433	my ($self, $type, %msg) = @_;
		1434
		1435	$self->ns->ext_event ($type, %msg);
		1436	}
		1437
		1438	=head3 cf::region
		1439
		1440	=over 4
		1441
		1442	=cut
		1443
		1444	package cf::region;
		1445
		1446	=item cf::region::find_by_path $path
		1447
		1448	Tries to decuce the likely region for a map knowing only its path.
		1449
		1450	=cut
		1451
		1452	sub find_by_path($) {
		1453	my ($path) = @_;
		1454
		1455	my ($match, $specificity);
		1456
		1457	for my $region (list) {
		1458	if ($region->match && $path =~ $region->match) {
		1459	($match, $specificity) = ($region, $region->specificity)
		1460	if $region->specificity > $specificity;
		1461	}
		1462	}
		1463
		1464	$match
		1465	}
1130		1466
1131	=back	1467	=back
1132
1133		1468
1134	=head3 cf::map	1469	=head3 cf::map
1135		1470
1136	=over 4	1471	=over 4
1137		1472
…		…
1192	my ($self, $merge) = @_;	1527	my ($self, $merge) = @_;
1193		1528
1194	# we have to keep some variables in memory intact	1529	# we have to keep some variables in memory intact
1195	local $self->{path};	1530	local $self->{path};
1196	local $self->{load_path};	1531	local $self->{load_path};
1197	local $self->{deny_save};
1198	local $self->{deny_reset};
1199		1532
1200	$self->SUPER::thawer_merge ($merge);	1533	$self->SUPER::thawer_merge ($merge);
1201	}	1534	}
1202		1535
1203	sub normalise {	1536	sub normalise {
…		…
1275		1608
1276	# the original (read-only) location	1609	# the original (read-only) location
1277	sub load_path {	1610	sub load_path {
1278	my ($self) = @_;	1611	my ($self) = @_;
1279		1612
1280	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1613	"$MAPDIR/$self->{path}.map"
1281	}	1614	}
1282		1615
1283	# the temporary/swap location	1616	# the temporary/swap location
1284	sub save_path {	1617	sub save_path {
1285	my ($self) = @_;	1618	my ($self) = @_;
1286		1619
1287	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1620	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1621	"$TMPDIR/$path.map"
1289	}	1622	}
1290		1623
1291	# the unique path, undef == no special unique path	1624	# the unique path, undef == no special unique path
1292	sub uniq_path {	1625	sub uniq_path {
1293	my ($self) = @_;	1626	my ($self) = @_;
1294		1627
1295	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1628	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1629	"$UNIQUEDIR/$path"
1297	}	1630	}
1298		1631
1299	# and all this just because we cannot iterate over	1632	# and all this just because we cannot iterate over
1300	# all maps in C++...	1633	# all maps in C++...
1301	sub change_all_map_light {	1634	sub change_all_map_light {
…		…
1303		1636
1304	$_->change_map_light ($change)	1637	$_->change_map_light ($change)
1305	for grep $_->outdoor, values %cf::MAP;	1638	for grep $_->outdoor, values %cf::MAP;
1306	}	1639	}
1307		1640
		1641	sub decay_objects {
		1642	my ($self) = @_;
		1643
		1644	return if $self->{deny_reset};
		1645
		1646	$self->do_decay_objects;
		1647	}
		1648
1308	sub unlink_save {	1649	sub unlink_save {
1309	my ($self) = @_;	1650	my ($self) = @_;
1310		1651
1311	utf8::encode (my $save = $self->save_path);	1652	utf8::encode (my $save = $self->save_path);
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1653	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1654	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315	#d#TODO remove .map and also nuke
1316	$save =~ s/\.map// or return;#d#
1317	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319	}	1655	}
1320		1656
1321	sub load_header_from($) {	1657	sub load_header_from($) {
1322	my ($self, $path) = @_;	1658	my ($self, $path) = @_;
1323		1659
…		…
1373	$self->load_header_orig	1709	$self->load_header_orig
1374	or return;	1710	or return;
1375	$self->prepare_orig;	1711	$self->prepare_orig;
1376	}	1712	}
1377		1713
		1714	$self->{deny_reset} = 1
		1715	if $self->no_reset;
		1716
		1717	$self->default_region (cf::region::find_by_path $self->{path})
		1718	unless $self->default_region;
		1719
1378	1	1720	1
1379	}	1721	}
1380		1722
1381	sub find;	1723	sub find;
1382	sub find {	1724	sub find {
…		…
1394	$map->{last_save} = $cf::RUNTIME;	1736	$map->{last_save} = $cf::RUNTIME;
1395		1737
1396	$map->load_header	1738	$map->load_header
1397	or return;	1739	or return;
1398		1740
1399	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1741	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400	# doing this can freeze the server in a sync job, obviously	1742	# doing this can freeze the server in a sync job, obviously
1401	#$cf::WAIT_FOR_TICK->wait;	1743	#$cf::WAIT_FOR_TICK->wait;
1402	$map->reset;	1744	$map->reset;
1403	undef $guard;	1745	undef $guard;
1404	return find $path;	1746	return find $path;
…		…
1415	my ($self) = @_;	1757	my ($self) = @_;
1416		1758
1417	local $self->{deny_reset} = 1; # loading can take a long time	1759	local $self->{deny_reset} = 1; # loading can take a long time
1418		1760
1419	my $path = $self->{path};	1761	my $path = $self->{path};
		1762
		1763	{
1420	my $guard = cf::lock_acquire "map_load:$path";	1764	my $guard = cf::lock_acquire "map_load:$path";
1421		1765
1422	return if $self->in_memory != cf::MAP_SWAPPED;	1766	return if $self->in_memory != cf::MAP_SWAPPED;
1423		1767
1424	$self->in_memory (cf::MAP_LOADING);	1768	$self->in_memory (cf::MAP_LOADING);
1425		1769
1426	$self->alloc;	1770	$self->alloc;
1427		1771
1428	$self->pre_load;	1772	$self->pre_load;
1429
1430	$self->_load_objects ($self->{load_path}, 1)
1431	or return;
1432
1433	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434	if delete $self->{load_original};
1435
1436	if (my $uniq = $self->uniq_path) {
1437	utf8::encode $uniq;
1438	if (aio_open $uniq, O_RDONLY, 0) {
1439	$self->clear_unique_items;
1440	$self->_load_objects ($uniq, 0);
1441	}
1442	}
1443
1444	Coro::cede;
1445
1446	# now do the right thing for maps
1447	$self->link_multipart_objects;
1448
1449	unless ($self->{deny_activate}) {
1450	$self->decay_objects;
1451	$self->fix_auto_apply;
1452	$self->update_buttons;
1453	Coro::cede;	1773	Coro::cede;
1454	$self->set_darkness_map;	1774
		1775	$self->_load_objects ($self->{load_path}, 1)
		1776	or return;
		1777
		1778	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1779	if delete $self->{load_original};
		1780
		1781	if (my $uniq = $self->uniq_path) {
		1782	utf8::encode $uniq;
		1783	if (aio_open $uniq, O_RDONLY, 0) {
		1784	$self->clear_unique_items;
		1785	$self->_load_objects ($uniq, 0);
		1786	}
		1787	}
		1788
		1789	Coro::cede;
		1790	# now do the right thing for maps
		1791	$self->link_multipart_objects;
1455	$self->difficulty ($self->estimate_difficulty)	1792	$self->difficulty ($self->estimate_difficulty)
1456	unless $self->difficulty;	1793	unless $self->difficulty;
1457	Coro::cede;	1794	Coro::cede;
		1795
		1796	unless ($self->{deny_activate}) {
		1797	$self->decay_objects;
		1798	$self->fix_auto_apply;
		1799	$self->update_buttons;
		1800	Coro::cede;
		1801	$self->set_darkness_map;
		1802	Coro::cede;
1458	$self->activate;	1803	$self->activate;
		1804	}
		1805
		1806	$self->in_memory (cf::MAP_IN_MEMORY);
1459	}	1807	}
1460		1808
1461	$self->post_load;	1809	$self->post_load;
1462
1463	$self->in_memory (cf::MAP_IN_MEMORY);
1464	}	1810	}
1465		1811
1466	sub customise_for {	1812	sub customise_for {
1467	my ($self, $ob) = @_;	1813	my ($self, $ob) = @_;
1468		1814
1469	return find "~" . $ob->name . "/" . $self->{path}	1815	return find "~" . $ob->name . "/" . $self->{path}
1470	if $self->per_player;	1816	if $self->per_player;
		1817
		1818	# return find "?party/" . $ob->name . "/" . $self->{path}
		1819	# if $self->per_party;
1471		1820
1472	$self	1821	$self
1473	}	1822	}
1474		1823
1475	# find and load all maps in the 3x3 area around a map	1824	# find and load all maps in the 3x3 area around a map
…		…
1586		1935
1587	sub reset_at {	1936	sub reset_at {
1588	my ($self) = @_;	1937	my ($self) = @_;
1589		1938
1590	# TODO: safety, remove and allow resettable per-player maps	1939	# TODO: safety, remove and allow resettable per-player maps
1591	return 1e99 if $self->isa ("ext::map_per_player");#d#
1592	return 1e99 if $self->{deny_reset};	1940	return 1e99 if $self->{deny_reset};
1593		1941
1594	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1942	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1943	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1596		1944
…		…
1607	my ($self) = @_;	1955	my ($self) = @_;
1608		1956
1609	my $lock = cf::lock_acquire "map_data:$self->{path}";	1957	my $lock = cf::lock_acquire "map_data:$self->{path}";
1610		1958
1611	return if $self->players;	1959	return if $self->players;
1612	return if $self->isa ("ext::map_per_player");#d#
1613		1960
1614	warn "resetting map ", $self->path;#d#	1961	warn "resetting map ", $self->path;
1615		1962
1616	$self->in_memory (cf::MAP_SWAPPED);	1963	$self->in_memory (cf::MAP_SWAPPED);
1617		1964
1618	# need to save uniques path	1965	# need to save uniques path
1619	unless ($self->{deny_save}) {	1966	unless ($self->{deny_save}) {
…		…
1651	$cf::MAP{$self->path} = $self;	1998	$cf::MAP{$self->path} = $self;
1652		1999
1653	$self->reset; # polite request, might not happen	2000	$self->reset; # polite request, might not happen
1654	}	2001	}
1655		2002
		2003	=item $maps = cf::map::tmp_maps
		2004
		2005	Returns an arrayref with all map paths of currently instantiated and saved
		2006	maps. May block.
		2007
		2008	=cut
		2009
		2010	sub tmp_maps() {
		2011	[
		2012	map {
		2013	utf8::decode $_;
		2014	/\.map$/
		2015	? normalise $_
		2016	: ()
		2017	} @{ aio_readdir $TMPDIR or [] }
		2018	]
		2019	}
		2020
		2021	=item $maps = cf::map::random_maps
		2022
		2023	Returns an arrayref with all map paths of currently instantiated and saved
		2024	random maps. May block.
		2025
		2026	=cut
		2027
		2028	sub random_maps() {
		2029	[
		2030	map {
		2031	utf8::decode $_;
		2032	/\.map$/
		2033	? normalise "?random/$_"
		2034	: ()
		2035	} @{ aio_readdir $RANDOMDIR or [] }
		2036	]
		2037	}
		2038
1656	=item cf::map::unique_maps	2039	=item cf::map::unique_maps
1657		2040
1658	Returns an arrayref of paths of all shared maps that have	2041	Returns an arrayref of paths of all shared maps that have
1659	instantiated unique items. May block.	2042	instantiated unique items. May block.
1660		2043
1661	=cut	2044	=cut
1662		2045
1663	sub unique_maps() {	2046	sub unique_maps() {
1664	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2047	[
1665	or return;	2048	map {
1666
1667	my @paths;
1668
1669	for (@$files) {
1670	utf8::decode $_;	2049	utf8::decode $_;
1671	next if /\.pst$/;	2050	/\.map$/
1672	next unless /^$PATH_SEP/o;	2051	? normalise $_
1673		2052	: ()
1674	push @paths, cf::map::normalise $_;	2053	} @{ aio_readdir $UNIQUEDIR or [] }
1675	}	2054	]
1676
1677	\@paths
1678	}	2055	}
1679		2056
1680	package cf;	2057	package cf;
1681		2058
1682	=back	2059	=back
…		…
1728		2105
1729	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2106	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730		2107
1731	if ($self->{record_replies}) {	2108	if ($self->{record_replies}) {
1732	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2109	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2110
1733	} else {	2111	} else {
		2112	my $pl = $self->contr;
		2113
		2114	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2115	my $diag = $pl->{npc_dialog};
		2116	$diag->{pl}->ext_reply (
		2117	$diag->{id},
		2118	msgtype => "reply",
		2119	msg => $diag->{pl}->expand_cfpod ($msg),
		2120	add_topics => []
		2121	);
		2122
		2123	} else {
1734	$msg = $npc->name . " says: $msg" if $npc;	2124	$msg = $npc->name . " says: $msg" if $npc;
1735	$self->message ($msg, $flags);	2125	$self->message ($msg, $flags);
		2126	}
1736	}	2127	}
1737	}	2128	}
1738		2129
1739	=item $player_object->may ("access")	2130	=item $player_object->may ("access")
1740		2131
…		…
1788	$self->deactivate_recursive;	2179	$self->deactivate_recursive;
1789		2180
1790	return if UNIVERSAL::isa $self->map, "ext::map_link";	2181	return if UNIVERSAL::isa $self->map, "ext::map_link";
1791		2182
1792	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2183	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793	if $self->map;	2184	if $self->map && $self->map->{path} ne "{link}";
1794		2185
1795	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2186	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1796	}	2187	}
1797		2188
1798	sub cf::object::player::leave_link {	2189	sub cf::object::player::leave_link {
1799	my ($self, $map, $x, $y) = @_;	2190	my ($self, $map, $x, $y) = @_;
		2191
		2192	return unless $self->contr->active;
1800		2193
1801	my $link_pos = delete $self->{_link_pos};	2194	my $link_pos = delete $self->{_link_pos};
1802		2195
1803	unless ($map) {	2196	unless ($map) {
1804	# restore original map position	2197	# restore original map position
…		…
1822	$map->load;	2215	$map->load;
1823	$map->load_diag;	2216	$map->load_diag;
1824		2217
1825	return unless $self->contr->active;	2218	return unless $self->contr->active;
1826	$self->activate_recursive;	2219	$self->activate_recursive;
		2220
		2221	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827	$self->enter_map ($map, $x, $y);	2222	$self->enter_map ($map, $x, $y);
1828	}	2223	}
1829		2224
1830	cf::player->attach (
1831	on_logout => sub {
1832	my ($pl) = @_;
1833
1834	# abort map switching before logout
1835	if ($pl->ob->{_link_pos}) {
1836	cf::sync_job {
1837	$pl->ob->leave_link
1838	};
1839	}
1840	},
1841	on_login => sub {
1842	my ($pl) = @_;
1843
1844	# try to abort aborted map switching on player login :)
1845	# should happen only on crashes
1846	if ($pl->ob->{_link_pos}) {
1847	$pl->ob->enter_link;
1848	(async {
1849	# we need this sleep as the login has a concurrent enter_exit running
1850	# and this sleep increases chances of the player not ending up in scorn
1851	$pl->ob->reply (undef,
1852	"There was an internal problem at your last logout, "
1853	. "the server will try to bring you to your intended destination in a second.",
1854	cf::NDI_RED);
1855	Coro::Timer::sleep 1;
1856	$pl->ob->leave_link;
1857	})->prio (2);
1858	}
1859	},
1860	);
1861
1862	=item $player_object->goto ($path, $x, $y)	2225	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1863		2226
		2227	Moves the player to the given map-path and coordinates by first freezing
		2228	her, loading and preparing them map, calling the provided $check callback
		2229	that has to return the map if sucecssful, and then unfreezes the player on
		2230	the new (success) or old (failed) map position.
		2231
1864	=cut	2232	=cut
		2233
		2234	our $GOTOGEN;
1865		2235
1866	sub cf::object::player::goto {	2236	sub cf::object::player::goto {
1867	my ($self, $path, $x, $y) = @_;	2237	my ($self, $path, $x, $y, $check) = @_;
		2238
		2239	# do generation counting so two concurrent goto's will be executed in-order
		2240	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868		2241
1869	$self->enter_link;	2242	$self->enter_link;
1870		2243
1871	(async {	2244	(async {
1872	my $map = eval {	2245	my $map = eval {
1873	my $map = cf::map::find $path;	2246	my $map = cf::map::find $path;
		2247
		2248	if ($map) {
1874	$map = $map->customise_for ($self) if $map;	2249	$map = $map->customise_for ($self);
		2250	$map = $check->($map) if $check && $map;
		2251	} else {
		2252	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2253	}
		2254
1875	$map	2255	$map
		2256	};
		2257
		2258	if ($@) {
		2259	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2260	LOG llevError | logBacktrace, Carp::longmess $@;
1876	} or	2261	}
1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878		2262
		2263	if ($gen == $self->{_goto_generation}) {
		2264	delete $self->{_goto_generation};
1879	$self->leave_link ($map, $x, $y);	2265	$self->leave_link ($map, $x, $y);
		2266	}
1880	})->prio (1);	2267	})->prio (1);
1881	}	2268	}
1882		2269
1883	=item $player_object->enter_exit ($exit_object)	2270	=item $player_object->enter_exit ($exit_object)
1884		2271
…		…
1923		2310
1924	$rmp->{random_seed} ||= $exit->random_seed;	2311	$rmp->{random_seed} ||= $exit->random_seed;
1925		2312
1926	my $data = cf::to_json $rmp;	2313	my $data = cf::to_json $rmp;
1927	my $md5 = Digest::MD5::md5_hex $data;	2314	my $md5 = Digest::MD5::md5_hex $data;
1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2315	my $meta = "$RANDOMDIR/$md5.meta";
1929		2316
1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2317	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931	aio_write $fh, 0, (length $data), $data, 0;	2318	aio_write $fh, 0, (length $data), $data, 0;
1932	undef $fh;	2319	undef $fh;
1933	aio_rename "$meta~", $meta;	2320	aio_rename "$meta~", $meta;
…		…
1942		2329
1943	return unless $self->type == cf::PLAYER;	2330	return unless $self->type == cf::PLAYER;
1944		2331
1945	if ($exit->slaying eq "/!") {	2332	if ($exit->slaying eq "/!") {
1946	#TODO: this should de-fi-ni-te-ly not be a sync-job	2333	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2334	# the problem is that $exit might not survive long enough
		2335	# so it needs to be done right now, right here
1947	cf::sync_job { prepare_random_map $exit };	2336	cf::sync_job { prepare_random_map $exit };
1948	}	2337	}
1949		2338
1950	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2339	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951	my $hp = $exit->stats->hp;	2340	my $hp = $exit->stats->hp;
…		…
1959	$self->goto ($slaying, $hp, $sp);	2348	$self->goto ($slaying, $hp, $sp);
1960		2349
1961	1;	2350	1;
1962	}) {	2351	}) {
1963	$self->message ("Something went wrong deep within the crossfire server. "	2352	$self->message ("Something went wrong deep within the crossfire server. "
1964	. "I'll try to bring you back to the map you were before. "	2353	. "I'll try to bring you back to the map you were before. "
1965	. "Please report this to the dungeon master!",	2354	. "Please report this to the dungeon master!",
1966	cf::NDI_UNIQUE | cf::NDI_RED);	2355	cf::NDI_UNIQUE | cf::NDI_RED);
1967		2356
1968	warn "ERROR in enter_exit: $@";	2357	warn "ERROR in enter_exit: $@";
1969	$self->leave_link;	2358	$self->leave_link;
1970	}	2359	}
1971	})->prio (1);	2360	})->prio (1);
…		…
1984		2373
1985	sub cf::client::send_drawinfo {	2374	sub cf::client::send_drawinfo {
1986	my ($self, $text, $flags) = @_;	2375	my ($self, $text, $flags) = @_;
1987		2376
1988	utf8::encode $text;	2377	utf8::encode $text;
1989	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2378	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990	}	2379	}
1991		2380
		2381	=item $client->send_msg ($color, $type, $msg, [extra...])
		2382
		2383	Send a drawinfo or msg packet to the client, formatting the msg for the
		2384	client if neccessary. C<$type> should be a string identifying the type of
		2385	the message, with C<log> being the default. If C<$color> is negative, suppress
		2386	the message unless the client supports the msg packet.
		2387
		2388	=cut
		2389
		2390	sub cf::client::send_msg {
		2391	my ($self, $color, $type, $msg, @extra) = @_;
		2392
		2393	$msg = $self->pl->expand_cfpod ($msg);
		2394
		2395	if ($self->can_msg) {
		2396	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2397	} else {
		2398	# replace some tags by gcfclient-compatible ones
		2399	for ($msg) {
		2400	1 while
		2401	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2402	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2403	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2404	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2405	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2406	}
		2407
		2408	if ($color >= 0) {
		2409	if (0 && $msg =~ /\[/) {
		2410	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2411	} else {
		2412	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2413	$self->send_packet ("drawinfo $color $msg")
		2414	}
		2415	}
		2416	}
		2417	}
		2418
		2419	=item $client->ext_event ($type, %msg)
		2420
		2421	Sends an ext event to the client.
		2422
		2423	=cut
		2424
		2425	sub cf::client::ext_event($$%) {
		2426	my ($self, $type, %msg) = @_;
		2427
		2428	$msg{msgtype} = "event_$type";
		2429	$self->send_packet ("ext " . cf::to_json \%msg);
		2430	}
1992		2431
1993	=item $success = $client->query ($flags, "text", \&cb)	2432	=item $success = $client->query ($flags, "text", \&cb)
1994		2433
1995	Queues a query to the client, calling the given callback with	2434	Queues a query to the client, calling the given callback with
1996	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2435	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2436	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998		2437
1999	Queries can fail, so check the return code. Or don't, as queries will become	2438	Queries can fail, so check the return code. Or don't, as queries will
2000	reliable at some point in the future.	2439	become reliable at some point in the future.
2001		2440
2002	=cut	2441	=cut
2003		2442
2004	sub cf::client::query {	2443	sub cf::client::query {
2005	my ($self, $flags, $text, $cb) = @_;	2444	my ($self, $flags, $text, $cb) = @_;
…		…
2013	utf8::encode $text;	2452	utf8::encode $text;
2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2453	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015		2454
2016	$self->send_packet ($self->{query_queue}[0][0])	2455	$self->send_packet ($self->{query_queue}[0][0])
2017	if @{ $self->{query_queue} } == 1;	2456	if @{ $self->{query_queue} } == 1;
		2457
		2458	1
2018	}	2459	}
2019		2460
2020	cf::client->attach (	2461	cf::client->attach (
2021	on_reply => sub {	2462	on_reply => sub {
2022	my ($ns, $msg) = @_;	2463	my ($ns, $msg) = @_;
…		…
2037	} else {	2478	} else {
2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2479	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039	}	2480	}
2040	}	2481	}
2041	},	2482	},
		2483	on_exticmd => sub {
		2484	my ($ns, $buf) = @_;
		2485
		2486	my $msg = eval { from_json $buf };
		2487
		2488	if (ref $msg) {
		2489	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2490	if (my %reply = $cb->($ns, $msg)) {
		2491	$reply{msgid} = $msg->{msgid};
		2492	$ns->send ("ext " . cf::to_json \%reply);
		2493	}
		2494	}
		2495	} else {
		2496	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2497	}
		2498
		2499	cf::override;
		2500	},
2042	);	2501	);
2043		2502
2044	=item $client->async (\&cb)	2503	=item $client->async (\&cb)
2045		2504
2046	Create a new coroutine, running the specified callback. The coroutine will	2505	Create a new coroutine, running the specified callback. The coroutine will
…		…
2093		2552
2094	# here we export the classes and methods available to script code	2553	# here we export the classes and methods available to script code
2095		2554
2096	=pod	2555	=pod
2097		2556
2098	The following fucntions and emthods are available within a safe environment:	2557	The following functions and methods are available within a safe environment:
2099		2558
2100	cf::object contr pay_amount pay_player map	2559	cf::object contr pay_amount pay_player map
2101	cf::object::player player	2560	cf::object::player player
2102	cf::player peaceful	2561	cf::player peaceful
2103	cf::map trigger	2562	cf::map trigger
…		…
2184	=back	2643	=back
2185		2644
2186	=cut	2645	=cut
2187		2646
2188	#############################################################################	2647	#############################################################################
2189
2190	=head2 EXTENSION DATABASE SUPPORT
2191
2192	Crossfire maintains a very simple database for extension use. It can
2193	currently store anything that can be serialised using Storable, which
2194	excludes objects.
2195
2196	The parameter C<$family> should best start with the name of the extension
2197	using it, it should be unique.
2198
2199	=over 4
2200
2201	=item $value = cf::db_get $family => $key
2202
2203	Returns a single value from the database.
2204
2205	=item cf::db_put $family => $key => $value
2206
2207	Stores the given C<$value> in the family.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	sub db_init {
2214	unless ($DB) {
2215	$DB = BDB::db_create $DB_ENV;
2216
2217	cf::sync_job {
2218	eval {
2219	$DB->set_flags (BDB::CHKSUM);
2220
2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223	cf::cleanup "db_open(db): $!" if $!;
2224	};
2225	cf::cleanup "db_open(db): $@" if $@;
2226	};
2227
2228	my $path = cf::localdir . "/database.pst";
2229	if (stat $path) {
2230	cf::sync_job {
2231	my $pst = Storable::retrieve $path;
2232
2233	cf::db_put (board => data => $pst->{board});
2234	cf::db_put (guildrules => data => $pst->{guildrules});
2235	cf::db_put (rent => balance => $pst->{rent}{balance});
2236	BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238	unlink $path;
2239	};
2240	}
2241	}
2242	}
2243
2244	sub db_get($$) {
2245	my $key = "$_[0]/$_[1]";
2246
2247	cf::sync_job {
2248	BDB::db_get $DB, undef, $key, my $data;
2249
2250	$! ? ()
2251	: Compress::LZF::sthaw $data
2252	}
2253	}
2254
2255	sub db_put($$$) {
2256	BDB::dbreq_pri 4;
2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258	}
2259
2260	#############################################################################
2261	# the server's init and main functions	2648	# the server's init and main functions
2262		2649
2263	sub load_resources {	2650	sub load_facedata($) {
2264	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2651	my ($path) = @_;
		2652
		2653	warn "loading facedata from $path\n";
		2654
		2655	my $facedata;
		2656	0 < aio_load $path, $facedata
		2657	or die "$path: $!";
		2658
		2659	$facedata = Coro::Storable::thaw $facedata;
		2660
		2661	$facedata->{version} == 2
		2662	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2663
		2664	{
		2665	my $faces = $facedata->{faceinfo};
		2666
		2667	while (my ($face, $info) = each %$faces) {
		2668	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2669	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2670	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2671	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2672	Coro::cede;
		2673	}
		2674
		2675	while (my ($face, $info) = each %$faces) {
		2676	next unless $info->{smooth};
		2677	my $idx = cf::face::find $face
		2678	or next;
		2679	if (my $smooth = cf::face::find $info->{smooth}) {
		2680	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2681	} else {
		2682	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2683	}
		2684	Coro::cede;
		2685	}
		2686	}
		2687
		2688	{
		2689	my $anims = $facedata->{animinfo};
		2690
		2691	while (my ($anim, $info) = each %$anims) {
		2692	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2693	Coro::cede;
		2694	}
		2695
		2696	cf::anim::invalidate_all; # d'oh
		2697	}
		2698
		2699	1
		2700	}
		2701
		2702	sub reload_regions {
		2703	load_resource_file "$MAPDIR/regions"
2265	or die "unable to load regions file\n";#d#	2704	or die "unable to load regions file\n";
		2705	}
		2706
		2707	sub reload_facedata {
		2708	load_facedata "$DATADIR/facedata"
		2709	or die "unable to load facedata\n";
		2710	}
		2711
		2712	sub reload_archetypes {
		2713	load_resource_file "$DATADIR/archetypes"
		2714	or die "unable to load archetypes\n";
		2715	}
		2716
		2717	sub reload_treasures {
		2718	load_resource_file "$DATADIR/treasures"
		2719	or die "unable to load treasurelists\n";
		2720	}
		2721
		2722	sub reload_resources {
		2723	warn "reloading resource files...\n";
		2724
		2725	reload_regions;
		2726	reload_facedata;
		2727	#reload_archetypes;#d#
		2728	reload_archetypes;
		2729	reload_treasures;
		2730
		2731	warn "finished reloading resource files\n";
		2732	}
		2733
		2734	sub init {
		2735	reload_resources;
2266	}	2736	}
2267		2737
2268	sub cfg_load {	2738	sub cfg_load {
2269	open my $fh, "<:utf8", cf::confdir . "/config"	2739	open my $fh, "<:utf8", "$CONFDIR/config"
2270	or return;	2740	or return;
2271		2741
2272	local $/;	2742	local $/;
2273	*CFG = YAML::Syck::Load <$fh>;	2743	*CFG = YAML::Syck::Load <$fh>;
2274		2744
…		…
2282	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2752	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2283	and die "WARNING: m(un)lockall failed: $!\n";	2753	and die "WARNING: m(un)lockall failed: $!\n";
2284	};	2754	};
2285	warn $@ if $@;	2755	warn $@ if $@;
2286	}	2756	}
2287	}
2288
2289	sub init {
2290	load_resources;
2291	}	2757	}
2292		2758
2293	sub main {	2759	sub main {
2294	# we must not ever block the main coroutine	2760	# we must not ever block the main coroutine
2295	local $Coro::idle = sub {	2761	local $Coro::idle = sub {
…		…
2323	},	2789	},
2324	);	2790	);
2325	}	2791	}
2326	}	2792	}
2327		2793
		2794	sub write_runtime {
		2795	my $runtime = "$LOCALDIR/runtime";
		2796
		2797	# first touch the runtime file to show we are still running:
		2798	# the fsync below can take a very very long time.
		2799
		2800	IO::AIO::aio_utime $runtime, undef, undef;
		2801
		2802	my $guard = cf::lock_acquire "write_runtime";
		2803
		2804	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2805	or return;
		2806
		2807	my $value = $cf::RUNTIME + 90 + 10;
		2808	# 10 is the runtime save interval, for a monotonic clock
		2809	# 60 allows for the watchdog to kill the server.
		2810
		2811	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2812	and return;
		2813
		2814	# always fsync - this file is important
		2815	aio_fsync $fh
		2816	and return;
		2817
		2818	# touch it again to show we are up-to-date
		2819	aio_utime $fh, undef, undef;
		2820
		2821	close $fh
		2822	or return;
		2823
		2824	aio_rename "$runtime~", $runtime
		2825	and return;
		2826
		2827	warn "runtime file written.\n";
		2828
		2829	1
		2830	}
		2831
2328	sub emergency_save() {	2832	sub emergency_save() {
2329	my $freeze_guard = cf::freeze_mainloop;	2833	my $freeze_guard = cf::freeze_mainloop;
2330		2834
2331	warn "enter emergency perl save\n";	2835	warn "enter emergency perl save\n";
2332		2836
…		…
2363		2867
2364	warn Carp::longmess "post_cleanup backtrace"	2868	warn Carp::longmess "post_cleanup backtrace"
2365	if $make_core;	2869	if $make_core;
2366	}	2870	}
2367		2871
2368	sub reload() {	2872	sub do_reload_perl() {
2369	# can/must only be called in main	2873	# can/must only be called in main
2370	if ($Coro::current != $Coro::main) {	2874	if ($Coro::current != $Coro::main) {
2371	warn "can only reload from main coroutine";	2875	warn "can only reload from main coroutine";
2372	return;	2876	return;
2373	}	2877	}
2374		2878
2375	warn "reloading...";	2879	warn "reloading...";
2376		2880
2377	warn "cancelling server ticker";	2881	warn "entering sync_job";
2378	$TICK_WATCHER->cancel;
2379		2882
		2883	cf::sync_job {
		2884	cf::write_runtime; # external watchdog should not bark
2380	cf::emergency_save;	2885	cf::emergency_save;
		2886	cf::write_runtime; # external watchdog should not bark
2381		2887
2382	eval {	2888	warn "syncing database to disk";
		2889	BDB::db_env_txn_checkpoint $DB_ENV;
		2890
2383	# if anything goes wrong in here, we should simply crash as we already saved	2891	# if anything goes wrong in here, we should simply crash as we already saved
2384		2892
2385	warn "cancelling all WF_AUTOCANCEL watchers";	2893	warn "cancelling all WF_AUTOCANCEL watchers";
2386	for (Event::all_watchers) {	2894	for (Event::all_watchers) {
2387	$_->cancel if $_->data & WF_AUTOCANCEL;	2895	$_->cancel if $_->data & WF_AUTOCANCEL;
2388	}	2896	}
2389
2390	warn "syncing database to disk";
2391	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392		2897
2393	warn "flushing outstanding aio requests";	2898	warn "flushing outstanding aio requests";
2394	for (;;) {	2899	for (;;) {
2395	BDB::flush;	2900	BDB::flush;
2396	IO::AIO::flush;	2901	IO::AIO::flush;
2397	Coro::cede;	2902	Coro::cede;
2398	last unless IO::AIO::nreqs || BDB::nreqs;	2903	last unless IO::AIO::nreqs || BDB::nreqs;
2399	warn "iterate...";	2904	warn "iterate...";
2400	}	2905	}
2401		2906
		2907	++$RELOAD;
		2908
2402	warn "cancelling all extension coros";	2909	warn "cancelling all extension coros";
2403	$_->cancel for values %EXT_CORO;	2910	$_->cancel for values %EXT_CORO;
2404	%EXT_CORO = ();	2911	%EXT_CORO = ();
2405		2912
2406	warn "removing commands";	2913	warn "removing commands";
2407	%COMMAND = ();	2914	%COMMAND = ();
2408		2915
2409	warn "removing ext commands";	2916	warn "removing ext/exti commands";
2410	%EXTCMD = ();	2917	%EXTCMD = ();
		2918	%EXTICMD = ();
2411		2919
2412	warn "unloading/nuking all extensions";	2920	warn "unloading/nuking all extensions";
2413	for my $pkg (@EXTS) {	2921	for my $pkg (@EXTS) {
2414	warn "... unloading $pkg";	2922	warn "... unloading $pkg";
2415		2923
…		…
2445	Symbol::delete_package "safe::$_"	2953	Symbol::delete_package "safe::$_"
2446	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2954	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447		2955
2448	warn "unloading cf.pm \"a bit\"";	2956	warn "unloading cf.pm \"a bit\"";
2449	delete $INC{"cf.pm"};	2957	delete $INC{"cf.pm"};
		2958	delete $INC{"cf/pod.pm"};
2450		2959
2451	# don't, removes xs symbols, too,	2960	# don't, removes xs symbols, too,
2452	# and global variables created in xs	2961	# and global variables created in xs
2453	#Symbol::delete_package __PACKAGE__;	2962	#Symbol::delete_package __PACKAGE__;
2454		2963
…		…
2463		2972
2464	warn "loading extensions";	2973	warn "loading extensions";
2465	cf::load_extensions;	2974	cf::load_extensions;
2466		2975
2467	warn "reattaching attachments to objects/players";	2976	warn "reattaching attachments to objects/players";
2468	_global_reattach;	2977	_global_reattach; # objects, sockets
2469	warn "reattaching attachments to maps";	2978	warn "reattaching attachments to maps";
2470	reattach $_ for values %MAP;	2979	reattach $_ for values %MAP;
		2980	warn "reattaching attachments to players";
		2981	reattach $_ for values %PLAYER;
2471		2982
2472	warn "loading reloadable resources";	2983	warn "leaving sync_job";
2473	load_resources;
2474		2984
2475	warn "restarting server ticker";	2985	1
2476		2986	} or do {
2477	$TICK_WATCHER->start;
2478	};
2479
2480	if ($@) {
2481	warn $@;	2987	warn $@;
2482	warn "error while reloading, exiting.";	2988	warn "error while reloading, exiting.";
2483	exit 1;	2989	exit 1;
2484	}	2990	};
2485		2991
2486	warn "reloaded";	2992	warn "reloaded";
2487	};	2993	};
2488		2994
2489	our $RELOAD_WATCHER; # used only during reload	2995	our $RELOAD_WATCHER; # used only during reload
2490		2996
		2997	sub reload_perl() {
		2998	# doing reload synchronously and two reloads happen back-to-back,
		2999	# coro crashes during coro_state_free->destroy here.
		3000
		3001	$RELOAD_WATCHER ||= Event->timer (
		3002	reentrant => 0,
		3003	after => 0,
		3004	data => WF_AUTOCANCEL,
		3005	cb => sub {
		3006	do_reload_perl;
		3007	undef $RELOAD_WATCHER;
		3008	},
		3009	);
		3010	}
		3011
2491	register_command "reload" => sub {	3012	register_command "reload" => sub {
2492	my ($who, $arg) = @_;	3013	my ($who, $arg) = @_;
2493		3014
2494	if ($who->flag (FLAG_WIZ)) {	3015	if ($who->flag (FLAG_WIZ)) {
2495	$who->message ("reloading server.");	3016	$who->message ("reloading server.");
2496		3017	async { reload_perl };
2497	# doing reload synchronously and two reloads happen back-to-back,
2498	# coro crashes during coro_state_free->destroy here.
2499
2500	$RELOAD_WATCHER ||= Event->timer (
2501	reentrant => 0,
2502	after => 0,
2503	data => WF_AUTOCANCEL,
2504	cb => sub {
2505	reload;
2506	undef $RELOAD_WATCHER;
2507	},
2508	);
2509	}	3018	}
2510	};	3019	};
2511		3020
2512	unshift @INC, $LIBDIR;	3021	unshift @INC, $LIBDIR;
2513		3022
2514	my $bug_warning = 0;	3023	my $bug_warning = 0;
2515		3024
		3025	our @WAIT_FOR_TICK;
		3026	our @WAIT_FOR_TICK_BEGIN;
		3027
		3028	sub wait_for_tick {
		3029	return unless $TICK_WATCHER->is_active;
		3030	return if $Coro::current == $Coro::main;
		3031
		3032	my $signal = new Coro::Signal;
		3033	push @WAIT_FOR_TICK, $signal;
		3034	$signal->wait;
		3035	}
		3036
		3037	sub wait_for_tick_begin {
		3038	return unless $TICK_WATCHER->is_active;
		3039	return if $Coro::current == $Coro::main;
		3040
		3041	my $signal = new Coro::Signal;
		3042	push @WAIT_FOR_TICK_BEGIN, $signal;
		3043	$signal->wait;
		3044	}
		3045
		3046	my $min = 1e6;#d#
		3047	my $avg = 10;
2516	$TICK_WATCHER = Event->timer (	3048	$TICK_WATCHER = Event->timer (
2517	reentrant => 0,	3049	reentrant => 0,
2518	parked => 1,	3050	parked => 1,
2519	prio => 0,	3051	prio => 0,
2520	at => $NEXT_TICK || $TICK,	3052	at => $NEXT_TICK || $TICK,
…		…
2524	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3056	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525	unless ++$bug_warning > 10;	3057	unless ++$bug_warning > 10;
2526	return;	3058	return;
2527	}	3059	}
2528		3060
2529	$NOW = Event::time;	3061	$NOW = $tick_start = Event::time;
2530		3062
2531	cf::server_tick; # one server iteration	3063	cf::server_tick; # one server iteration
		3064
		3065	0 && sync_job {#d#
		3066	for(1..10) {
		3067	my $t = Event::time;
		3068	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3069	or die;
		3070
		3071	$map->width (50);
		3072	$map->height (50);
		3073	$map->alloc;
		3074	$map->_load_objects ("/tmp/x.map", 1);
		3075	my $t = Event::time - $t;
		3076
		3077	#next unless $t < 0.0013;#d#
		3078	if ($t < $min) {
		3079	$min = $t;
		3080	}
		3081	$avg = $avg * 0.99 + $t * 0.01;
		3082	}
		3083	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3084	exit 0;
		3085	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3086	};
		3087
2532	$RUNTIME += $TICK;	3088	$RUNTIME += $TICK;
2533	$NEXT_TICK += $TICK;	3089	$NEXT_TICK += $TICK;
2534		3090
2535	$WAIT_FOR_TICK->broadcast;	3091	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3092	$NEXT_RUNTIME_WRITE = $NOW + 10;
2537		3093	Coro::async_pool {
2538	Event::sweep;	3094	write_runtime
2539	Coro::cede_notself;	3095	or warn "ERROR: unable to write runtime file: $!";
		3096	};
2540		3097	}
		3098
2541	# my $AFTER = Event::time;	3099	# my $AFTER = Event::time;
2542	# warn $AFTER - $NOW;#d#	3100	# warn $AFTER - $NOW;#d#
2543		3101
		3102	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3103	$sig->send;
		3104	}
		3105	while (my $sig = shift @WAIT_FOR_TICK) {
		3106	$sig->send;
		3107	}
		3108
		3109	$NOW = Event::time;
		3110
2544	# if we are delayed by four ticks or more, skip them all	3111	# if we are delayed by four ticks or more, skip them all
2545	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3112	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2546		3113
2547	$TICK_WATCHER->at ($NEXT_TICK);	3114	$TICK_WATCHER->at ($NEXT_TICK);
2548	$TICK_WATCHER->start;	3115	$TICK_WATCHER->start;
		3116
		3117	$LOAD = ($NOW - $tick_start) / $TICK;
		3118	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3119
		3120	_post_tick;
		3121
		3122
2549	},	3123	},
2550	);	3124	);
2551		3125
2552	{	3126	{
2553	BDB::max_poll_time $TICK * 0.1;	3127	BDB::max_poll_time $TICK * 0.1;
…		…
2581		3155
2582	cf::sync_job {	3156	cf::sync_job {
2583	eval {	3157	eval {
2584	BDB::db_env_open	3158	BDB::db_env_open
2585	$DB_ENV,	3159	$DB_ENV,
2586	$BDB_ENV_DIR,	3160	$BDBDIR,
2587	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3161	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3162	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589	0666;	3163	0666;
2590		3164
2591	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3165	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592		3166
2593	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3167	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594	$DB_ENV->set_lk_detect;	3168	$DB_ENV->set_lk_detect;
2595	};	3169	};
2596		3170
…		…
2604		3178
2605	undef $Coro::AIO::WATCHER;	3179	undef $Coro::AIO::WATCHER;
2606	IO::AIO::max_poll_time $TICK * 0.1;	3180	IO::AIO::max_poll_time $TICK * 0.1;
2607	$AIO_POLL_WATCHER = Event->io (	3181	$AIO_POLL_WATCHER = Event->io (
2608	reentrant => 0,	3182	reentrant => 0,
		3183	data => WF_AUTOCANCEL,
2609	fd => IO::AIO::poll_fileno,	3184	fd => IO::AIO::poll_fileno,
2610	poll => 'r',	3185	poll => 'r',
2611	prio => 6,	3186	prio => 6,
2612	data => WF_AUTOCANCEL,
2613	cb => \&IO::AIO::poll_cb,	3187	cb => \&IO::AIO::poll_cb,
2614	);	3188	);
2615	}	3189	}
2616		3190
2617	$WRITE_RUNTIME_WATCHER = Event->timer (	3191	my $_log_backtrace;
2618	reentrant => 0,	3192
2619	data => WF_AUTOCANCEL,	3193	sub _log_backtrace {
2620	after => 1,	3194	my ($msg, @addr) = @_;
2621	interval => 10,	3195
2622	prio => 6, # keep it lowest so it acts like a watchdog	3196	$msg =~ s/\n//;
2623	cb => Coro::unblock_sub {	3197
2624	write_runtime	3198	# limit the # of concurrent backtraces
2625	or warn "ERROR: unable to write runtime file: $!";	3199	if ($_log_backtrace < 2) {
		3200	++$_log_backtrace;
		3201	async {
		3202	my @bt = fork_call {
		3203	@addr = map { sprintf "%x", $_ } @addr;
		3204	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3205	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3206	or die "addr2line: $!";
		3207
		3208	my @funcs;
		3209	my @res = <$fh>;
		3210	chomp for @res;
		3211	while (@res) {
		3212	my ($func, $line) = splice @res, 0, 2, ();
		3213	push @funcs, "[$func] $line";
		3214	}
		3215
		3216	@funcs
		3217	};
		3218
		3219	LOG llevInfo, "[ABT] $msg\n";
		3220	LOG llevInfo, "[ABT] $_\n" for @bt;
		3221	--$_log_backtrace;
		3222	};
		3223	} else {
		3224	LOG llevInfo, "[ABT] $msg\n";
		3225	LOG llevInfo, "[ABT] [suppressed]\n";
2626	},	3226	}
2627	);	3227	}
		3228
		3229	# load additional modules
		3230	use cf::pod;
2628		3231
2629	END { cf::emergency_save }	3232	END { cf::emergency_save }
2630		3233
2631	1	3234	1
2632		3235

Diff Legend

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