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.216 by root, Thu Feb 15 14:30:21 2007 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 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 $NEXT_RUNTIME_WRITE; # when should the runtime file be written	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;
…		…
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->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($) {
…		…
266		297
267	Coro::guard {	298	Coro::guard {
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	}
		302	}
		303
		304	sub lock_active($) {
		305	my ($key) = @_;
		306
		307	! ! $LOCK{$key}
271	}	308	}
272		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
…		…
290		327
291	BEGIN { *async = \&Coro::async_pool }	328	BEGIN { *async = \&Coro::async_pool }
292		329
293	=item cf::sync_job { BLOCK }	330	=item cf::sync_job { BLOCK }
294		331
295	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)
296	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
297	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.
298		336
299	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
300	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
301	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
302	fast or be very important.	340	fast or be very important.
…		…
305		343
306	sub sync_job(&) {	344	sub sync_job(&) {
307	my ($job) = @_;	345	my ($job) = @_;
308		346
309	if ($Coro::current == $Coro::main) {	347	if ($Coro::current == $Coro::main) {
		348	my $time = Event::time;
		349
310	# this is the main coro, too bad, we have to block	350	# this is the main coro, too bad, we have to block
311	# till the operation succeeds, freezing the server :/	351	# till the operation succeeds, freezing the server :/
312		352
313	# TODO: use suspend/resume instead	353	# TODO: use suspend/resume instead
314	# (but this is cancel-safe)	354	# (but this is cancel-safe)
…		…
325		365
326	while ($busy) {	366	while ($busy) {
327	Coro::cede or Event::one_event;	367	Coro::cede or Event::one_event;
328	}	368	}
329		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
330	wantarray ? @res : $res[0]	377	wantarray ? @res : $res[0]
331	} else {	378	} else {
332	# we are in another coroutine, how wonderful, everything just works	379	# we are in another coroutine, how wonderful, everything just works
333		380
334	$job->()	381	$job->()
…		…
353	$EXT_CORO{$coro+0} = $coro;	400	$EXT_CORO{$coro+0} = $coro;
354		401
355	$coro	402	$coro
356	}	403	}
357		404
358	sub write_runtime {	405	=item fork_call { }, $args
359	my $runtime = cf::localdir . "/runtime";
360		406
361	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	407	Executes the given code block with the given arguments in a seperate
362	or return;	408	process, returning the results. Everything must be serialisable with
		409	Coro::Storable. May, of course, block. Note that the executed sub may
		410	never block itself or use any form of Event handling.
363		411
364	my $value = $cf::RUNTIME + 90 + 10;	412	=cut
365	# 10 is the runtime save interval, for a monotonic clock
366	# 60 allows for the watchdog to kill the server.
367		413
368	(aio_write $fh, 0, (length $value), $value, 0) <= 0	414	sub fork_call(&@) {
369	and return;	415	my ($cb, @args) = @_;
370		416
371	# always fsync - this file is important	417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
372	aio_fsync $fh	418	# or die "socketpair: $!";
373	and return;	419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
374		421
		422	if (my $pid = fork) {
375	close $fh	423	close $fh2;
376	or return;
377		424
378	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
379	and return;	426	warn "pst<$res>" unless $res =~ /^pst/;
		427	$res = Coro::Storable::thaw $res;
380		428
		429	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		430
		431	Carp::confess $$res unless "ARRAY" eq ref $res;
		432
		433	return wantarray ? @$res : $res->[-1];
		434	} else {
		435	reset_signals;
		436	local $SIG{__WARN__};
		437	local $SIG{__DIE__};
		438	local $Coro::idle;
		439	$Coro::current->prio (Coro::PRIO_MAX);
		440	eval {
		441	close $fh1;
		442
		443	my @res = eval { $cb->(@args) };
		444
		445	open my $fh, ">", \my $buf
		446	or die "fork_call: cannot open fh-to-buf in child : $!";
		447	Storable::store_fd +($@ ? \"$@" : \@res), $fh;
		448	close $fh;
		449
		450	warn "writing ", length $buf;
		451	my $x;
		452	(length $buf) == ($x = syswrite $fh2, $buf)
		453	or warn "error writing ".(length $buf)." != $x\n";
		454	close $fh2;
		455	};
		456
		457	warn $@ if $@;
		458	_exit 0;
381	1	459	}
		460	}
		461
		462	=item $value = cf::db_get $family => $key
		463
		464	Returns a single value from the environment database.
		465
		466	=item cf::db_put $family => $key => $value
		467
		468	Stores the given C<$value> in the family. It can currently store binary
		469	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		470
		471	=cut
		472
		473	our $DB;
		474
		475	sub db_init {
		476	unless ($DB) {
		477	$DB = BDB::db_create $DB_ENV;
		478
		479	cf::sync_job {
		480	eval {
		481	$DB->set_flags (BDB::CHKSUM);
		482
		483	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		484	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		485	cf::cleanup "db_open(db): $!" if $!;
		486	};
		487	cf::cleanup "db_open(db): $@" if $@;
		488	};
		489	}
		490	}
		491
		492	sub db_get($$) {
		493	my $key = "$_[0]/$_[1]";
		494
		495	cf::sync_job {
		496	BDB::db_get $DB, undef, $key, my $data;
		497
		498	$! ? ()
		499	: $data
		500	}
		501	}
		502
		503	sub db_put($$$) {
		504	BDB::dbreq_pri 4;
		505	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		506	}
		507
		508	=item cf::cache $id => [$paths...], $processversion => $process
		509
		510	Generic caching function that returns the value of the resource $id,
		511	caching and regenerating as required.
		512
		513	This function can block.
		514
		515	=cut
		516
		517	sub cache {
		518	my ($id, $src, $processversion, $process) = @_;
		519
		520	my $meta =
		521	join "\x00",
		522	$processversion,
		523	map {
		524	aio_stat $_
		525	and Carp::croak "$_: $!";
		526
		527	($_, (stat _)[7,9])
		528	} @$src;
		529
		530	my $dbmeta = db_get cache => "$id/meta";
		531	if ($dbmeta ne $meta) {
		532	# changed, we may need to process
		533
		534	my @data;
		535	my $md5;
		536
		537	for (0 .. $#$src) {
		538	0 <= aio_load $src->[$_], $data[$_]
		539	or Carp::croak "$src->[$_]: $!";
		540	}
		541
		542	# if processing is expensive, check
		543	# checksum first
		544	if (1) {
		545	$md5 =
		546	join "\x00",
		547	$processversion,
		548	map {
		549	Coro::cede;
		550	($src->[$_], Digest::MD5::md5_hex $data[$_])
		551	} 0.. $#$src;
		552
		553
		554	my $dbmd5 = db_get cache => "$id/md5";
		555	if ($dbmd5 eq $md5) {
		556	db_put cache => "$id/meta", $meta;
		557
		558	return db_get cache => "$id/data";
		559	}
		560	}
		561
		562	my $t1 = Time::HiRes::time;
		563	my $data = $process->(\@data);
		564	my $t2 = Time::HiRes::time;
		565
		566	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		567
		568	db_put cache => "$id/data", $data;
		569	db_put cache => "$id/md5" , $md5;
		570	db_put cache => "$id/meta", $meta;
		571
		572	return $data;
		573	}
		574
		575	db_get cache => "$id/data"
		576	}
		577
		578	=item cf::datalog type => key => value, ...
		579
		580	Log a datalog packet of the given type with the given key-value pairs.
		581
		582	=cut
		583
		584	sub datalog($@) {
		585	my ($type, %kv) = @_;
		586	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
382	}	587	}
383		588
384	=back	589	=back
385		590
386	=cut	591	=cut
…		…
393	attach callbacks/event handlers (a collection of which is called an "attachment")	598	attach callbacks/event handlers (a collection of which is called an "attachment")
394	to it. All such attachable objects support the following methods.	599	to it. All such attachable objects support the following methods.
395		600
396	In the following description, CLASS can be any of C<global>, C<object>	601	In the following description, CLASS can be any of C<global>, C<object>
397	C<player>, C<client> or C<map> (i.e. the attachable objects in	602	C<player>, C<client> or C<map> (i.e. the attachable objects in
398	crossfire+).	603	Crossfire TRT).
399		604
400	=over 4	605	=over 4
401		606
402	=item $attachable->attach ($attachment, key => $value...)	607	=item $attachable->attach ($attachment, key => $value...)
403		608
…		…
566	$registry = $CB_TYPE[$object_type] ||= [];	771	$registry = $CB_TYPE[$object_type] ||= [];
567		772
568	} elsif ($type eq "subtype") {	773	} elsif ($type eq "subtype") {
569	defined $object_type or Carp::croak "subtype specified without type";	774	defined $object_type or Carp::croak "subtype specified without type";
570	my $object_subtype = shift @arg;	775	my $object_subtype = shift @arg;
571	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	776	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
572		777
573	} elsif ($type eq "package") {	778	} elsif ($type eq "package") {
574	my $pkg = shift @arg;	779	my $pkg = shift @arg;
575		780
576	while (my ($name, $id) = each %cb_id) {	781	while (my ($name, $id) = each %cb_id) {
…		…
605	_attach $registry, $klass, @attach;	810	_attach $registry, $klass, @attach;
606	}	811	}
607		812
608	$obj->{$name} = \%arg;	813	$obj->{$name} = \%arg;
609	} else {	814	} else {
610	warn "object uses attachment '$name' that is not available, postponing.\n";	815	warn "object uses attachment '$name' which is not available, postponing.\n";
611	}	816	}
612		817
613	$obj->{_attachment}{$name} = undef;	818	$obj->{_attachment}{$name} = undef;
614	}	819	}
615		820
…		…
617	if (ref $_[0]) {	822	if (ref $_[0]) {
618	_object_attach @_;	823	_object_attach @_;
619	} else {	824	} else {
620	_attach shift->_attach_registry, @_;	825	_attach shift->_attach_registry, @_;
621	}	826	}
		827	_recalc_want;
622	};	828	};
623		829
624	# all those should be optimised	830	# all those should be optimised
625	sub cf::attachable::detach {	831	sub cf::attachable::detach {
626	my ($obj, $name) = @_;	832	my ($obj, $name) = @_;
…		…
629	delete $obj->{_attachment}{$name};	835	delete $obj->{_attachment}{$name};
630	reattach ($obj);	836	reattach ($obj);
631	} else {	837	} else {
632	Carp::croak "cannot, currently, detach class attachments";	838	Carp::croak "cannot, currently, detach class attachments";
633	}	839	}
		840	_recalc_want;
634	};	841	};
635		842
636	sub cf::attachable::attached {	843	sub cf::attachable::attached {
637	my ($obj, $name) = @_;	844	my ($obj, $name) = @_;
638		845
…		…
811	or return;	1018	or return;
812	$av = eval { (Storable::thaw $av)->{objs} };	1019	$av = eval { (Storable::thaw $av)->{objs} };
813	}	1020	}
814		1021
815	warn sprintf "loading %s (%d)\n",	1022	warn sprintf "loading %s (%d)\n",
816	$filename, length $data, scalar @{$av || []};#d#	1023	$filename, length $data, scalar @{$av || []};
817	return ($data, $av);	1024	return ($data, $av);
818	}	1025	}
		1026
		1027	=head2 COMMAND CALLBACKS
		1028
		1029	=over 4
		1030
		1031	=cut
819		1032
820	#############################################################################	1033	#############################################################################
821	# command handling &c	1034	# command handling &c
822		1035
823	=item cf::register_command $name => \&callback($ob,$args);	1036	=item cf::register_command $name => \&callback($ob,$args);
…		…
836	push @{ $COMMAND{$name} }, [$caller, $cb];	1049	push @{ $COMMAND{$name} }, [$caller, $cb];
837	}	1050	}
838		1051
839	=item cf::register_extcmd $name => \&callback($pl,$packet);	1052	=item cf::register_extcmd $name => \&callback($pl,$packet);
840		1053
841	Register a callbackf ro execution when the client sends an extcmd packet.	1054	Register a callback for execution when the client sends an (synchronous)
		1055	extcmd packet. Ext commands will be processed in the order they are
		1056	received by the server, like other user commands. The first argument is
		1057	the logged-in player. Ext commands can only be processed after a player
		1058	has logged in successfully.
842		1059
843	If the callback returns something, it is sent back as if reply was being	1060	If the callback returns something, it is sent back as if reply was being
844	called.	1061	called.
845		1062
		1063	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1064
		1065	Register a callback for execution when the client sends an (asynchronous)
		1066	exticmd packet. Exti commands are processed by the server as soon as they
		1067	are received, i.e. out of order w.r.t. other commands. The first argument
		1068	is a client socket. Exti commands can be received anytime, even before
		1069	log-in.
		1070
		1071	If the callback returns something, it is sent back as if reply was being
		1072	called.
		1073
846	=cut	1074	=cut
847		1075
848	sub register_extcmd {	1076	sub register_extcmd {
849	my ($name, $cb) = @_;	1077	my ($name, $cb) = @_;
850		1078
851	$EXTCMD{$name} = $cb;	1079	$EXTCMD{$name} = $cb;
		1080	}
		1081
		1082	sub register_exticmd {
		1083	my ($name, $cb) = @_;
		1084
		1085	$EXTICMD{$name} = $cb;
852	}	1086	}
853		1087
854	cf::player->attach (	1088	cf::player->attach (
855	on_command => sub {	1089	on_command => sub {
856	my ($pl, $name, $params) = @_;	1090	my ($pl, $name, $params) = @_;
…		…
865	cf::override;	1099	cf::override;
866	},	1100	},
867	on_extcmd => sub {	1101	on_extcmd => sub {
868	my ($pl, $buf) = @_;	1102	my ($pl, $buf) = @_;
869		1103
870	my $msg = eval { from_json $buf };	1104	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871		1105
872	if (ref $msg) {	1106	if (ref $msg) {
873	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1107	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
874	if (my %reply = $cb->($pl, $msg)) {	1108	if (my %reply = $cb->($pl, $msg)) {
875	$pl->ext_reply ($msg->{msgid}, %reply);	1109	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
881		1115
882	cf::override;	1116	cf::override;
883	},	1117	},
884	);	1118	);
885		1119
886	sub load_extension {
887	my ($path) = @_;
888
889	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
890	my $base = $1;
891	my $pkg = $1;
892	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "ext::$pkg";
894
895	warn "... loading '$path' into '$pkg'\n";
896
897	open my $fh, "<:utf8", $path
898	or die "$path: $!";
899
900	my $source =
901	"package $pkg; use strict; use utf8;\n"
902	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })
904	. "\n};\n1";
905
906	unless (eval $source) {
907	my $msg = $@ ? "$path: $@\n"
908	: "extension disabled.\n";
909	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910	warn $@;
911	warn "mandatory extension failed to load, exiting.\n";
912	exit 1;
913	}
914	die $@;
915	}
916
917	push @EXTS, $pkg;
918	}
919
920	sub load_extensions {	1120	sub load_extensions {
		1121	cf::sync_job {
		1122	my %todo;
		1123
921	for my $ext (<$LIBDIR/*.ext>) {	1124	for my $path (<$LIBDIR/*.ext>) {
922	next unless -r $ext;	1125	next unless -r $path;
923	eval {	1126
924	load_extension $ext;	1127	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1128	my $base = $1;
		1129	my $pkg = $1;
		1130	$pkg =~ s/[^[:word:]]/_/g;
		1131	$pkg = "ext::$pkg";
		1132
		1133	open my $fh, "<:utf8", $path
		1134	or die "$path: $!";
		1135
		1136	my $source = do { local $/; <$fh> };
		1137
		1138	my %ext = (
		1139	path => $path,
		1140	base => $base,
		1141	pkg => $pkg,
		1142	);
		1143
		1144	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1145	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1146
		1147	$ext{source} =
		1148	"package $pkg; use strict; use utf8;\n"
		1149	. "#line 1 \"$path\"\n{\n"
		1150	. $source
		1151	. "\n};\n1";
		1152
		1153	$todo{$base} = \%ext;
		1154	}
		1155
		1156	my %done;
		1157	while (%todo) {
		1158	my $progress;
		1159
		1160	while (my ($k, $v) = each %todo) {
		1161	for (split /,\s*/, $v->{meta}{depends}) {
		1162	goto skip
		1163	unless exists $done{$_};
		1164	}
		1165
		1166	warn "... loading '$k' into '$v->{pkg}'\n";
		1167
		1168	unless (eval $v->{source}) {
		1169	my $msg = $@ ? "$v->{path}: $@\n"
		1170	: "$v->{base}: extension inactive.\n";
		1171
		1172	if (exists $v->{meta}{mandatory}) {
		1173	warn $msg;
		1174	warn "mandatory extension failed to load, exiting.\n";
		1175	exit 1;
		1176	}
		1177
		1178	warn $msg;
		1179	}
		1180
		1181	$done{$k} = delete $todo{$k};
		1182	push @EXTS, $v->{pkg};
		1183	$progress = 1;
925	1	1184	}
926	} or warn "$ext not loaded: $@";	1185
		1186	skip:
		1187	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1188	unless $progress;
		1189	}
927	}	1190	};
928	}	1191	}
929		1192
930	#############################################################################	1193	#############################################################################
931		1194
		1195	=back
		1196
932	=head2 CORE EXTENSIONS	1197	=head2 CORE EXTENSIONS
933		1198
934	Functions and methods that extend core crossfire objects.	1199	Functions and methods that extend core crossfire objects.
935		1200
936	=cut	1201	=cut
…		…
948	Returns the given player object, loading it if necessary (might block).	1213	Returns the given player object, loading it if necessary (might block).
949		1214
950	=cut	1215	=cut
951		1216
952	sub playerdir($) {	1217	sub playerdir($) {
953	cf::localdir	1218	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1219	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1220	}
959		1221
960	sub path($) {	1222	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1223	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1224
963	(playerdir $login) . "/$login.pl"	1225	(playerdir $login) . "/playerdata"
964	}	1226	}
965		1227
966	sub find_active($) {	1228	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1229	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1230	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1243	my $login = $_[0];
982		1244
983	my $guard = cf::lock_acquire "user_find:$login";	1245	my $guard = cf::lock_acquire "user_find:$login";
984		1246
985	$cf::PLAYER{$_[0]} || do {	1247	$cf::PLAYER{$_[0]} || do {
		1248	# rename old playerfiles to new ones
		1249	#TODO: remove when no longer required
		1250	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1251	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1252	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1253	aio_unlink +(playerdir $login) . "/$login.pl";
		1254
986	my $pl = load_pl path $login	1255	my $pl = load_pl path $login
987	or return;	1256	or return;
988	$cf::PLAYER{$login} = $pl	1257	$cf::PLAYER{$login} = $pl
989	}	1258	}
990	}	1259	}
…		…
1027		1296
1028	=cut	1297	=cut
1029		1298
1030	sub quit_character {	1299	sub quit_character {
1031	my ($pl) = @_;	1300	my ($pl) = @_;
		1301
		1302	my $name = $pl->ob->name;
1032		1303
1033	$pl->{deny_save} = 1;	1304	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1305	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1306
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1307	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1312	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1313	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1314	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1315	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1316	$pl->destroy;
		1317
		1318	my $prefix = qr<^~\Q$name\E/>;
		1319
		1320	# nuke player maps
		1321	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1322
1046	IO::AIO::aio_rmtree $temp;	1323	IO::AIO::aio_rmtree $temp;
		1324	}
		1325
		1326	=item $pl->kick
		1327
		1328	Kicks a player out of the game. This destroys the connection.
		1329
		1330	=cut
		1331
		1332	sub kick {
		1333	my ($pl, $kicker) = @_;
		1334
		1335	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1336	$pl->killer ("kicked");
		1337	$pl->ns->destroy;
1047	}	1338	}
1048		1339
1049	=item cf::player::list_logins	1340	=item cf::player::list_logins
1050		1341
1051	Returns am arrayref of all valid playernames in the system, can take a	1342	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1343	while and may block, so not sync_job-capable, ever.
1053		1344
1054	=cut	1345	=cut
1055		1346
1056	sub list_logins {	1347	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1348	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1349	or return [];
1059		1350
1060	my @logins;	1351	my @logins;
1061		1352
1062	for my $login (@$dirs) {	1353	for my $login (@$dirs) {
…		…
1097	}	1388	}
1098		1389
1099	\@paths	1390	\@paths
1100	}	1391	}
1101		1392
		1393	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1394
		1395	Expand crossfire pod fragments into protocol xml.
		1396
		1397	=cut
		1398
		1399	sub expand_cfpod {
		1400	((my $self), (local $_)) = @_;
		1401
		1402	# escape & and <
		1403	s/&/&amp;/g;
		1404	s/(?<![BIUGH])</&lt;/g;
		1405
		1406	# this is buggy, it needs to properly take care of nested <'s
		1407
		1408	1 while
		1409	# replace B<>, I<>, U<> etc.
		1410	s/B<([^\>]*)>/<b>$1<\/b>/
		1411	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1412	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1413	# replace G<male|female> tags
		1414	|| s{G<([^>|]*)\|([^>]*)>}{
		1415	$self->gender ? $2 : $1
		1416	}ge
		1417	# replace H<hint text>
		1418	|| s{H<([^\>]*)>}
		1419	{
		1420	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1421	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1422	"")
		1423	[$self->{hintmode}]
		1424	}ge;
		1425
		1426	# create single paragraphs (very hackish)
		1427	s/(?<=\S)\n(?=\w)/ /g;
		1428
		1429	# compress some whitespace
		1430	s/\s+\n/\n/g; # ws line-ends
		1431	s/\n\n+/\n/g; # double lines
		1432	s/^\n+//; # beginning lines
		1433	s/\n+$//; # ending lines
		1434
		1435	$_
		1436	}
		1437
		1438	sub hintmode {
		1439	$_[0]{hintmode} = $_[1] if @_ > 1;
		1440	$_[0]{hintmode}
		1441	}
		1442
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1443	=item $player->ext_reply ($msgid, %msg)
1103		1444
1104	Sends an ext reply to the player.	1445	Sends an ext reply to the player.
1105		1446
1106	=cut	1447	=cut
1107		1448
1108	sub ext_reply($$$%) {	1449	sub ext_reply($$%) {
1109	my ($self, $id, %msg) = @_;	1450	my ($self, $id, %msg) = @_;
1110		1451
1111	$msg{msgid} = $id;	1452	$msg{msgid} = $id;
1112		1453	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1113	$self->send ("ext " . cf::to_json \%msg);
1114	}	1454	}
1115		1455
1116	package cf;	1456	=item $player->ext_event ($type, %msg)
		1457
		1458	Sends an ext event to the client.
		1459
		1460	=cut
		1461
		1462	sub ext_event($$%) {
		1463	my ($self, $type, %msg) = @_;
		1464
		1465	$self->ns->ext_event ($type, %msg);
		1466	}
		1467
		1468	=head3 cf::region
		1469
		1470	=over 4
		1471
		1472	=cut
		1473
		1474	package cf::region;
		1475
		1476	=item cf::region::find_by_path $path
		1477
		1478	Tries to decuce the likely region for a map knowing only its path.
		1479
		1480	=cut
		1481
		1482	sub find_by_path($) {
		1483	my ($path) = @_;
		1484
		1485	my ($match, $specificity);
		1486
		1487	for my $region (list) {
		1488	if ($region->match && $path =~ $region->match) {
		1489	($match, $specificity) = ($region, $region->specificity)
		1490	if $region->specificity > $specificity;
		1491	}
		1492	}
		1493
		1494	$match
		1495	}
1117		1496
1118	=back	1497	=back
1119
1120		1498
1121	=head3 cf::map	1499	=head3 cf::map
1122		1500
1123	=over 4	1501	=over 4
1124		1502
…		…
1179	my ($self, $merge) = @_;	1557	my ($self, $merge) = @_;
1180		1558
1181	# we have to keep some variables in memory intact	1559	# we have to keep some variables in memory intact
1182	local $self->{path};	1560	local $self->{path};
1183	local $self->{load_path};	1561	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1562
1187	$self->SUPER::thawer_merge ($merge);	1563	$self->SUPER::thawer_merge ($merge);
1188	}	1564	}
1189		1565
1190	sub normalise {	1566	sub normalise {
…		…
1262		1638
1263	# the original (read-only) location	1639	# the original (read-only) location
1264	sub load_path {	1640	sub load_path {
1265	my ($self) = @_;	1641	my ($self) = @_;
1266		1642
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1643	"$MAPDIR/$self->{path}.map"
1268	}	1644	}
1269		1645
1270	# the temporary/swap location	1646	# the temporary/swap location
1271	sub save_path {	1647	sub save_path {
1272	my ($self) = @_;	1648	my ($self) = @_;
1273		1649
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1650	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1651	"$TMPDIR/$path.map"
1276	}	1652	}
1277		1653
1278	# the unique path, undef == no special unique path	1654	# the unique path, undef == no special unique path
1279	sub uniq_path {	1655	sub uniq_path {
1280	my ($self) = @_;	1656	my ($self) = @_;
1281		1657
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1658	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1659	"$UNIQUEDIR/$path"
1284	}	1660	}
1285		1661
1286	# and all this just because we cannot iterate over	1662	# and all this just because we cannot iterate over
1287	# all maps in C++...	1663	# all maps in C++...
1288	sub change_all_map_light {	1664	sub change_all_map_light {
1289	my ($change) = @_;	1665	my ($change) = @_;
1290		1666
1291	$_->change_map_light ($change)	1667	$_->change_map_light ($change)
1292	for grep $_->outdoor, values %cf::MAP;	1668	for grep $_->outdoor, values %cf::MAP;
		1669	}
		1670
		1671	sub decay_objects {
		1672	my ($self) = @_;
		1673
		1674	return if $self->{deny_reset};
		1675
		1676	$self->do_decay_objects;
1293	}	1677	}
1294		1678
1295	sub unlink_save {	1679	sub unlink_save {
1296	my ($self) = @_;	1680	my ($self) = @_;
1297		1681
…		…
1355	$self->load_header_orig	1739	$self->load_header_orig
1356	or return;	1740	or return;
1357	$self->prepare_orig;	1741	$self->prepare_orig;
1358	}	1742	}
1359		1743
		1744	$self->{deny_reset} = 1
		1745	if $self->no_reset;
		1746
		1747	$self->default_region (cf::region::find_by_path $self->{path})
		1748	unless $self->default_region;
		1749
1360	1	1750	1
1361	}	1751	}
1362		1752
1363	sub find;	1753	sub find;
1364	sub find {	1754	sub find {
…		…
1376	$map->{last_save} = $cf::RUNTIME;	1766	$map->{last_save} = $cf::RUNTIME;
1377		1767
1378	$map->load_header	1768	$map->load_header
1379	or return;	1769	or return;
1380		1770
1381	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1771	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1382	# doing this can freeze the server in a sync job, obviously	1772	# doing this can freeze the server in a sync job, obviously
1383	#$cf::WAIT_FOR_TICK->wait;	1773	#$cf::WAIT_FOR_TICK->wait;
1384	$map->reset;	1774	$map->reset;
1385	undef $guard;	1775	undef $guard;
1386	return find $path;	1776	return find $path;
…		…
1397	my ($self) = @_;	1787	my ($self) = @_;
1398		1788
1399	local $self->{deny_reset} = 1; # loading can take a long time	1789	local $self->{deny_reset} = 1; # loading can take a long time
1400		1790
1401	my $path = $self->{path};	1791	my $path = $self->{path};
		1792
		1793	{
1402	my $guard = cf::lock_acquire "map_load:$path";	1794	my $guard = cf::lock_acquire "map_load:$path";
1403		1795
1404	return if $self->in_memory != cf::MAP_SWAPPED;	1796	return if $self->in_memory != cf::MAP_SWAPPED;
1405		1797
1406	$self->in_memory (cf::MAP_LOADING);	1798	$self->in_memory (cf::MAP_LOADING);
1407		1799
1408	$self->alloc;	1800	$self->alloc;
1409		1801
1410	$self->pre_load;	1802	$self->pre_load;
1411
1412	$self->_load_objects ($self->{load_path}, 1)
1413	or return;
1414
1415	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1416	if delete $self->{load_original};
1417
1418	if (my $uniq = $self->uniq_path) {
1419	utf8::encode $uniq;
1420	if (aio_open $uniq, O_RDONLY, 0) {
1421	$self->clear_unique_items;
1422	$self->_load_objects ($uniq, 0);
1423	}
1424	}
1425
1426	Coro::cede;
1427
1428	# now do the right thing for maps
1429	$self->link_multipart_objects;
1430
1431	unless ($self->{deny_activate}) {
1432	$self->decay_objects;
1433	$self->fix_auto_apply;
1434	$self->update_buttons;
1435	Coro::cede;	1803	Coro::cede;
1436	$self->set_darkness_map;	1804
		1805	$self->_load_objects ($self->{load_path}, 1)
		1806	or return;
		1807
		1808	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1809	if delete $self->{load_original};
		1810
		1811	if (my $uniq = $self->uniq_path) {
		1812	utf8::encode $uniq;
		1813	if (aio_open $uniq, O_RDONLY, 0) {
		1814	$self->clear_unique_items;
		1815	$self->_load_objects ($uniq, 0);
		1816	}
		1817	}
		1818
		1819	Coro::cede;
		1820	# now do the right thing for maps
		1821	$self->link_multipart_objects;
1437	$self->difficulty ($self->estimate_difficulty)	1822	$self->difficulty ($self->estimate_difficulty)
1438	unless $self->difficulty;	1823	unless $self->difficulty;
1439	Coro::cede;	1824	Coro::cede;
		1825
		1826	unless ($self->{deny_activate}) {
		1827	$self->decay_objects;
		1828	$self->fix_auto_apply;
		1829	$self->update_buttons;
		1830	Coro::cede;
		1831	$self->set_darkness_map;
		1832	Coro::cede;
1440	$self->activate;	1833	$self->activate;
		1834	}
		1835
		1836	$self->in_memory (cf::MAP_IN_MEMORY);
1441	}	1837	}
1442		1838
1443	$self->post_load;	1839	$self->post_load;
1444
1445	$self->in_memory (cf::MAP_IN_MEMORY);
1446	}	1840	}
1447		1841
1448	sub customise_for {	1842	sub customise_for {
1449	my ($self, $ob) = @_;	1843	my ($self, $ob) = @_;
1450		1844
1451	return find "~" . $ob->name . "/" . $self->{path}	1845	return find "~" . $ob->name . "/" . $self->{path}
1452	if $self->per_player;	1846	if $self->per_player;
		1847
		1848	# return find "?party/" . $ob->name . "/" . $self->{path}
		1849	# if $self->per_party;
1453		1850
1454	$self	1851	$self
1455	}	1852	}
1456		1853
1457	# find and load all maps in the 3x3 area around a map	1854	# find and load all maps in the 3x3 area around a map
…		…
1568		1965
1569	sub reset_at {	1966	sub reset_at {
1570	my ($self) = @_;	1967	my ($self) = @_;
1571		1968
1572	# TODO: safety, remove and allow resettable per-player maps	1969	# TODO: safety, remove and allow resettable per-player maps
1573	return 1e99 if $self->isa ("ext::map_per_player");#d#
1574	return 1e99 if $self->{deny_reset};	1970	return 1e99 if $self->{deny_reset};
1575		1971
1576	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1972	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1577	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1973	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1578		1974
…		…
1589	my ($self) = @_;	1985	my ($self) = @_;
1590		1986
1591	my $lock = cf::lock_acquire "map_data:$self->{path}";	1987	my $lock = cf::lock_acquire "map_data:$self->{path}";
1592		1988
1593	return if $self->players;	1989	return if $self->players;
1594	return if $self->isa ("ext::map_per_player");#d#
1595		1990
1596	warn "resetting map ", $self->path;#d#	1991	warn "resetting map ", $self->path;
1597		1992
1598	$self->in_memory (cf::MAP_SWAPPED);	1993	$self->in_memory (cf::MAP_SWAPPED);
1599		1994
1600	# need to save uniques path	1995	# need to save uniques path
1601	unless ($self->{deny_save}) {	1996	unless ($self->{deny_save}) {
…		…
1633	$cf::MAP{$self->path} = $self;	2028	$cf::MAP{$self->path} = $self;
1634		2029
1635	$self->reset; # polite request, might not happen	2030	$self->reset; # polite request, might not happen
1636	}	2031	}
1637		2032
		2033	=item $maps = cf::map::tmp_maps
		2034
		2035	Returns an arrayref with all map paths of currently instantiated and saved
		2036	maps. May block.
		2037
		2038	=cut
		2039
		2040	sub tmp_maps() {
		2041	[
		2042	map {
		2043	utf8::decode $_;
		2044	/\.map$/
		2045	? normalise $_
		2046	: ()
		2047	} @{ aio_readdir $TMPDIR or [] }
		2048	]
		2049	}
		2050
		2051	=item $maps = cf::map::random_maps
		2052
		2053	Returns an arrayref with all map paths of currently instantiated and saved
		2054	random maps. May block.
		2055
		2056	=cut
		2057
		2058	sub random_maps() {
		2059	[
		2060	map {
		2061	utf8::decode $_;
		2062	/\.map$/
		2063	? normalise "?random/$_"
		2064	: ()
		2065	} @{ aio_readdir $RANDOMDIR or [] }
		2066	]
		2067	}
		2068
1638	=item cf::map::unique_maps	2069	=item cf::map::unique_maps
1639		2070
1640	Returns an arrayref of paths of all shared maps that have	2071	Returns an arrayref of paths of all shared maps that have
1641	instantiated unique items. May block.	2072	instantiated unique items. May block.
1642		2073
1643	=cut	2074	=cut
1644		2075
1645	sub unique_maps() {	2076	sub unique_maps() {
1646	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2077	[
1647	or return;	2078	map {
1648
1649	my @paths;
1650
1651	for (@$files) {
1652	utf8::decode $_;	2079	utf8::decode $_;
1653	next if /\.pst$/;	2080	/\.map$/
1654	next unless /^$PATH_SEP/o;	2081	? normalise $_
1655		2082	: ()
1656	push @paths, cf::map::normalise $_;	2083	} @{ aio_readdir $UNIQUEDIR or [] }
1657	}	2084	]
1658
1659	\@paths
1660	}	2085	}
1661		2086
1662	package cf;	2087	package cf;
1663		2088
1664	=back	2089	=back
…		…
1710		2135
1711	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2136	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1712		2137
1713	if ($self->{record_replies}) {	2138	if ($self->{record_replies}) {
1714	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2139	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2140
1715	} else {	2141	} else {
		2142	my $pl = $self->contr;
		2143
		2144	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2145	my $diag = $pl->{npc_dialog};
		2146	$diag->{pl}->ext_reply (
		2147	$diag->{id},
		2148	msgtype => "reply",
		2149	msg => $diag->{pl}->expand_cfpod ($msg),
		2150	add_topics => []
		2151	);
		2152
		2153	} else {
1716	$msg = $npc->name . " says: $msg" if $npc;	2154	$msg = $npc->name . " says: $msg" if $npc;
1717	$self->message ($msg, $flags);	2155	$self->message ($msg, $flags);
		2156	}
1718	}	2157	}
1719	}	2158	}
1720		2159
1721	=item $player_object->may ("access")	2160	=item $player_object->may ("access")
1722		2161
…		…
1770	$self->deactivate_recursive;	2209	$self->deactivate_recursive;
1771		2210
1772	return if UNIVERSAL::isa $self->map, "ext::map_link";	2211	return if UNIVERSAL::isa $self->map, "ext::map_link";
1773		2212
1774	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2213	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1775	if $self->map;	2214	if $self->map && $self->map->{path} ne "{link}";
1776		2215
1777	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2216	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1778	}	2217	}
1779		2218
1780	sub cf::object::player::leave_link {	2219	sub cf::object::player::leave_link {
1781	my ($self, $map, $x, $y) = @_;	2220	my ($self, $map, $x, $y) = @_;
		2221
		2222	return unless $self->contr->active;
1782		2223
1783	my $link_pos = delete $self->{_link_pos};	2224	my $link_pos = delete $self->{_link_pos};
1784		2225
1785	unless ($map) {	2226	unless ($map) {
1786	# restore original map position	2227	# restore original map position
…		…
1809		2250
1810	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2251	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1811	$self->enter_map ($map, $x, $y);	2252	$self->enter_map ($map, $x, $y);
1812	}	2253	}
1813		2254
1814	cf::player->attach (
1815	on_logout => sub {
1816	my ($pl) = @_;
1817
1818	# abort map switching before logout
1819	if ($pl->ob->{_link_pos}) {
1820	cf::sync_job {
1821	$pl->ob->leave_link
1822	};
1823	}
1824	},
1825	on_login => sub {
1826	my ($pl) = @_;
1827
1828	# try to abort aborted map switching on player login :)
1829	# should happen only on crashes
1830	if ($pl->ob->{_link_pos}) {
1831	$pl->ob->enter_link;
1832	(async {
1833	$pl->ob->reply (undef,
1834	"There was an internal problem at your last logout, "
1835	. "the server will try to bring you to your intended destination in a second.",
1836	cf::NDI_RED);
1837	# we need this sleep as the login has a concurrent enter_exit running
1838	# and this sleep increases chances of the player not ending up in scorn
1839	Coro::Timer::sleep 1;
1840	$pl->ob->leave_link;
1841	})->prio (2);
1842	}
1843	},
1844	);
1845
1846	=item $player_object->goto ($path, $x, $y)	2255	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1847		2256
		2257	Moves the player to the given map-path and coordinates by first freezing
		2258	her, loading and preparing them map, calling the provided $check callback
		2259	that has to return the map if sucecssful, and then unfreezes the player on
		2260	the new (success) or old (failed) map position.
		2261
1848	=cut	2262	=cut
		2263
		2264	our $GOTOGEN;
1849		2265
1850	sub cf::object::player::goto {	2266	sub cf::object::player::goto {
1851	my ($self, $path, $x, $y) = @_;	2267	my ($self, $path, $x, $y, $check) = @_;
		2268
		2269	# do generation counting so two concurrent goto's will be executed in-order
		2270	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1852		2271
1853	$self->enter_link;	2272	$self->enter_link;
1854		2273
1855	(async {	2274	(async {
1856	my $map = eval {	2275	my $map = eval {
1857	my $map = cf::map::find $path;	2276	my $map = cf::map::find $path;
		2277
		2278	if ($map) {
1858	$map = $map->customise_for ($self) if $map;	2279	$map = $map->customise_for ($self);
		2280	$map = $check->($map) if $check && $map;
		2281	} else {
		2282	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2283	}
		2284
1859	$map	2285	$map
		2286	};
		2287
		2288	if ($@) {
		2289	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2290	LOG llevError | logBacktrace, Carp::longmess $@;
1860	} or	2291	}
1861	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1862		2292
		2293	if ($gen == $self->{_goto_generation}) {
		2294	delete $self->{_goto_generation};
1863	$self->leave_link ($map, $x, $y);	2295	$self->leave_link ($map, $x, $y);
		2296	}
1864	})->prio (1);	2297	})->prio (1);
1865	}	2298	}
1866		2299
1867	=item $player_object->enter_exit ($exit_object)	2300	=item $player_object->enter_exit ($exit_object)
1868		2301
…		…
1907		2340
1908	$rmp->{random_seed} ||= $exit->random_seed;	2341	$rmp->{random_seed} ||= $exit->random_seed;
1909		2342
1910	my $data = cf::to_json $rmp;	2343	my $data = cf::to_json $rmp;
1911	my $md5 = Digest::MD5::md5_hex $data;	2344	my $md5 = Digest::MD5::md5_hex $data;
1912	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2345	my $meta = "$RANDOMDIR/$md5.meta";
1913		2346
1914	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2347	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1915	aio_write $fh, 0, (length $data), $data, 0;	2348	aio_write $fh, 0, (length $data), $data, 0;
1916	undef $fh;	2349	undef $fh;
1917	aio_rename "$meta~", $meta;	2350	aio_rename "$meta~", $meta;
…		…
1926		2359
1927	return unless $self->type == cf::PLAYER;	2360	return unless $self->type == cf::PLAYER;
1928		2361
1929	if ($exit->slaying eq "/!") {	2362	if ($exit->slaying eq "/!") {
1930	#TODO: this should de-fi-ni-te-ly not be a sync-job	2363	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2364	# the problem is that $exit might not survive long enough
		2365	# so it needs to be done right now, right here
1931	cf::sync_job { prepare_random_map $exit };	2366	cf::sync_job { prepare_random_map $exit };
1932	}	2367	}
1933		2368
1934	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2369	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1935	my $hp = $exit->stats->hp;	2370	my $hp = $exit->stats->hp;
1936	my $sp = $exit->stats->sp;	2371	my $sp = $exit->stats->sp;
1937		2372
1938	$self->enter_link;	2373	$self->enter_link;
		2374
		2375	# if exit is damned, update players death & WoR home-position
		2376	$self->contr->savebed ($slaying, $hp, $sp)
		2377	if $exit->flag (FLAG_DAMNED);
1939		2378
1940	(async {	2379	(async {
1941	$self->deactivate_recursive; # just to be sure	2380	$self->deactivate_recursive; # just to be sure
1942	unless (eval {	2381	unless (eval {
1943	$self->goto ($slaying, $hp, $sp);	2382	$self->goto ($slaying, $hp, $sp);
1944		2383
1945	1;	2384	1;
1946	}) {	2385	}) {
1947	$self->message ("Something went wrong deep within the crossfire server. "	2386	$self->message ("Something went wrong deep within the crossfire server. "
1948	. "I'll try to bring you back to the map you were before. "	2387	. "I'll try to bring you back to the map you were before. "
1949	. "Please report this to the dungeon master!",	2388	. "Please report this to the dungeon master!",
1950	cf::NDI_UNIQUE | cf::NDI_RED);	2389	cf::NDI_UNIQUE | cf::NDI_RED);
1951		2390
1952	warn "ERROR in enter_exit: $@";	2391	warn "ERROR in enter_exit: $@";
1953	$self->leave_link;	2392	$self->leave_link;
1954	}	2393	}
1955	})->prio (1);	2394	})->prio (1);
…		…
1968		2407
1969	sub cf::client::send_drawinfo {	2408	sub cf::client::send_drawinfo {
1970	my ($self, $text, $flags) = @_;	2409	my ($self, $text, $flags) = @_;
1971		2410
1972	utf8::encode $text;	2411	utf8::encode $text;
1973	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2412	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1974	}	2413	}
1975		2414
		2415	=item $client->send_msg ($color, $type, $msg, [extra...])
		2416
		2417	Send a drawinfo or msg packet to the client, formatting the msg for the
		2418	client if neccessary. C<$type> should be a string identifying the type of
		2419	the message, with C<log> being the default. If C<$color> is negative, suppress
		2420	the message unless the client supports the msg packet.
		2421
		2422	=cut
		2423
		2424	sub cf::client::send_msg {
		2425	my ($self, $color, $type, $msg, @extra) = @_;
		2426
		2427	$msg = $self->pl->expand_cfpod ($msg);
		2428
		2429	return unless @extra || length $msg;
		2430
		2431	if ($self->can_msg) {
		2432	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2433	} else {
		2434	# replace some tags by gcfclient-compatible ones
		2435	for ($msg) {
		2436	1 while
		2437	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2438	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2439	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2440	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2441	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2442	}
		2443
		2444	if ($color >= 0) {
		2445	if (0 && $msg =~ /\[/) {
		2446	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2447	} else {
		2448	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2449	$self->send_packet ("drawinfo $color $msg")
		2450	}
		2451	}
		2452	}
		2453	}
		2454
		2455	=item $client->ext_event ($type, %msg)
		2456
		2457	Sends an ext event to the client.
		2458
		2459	=cut
		2460
		2461	sub cf::client::ext_event($$%) {
		2462	my ($self, $type, %msg) = @_;
		2463
		2464	$msg{msgtype} = "event_$type";
		2465	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2466	}
1976		2467
1977	=item $success = $client->query ($flags, "text", \&cb)	2468	=item $success = $client->query ($flags, "text", \&cb)
1978		2469
1979	Queues a query to the client, calling the given callback with	2470	Queues a query to the client, calling the given callback with
1980	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2471	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1981	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2472	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1982		2473
1983	Queries can fail, so check the return code. Or don't, as queries will become	2474	Queries can fail, so check the return code. Or don't, as queries will
1984	reliable at some point in the future.	2475	become reliable at some point in the future.
1985		2476
1986	=cut	2477	=cut
1987		2478
1988	sub cf::client::query {	2479	sub cf::client::query {
1989	my ($self, $flags, $text, $cb) = @_;	2480	my ($self, $flags, $text, $cb) = @_;
…		…
1997	utf8::encode $text;	2488	utf8::encode $text;
1998	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2489	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1999		2490
2000	$self->send_packet ($self->{query_queue}[0][0])	2491	$self->send_packet ($self->{query_queue}[0][0])
2001	if @{ $self->{query_queue} } == 1;	2492	if @{ $self->{query_queue} } == 1;
		2493
		2494	1
2002	}	2495	}
2003		2496
2004	cf::client->attach (	2497	cf::client->attach (
		2498	on_connect => sub {
		2499	my ($ns) = @_;
		2500
		2501	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2502	},
2005	on_reply => sub {	2503	on_reply => sub {
2006	my ($ns, $msg) = @_;	2504	my ($ns, $msg) = @_;
2007		2505
2008	# this weird shuffling is so that direct followup queries	2506	# this weird shuffling is so that direct followup queries
2009	# get handled first	2507	# get handled first
…		…
2021	} else {	2519	} else {
2022	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2520	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2023	}	2521	}
2024	}	2522	}
2025	},	2523	},
		2524	on_exticmd => sub {
		2525	my ($ns, $buf) = @_;
		2526
		2527	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2528
		2529	if (ref $msg) {
		2530	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2531	if (my %reply = $cb->($ns, $msg)) {
		2532	$reply{msgid} = $msg->{msgid};
		2533	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2534	}
		2535	}
		2536	} else {
		2537	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2538	}
		2539
		2540	cf::override;
		2541	},
2026	);	2542	);
2027		2543
2028	=item $client->async (\&cb)	2544	=item $client->async (\&cb)
2029		2545
2030	Create a new coroutine, running the specified callback. The coroutine will	2546	Create a new coroutine, running the specified callback. The coroutine will
…		…
2077		2593
2078	# here we export the classes and methods available to script code	2594	# here we export the classes and methods available to script code
2079		2595
2080	=pod	2596	=pod
2081		2597
2082	The following fucntions and emthods are available within a safe environment:	2598	The following functions and methods are available within a safe environment:
2083		2599
2084	cf::object contr pay_amount pay_player map	2600	cf::object
		2601	contr pay_amount pay_player map x y force_find force_add
		2602	insert remove
		2603
2085	cf::object::player player	2604	cf::object::player
2086	cf::player peaceful	2605	player
2087	cf::map trigger	2606
		2607	cf::player
		2608	peaceful
		2609
		2610	cf::map
		2611	trigger
2088		2612
2089	=cut	2613	=cut
2090		2614
2091	for (	2615	for (
2092	["cf::object" => qw(contr pay_amount pay_player map)],	2616	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2617	insert remove)],
2093	["cf::object::player" => qw(player)],	2618	["cf::object::player" => qw(player)],
2094	["cf::player" => qw(peaceful)],	2619	["cf::player" => qw(peaceful)],
2095	["cf::map" => qw(trigger)],	2620	["cf::map" => qw(trigger)],
2096	) {	2621	) {
2097	no strict 'refs';	2622	no strict 'refs';
…		…
2168	=back	2693	=back
2169		2694
2170	=cut	2695	=cut
2171		2696
2172	#############################################################################	2697	#############################################################################
2173
2174	=head2 EXTENSION DATABASE SUPPORT
2175
2176	Crossfire maintains a very simple database for extension use. It can
2177	currently store anything that can be serialised using Storable, which
2178	excludes objects.
2179
2180	The parameter C<$family> should best start with the name of the extension
2181	using it, it should be unique.
2182
2183	=over 4
2184
2185	=item $value = cf::db_get $family => $key
2186
2187	Returns a single value from the database.
2188
2189	=item cf::db_put $family => $key => $value
2190
2191	Stores the given C<$value> in the family.
2192
2193	=cut
2194
2195	our $DB;
2196
2197	sub db_init {
2198	unless ($DB) {
2199	$DB = BDB::db_create $DB_ENV;
2200
2201	cf::sync_job {
2202	eval {
2203	$DB->set_flags (BDB::CHKSUM);
2204
2205	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2206	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2207	cf::cleanup "db_open(db): $!" if $!;
2208	};
2209	cf::cleanup "db_open(db): $@" if $@;
2210	};
2211
2212	my $path = cf::localdir . "/database.pst";
2213	if (stat $path) {
2214	cf::sync_job {
2215	my $pst = Storable::retrieve $path;
2216
2217	cf::db_put (board => data => $pst->{board});
2218	cf::db_put (guildrules => data => $pst->{guildrules});
2219	cf::db_put (rent => balance => $pst->{rent}{balance});
2220	BDB::db_env_txn_checkpoint $DB_ENV;
2221
2222	unlink $path;
2223	};
2224	}
2225	}
2226	}
2227
2228	sub db_get($$) {
2229	my $key = "$_[0]/$_[1]";
2230
2231	cf::sync_job {
2232	BDB::db_get $DB, undef, $key, my $data;
2233
2234	$! ? ()
2235	: Compress::LZF::sthaw $data
2236	}
2237	}
2238
2239	sub db_put($$$) {
2240	BDB::dbreq_pri 4;
2241	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2242	}
2243
2244	#############################################################################
2245	# the server's init and main functions	2698	# the server's init and main functions
2246		2699
2247	sub load_resources {	2700	sub load_facedata($) {
2248	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2701	my ($path) = @_;
		2702
		2703	warn "loading facedata from $path\n";
		2704
		2705	my $facedata;
		2706	0 < aio_load $path, $facedata
		2707	or die "$path: $!";
		2708
		2709	$facedata = Coro::Storable::thaw $facedata;
		2710
		2711	$facedata->{version} == 2
		2712	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2713
		2714	{
		2715	my $faces = $facedata->{faceinfo};
		2716
		2717	while (my ($face, $info) = each %$faces) {
		2718	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2719	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2720	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2721	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2722	Coro::cede;
		2723	}
		2724
		2725	while (my ($face, $info) = each %$faces) {
		2726	next unless $info->{smooth};
		2727	my $idx = cf::face::find $face
		2728	or next;
		2729	if (my $smooth = cf::face::find $info->{smooth}) {
		2730	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2731	} else {
		2732	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2733	}
		2734	Coro::cede;
		2735	}
		2736	}
		2737
		2738	{
		2739	my $anims = $facedata->{animinfo};
		2740
		2741	while (my ($anim, $info) = each %$anims) {
		2742	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2743	Coro::cede;
		2744	}
		2745
		2746	cf::anim::invalidate_all; # d'oh
		2747	}
		2748
		2749	1
		2750	}
		2751
		2752	sub reload_regions {
		2753	load_resource_file "$MAPDIR/regions"
2249	or die "unable to load regions file\n";#d#	2754	or die "unable to load regions file\n";
		2755	}
		2756
		2757	sub reload_facedata {
		2758	load_facedata "$DATADIR/facedata"
		2759	or die "unable to load facedata\n";
		2760	}
		2761
		2762	sub reload_archetypes {
		2763	load_resource_file "$DATADIR/archetypes"
		2764	or die "unable to load archetypes\n";
		2765	#d# NEED to laod twice to resolve forward references
		2766	# this really needs to be done in an extra post-pass
		2767	# (which needs to be synchronous, so solve it differently)
		2768	load_resource_file "$DATADIR/archetypes"
		2769	or die "unable to load archetypes\n";
		2770	}
		2771
		2772	sub reload_treasures {
		2773	load_resource_file "$DATADIR/treasures"
		2774	or die "unable to load treasurelists\n";
		2775	}
		2776
		2777	sub reload_resources {
		2778	warn "reloading resource files...\n";
		2779
		2780	reload_regions;
		2781	reload_facedata;
		2782	#reload_archetypes;#d#
		2783	reload_archetypes;
		2784	reload_treasures;
		2785
		2786	warn "finished reloading resource files\n";
		2787	}
		2788
		2789	sub init {
		2790	reload_resources;
2250	}	2791	}
2251		2792
2252	sub cfg_load {	2793	sub cfg_load {
2253	open my $fh, "<:utf8", cf::confdir . "/config"	2794	open my $fh, "<:utf8", "$CONFDIR/config"
2254	or return;	2795	or return;
2255		2796
2256	local $/;	2797	local $/;
2257	*CFG = YAML::Syck::Load <$fh>;	2798	*CFG = YAML::Syck::Load <$fh>;
2258		2799
…		…
2266	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2807	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2267	and die "WARNING: m(un)lockall failed: $!\n";	2808	and die "WARNING: m(un)lockall failed: $!\n";
2268	};	2809	};
2269	warn $@ if $@;	2810	warn $@ if $@;
2270	}	2811	}
2271	}
2272
2273	sub init {
2274	load_resources;
2275	}	2812	}
2276		2813
2277	sub main {	2814	sub main {
2278	# we must not ever block the main coroutine	2815	# we must not ever block the main coroutine
2279	local $Coro::idle = sub {	2816	local $Coro::idle = sub {
…		…
2307	},	2844	},
2308	);	2845	);
2309	}	2846	}
2310	}	2847	}
2311		2848
		2849	sub write_runtime {
		2850	my $runtime = "$LOCALDIR/runtime";
		2851
		2852	# first touch the runtime file to show we are still running:
		2853	# the fsync below can take a very very long time.
		2854
		2855	IO::AIO::aio_utime $runtime, undef, undef;
		2856
		2857	my $guard = cf::lock_acquire "write_runtime";
		2858
		2859	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2860	or return;
		2861
		2862	my $value = $cf::RUNTIME + 90 + 10;
		2863	# 10 is the runtime save interval, for a monotonic clock
		2864	# 60 allows for the watchdog to kill the server.
		2865
		2866	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2867	and return;
		2868
		2869	# always fsync - this file is important
		2870	aio_fsync $fh
		2871	and return;
		2872
		2873	# touch it again to show we are up-to-date
		2874	aio_utime $fh, undef, undef;
		2875
		2876	close $fh
		2877	or return;
		2878
		2879	aio_rename "$runtime~", $runtime
		2880	and return;
		2881
		2882	warn "runtime file written.\n";
		2883
		2884	1
		2885	}
		2886
2312	sub emergency_save() {	2887	sub emergency_save() {
2313	my $freeze_guard = cf::freeze_mainloop;	2888	my $freeze_guard = cf::freeze_mainloop;
2314		2889
2315	warn "enter emergency perl save\n";	2890	warn "enter emergency perl save\n";
2316		2891
…		…
2347		2922
2348	warn Carp::longmess "post_cleanup backtrace"	2923	warn Carp::longmess "post_cleanup backtrace"
2349	if $make_core;	2924	if $make_core;
2350	}	2925	}
2351		2926
2352	sub reload() {	2927	sub do_reload_perl() {
2353	# can/must only be called in main	2928	# can/must only be called in main
2354	if ($Coro::current != $Coro::main) {	2929	if ($Coro::current != $Coro::main) {
2355	warn "can only reload from main coroutine";	2930	warn "can only reload from main coroutine";
2356	return;	2931	return;
2357	}	2932	}
…		…
2382	Coro::cede;	2957	Coro::cede;
2383	last unless IO::AIO::nreqs || BDB::nreqs;	2958	last unless IO::AIO::nreqs || BDB::nreqs;
2384	warn "iterate...";	2959	warn "iterate...";
2385	}	2960	}
2386		2961
		2962	++$RELOAD;
		2963
2387	warn "cancelling all extension coros";	2964	warn "cancelling all extension coros";
2388	$_->cancel for values %EXT_CORO;	2965	$_->cancel for values %EXT_CORO;
2389	%EXT_CORO = ();	2966	%EXT_CORO = ();
2390		2967
2391	warn "removing commands";	2968	warn "removing commands";
2392	%COMMAND = ();	2969	%COMMAND = ();
2393		2970
2394	warn "removing ext commands";	2971	warn "removing ext/exti commands";
2395	%EXTCMD = ();	2972	%EXTCMD = ();
		2973	%EXTICMD = ();
2396		2974
2397	warn "unloading/nuking all extensions";	2975	warn "unloading/nuking all extensions";
2398	for my $pkg (@EXTS) {	2976	for my $pkg (@EXTS) {
2399	warn "... unloading $pkg";	2977	warn "... unloading $pkg";
2400		2978
…		…
2430	Symbol::delete_package "safe::$_"	3008	Symbol::delete_package "safe::$_"
2431	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3009	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2432		3010
2433	warn "unloading cf.pm \"a bit\"";	3011	warn "unloading cf.pm \"a bit\"";
2434	delete $INC{"cf.pm"};	3012	delete $INC{"cf.pm"};
		3013	delete $INC{"cf/pod.pm"};
2435		3014
2436	# don't, removes xs symbols, too,	3015	# don't, removes xs symbols, too,
2437	# and global variables created in xs	3016	# and global variables created in xs
2438	#Symbol::delete_package __PACKAGE__;	3017	#Symbol::delete_package __PACKAGE__;
2439		3018
…		…
2448		3027
2449	warn "loading extensions";	3028	warn "loading extensions";
2450	cf::load_extensions;	3029	cf::load_extensions;
2451		3030
2452	warn "reattaching attachments to objects/players";	3031	warn "reattaching attachments to objects/players";
2453	_global_reattach;	3032	_global_reattach; # objects, sockets
2454	warn "reattaching attachments to maps";	3033	warn "reattaching attachments to maps";
2455	reattach $_ for values %MAP;	3034	reattach $_ for values %MAP;
2456		3035	warn "reattaching attachments to players";
2457	warn "loading reloadable resources";	3036	reattach $_ for values %PLAYER;
2458	load_resources;
2459		3037
2460	warn "leaving sync_job";	3038	warn "leaving sync_job";
2461		3039
2462	1	3040	1
2463	} or do {	3041	} or do {
…		…
2469	warn "reloaded";	3047	warn "reloaded";
2470	};	3048	};
2471		3049
2472	our $RELOAD_WATCHER; # used only during reload	3050	our $RELOAD_WATCHER; # used only during reload
2473		3051
		3052	sub reload_perl() {
		3053	# doing reload synchronously and two reloads happen back-to-back,
		3054	# coro crashes during coro_state_free->destroy here.
		3055
		3056	$RELOAD_WATCHER ||= Event->timer (
		3057	reentrant => 0,
		3058	after => 0,
		3059	data => WF_AUTOCANCEL,
		3060	cb => sub {
		3061	do_reload_perl;
		3062	undef $RELOAD_WATCHER;
		3063	},
		3064	);
		3065	}
		3066
2474	register_command "reload" => sub {	3067	register_command "reload" => sub {
2475	my ($who, $arg) = @_;	3068	my ($who, $arg) = @_;
2476		3069
2477	if ($who->flag (FLAG_WIZ)) {	3070	if ($who->flag (FLAG_WIZ)) {
2478	$who->message ("reloading server.");	3071	$who->message ("reloading server.");
2479		3072	async { reload_perl };
2480	# doing reload synchronously and two reloads happen back-to-back,
2481	# coro crashes during coro_state_free->destroy here.
2482
2483	$RELOAD_WATCHER ||= Event->timer (
2484	reentrant => 0,
2485	after => 0,
2486	data => WF_AUTOCANCEL,
2487	cb => sub {
2488	reload;
2489	undef $RELOAD_WATCHER;
2490	},
2491	);
2492	}	3073	}
2493	};	3074	};
2494		3075
2495	unshift @INC, $LIBDIR;	3076	unshift @INC, $LIBDIR;
2496		3077
2497	my $bug_warning = 0;	3078	my $bug_warning = 0;
2498		3079
		3080	our @WAIT_FOR_TICK;
		3081	our @WAIT_FOR_TICK_BEGIN;
		3082
		3083	sub wait_for_tick {
		3084	return unless $TICK_WATCHER->is_active;
		3085	return if $Coro::current == $Coro::main;
		3086
		3087	my $signal = new Coro::Signal;
		3088	push @WAIT_FOR_TICK, $signal;
		3089	$signal->wait;
		3090	}
		3091
		3092	sub wait_for_tick_begin {
		3093	return unless $TICK_WATCHER->is_active;
		3094	return if $Coro::current == $Coro::main;
		3095
		3096	my $signal = new Coro::Signal;
		3097	push @WAIT_FOR_TICK_BEGIN, $signal;
		3098	$signal->wait;
		3099	}
		3100
		3101	my $min = 1e6;#d#
		3102	my $avg = 10;
2499	$TICK_WATCHER = Event->timer (	3103	$TICK_WATCHER = Event->timer (
2500	reentrant => 0,	3104	reentrant => 0,
2501	parked => 1,	3105	parked => 1,
2502	prio => 0,	3106	prio => 0,
2503	at => $NEXT_TICK || $TICK,	3107	at => $NEXT_TICK || $TICK,
…		…
2507	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3111	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508	unless ++$bug_warning > 10;	3112	unless ++$bug_warning > 10;
2509	return;	3113	return;
2510	}	3114	}
2511		3115
2512	$NOW = Event::time;	3116	$NOW = $tick_start = Event::time;
2513		3117
2514	cf::server_tick; # one server iteration	3118	cf::server_tick; # one server iteration
		3119
		3120	0 && sync_job {#d#
		3121	for(1..10) {
		3122	my $t = Event::time;
		3123	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3124	or die;
		3125
		3126	$map->width (50);
		3127	$map->height (50);
		3128	$map->alloc;
		3129	$map->_load_objects ("/tmp/x.map", 1);
		3130	my $t = Event::time - $t;
		3131
		3132	#next unless $t < 0.0013;#d#
		3133	if ($t < $min) {
		3134	$min = $t;
		3135	}
		3136	$avg = $avg * 0.99 + $t * 0.01;
		3137	}
		3138	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3139	exit 0;
		3140	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3141	};
		3142
2515	$RUNTIME += $TICK;	3143	$RUNTIME += $TICK;
2516	$NEXT_TICK += $TICK;	3144	$NEXT_TICK += $TICK;
2517		3145
2518	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3146	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519	$NEXT_RUNTIME_WRITE = $NOW + 10;	3147	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2521	write_runtime	3149	write_runtime
2522	or warn "ERROR: unable to write runtime file: $!";	3150	or warn "ERROR: unable to write runtime file: $!";
2523	};	3151	};
2524	}	3152	}
2525		3153
2526
2527	$WAIT_FOR_TICK->broadcast;
2528	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2529
2530	# my $AFTER = Event::time;	3154	# my $AFTER = Event::time;
2531	# warn $AFTER - $NOW;#d#	3155	# warn $AFTER - $NOW;#d#
2532		3156
		3157	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3158	$sig->send;
		3159	}
		3160	while (my $sig = shift @WAIT_FOR_TICK) {
		3161	$sig->send;
		3162	}
		3163
		3164	$NOW = Event::time;
		3165
2533	# if we are delayed by four ticks or more, skip them all	3166	# if we are delayed by four ticks or more, skip them all
2534	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3167	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2535		3168
2536	$TICK_WATCHER->at ($NEXT_TICK);	3169	$TICK_WATCHER->at ($NEXT_TICK);
2537	$TICK_WATCHER->start;	3170	$TICK_WATCHER->start;
		3171
		3172	$LOAD = ($NOW - $tick_start) / $TICK;
		3173	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3174
		3175	_post_tick;
		3176
		3177
2538	},	3178	},
2539	);	3179	);
2540		3180
2541	{	3181	{
2542	BDB::max_poll_time $TICK * 0.1;	3182	BDB::max_poll_time $TICK * 0.1;
…		…
2570		3210
2571	cf::sync_job {	3211	cf::sync_job {
2572	eval {	3212	eval {
2573	BDB::db_env_open	3213	BDB::db_env_open
2574	$DB_ENV,	3214	$DB_ENV,
2575	$BDB_ENV_DIR,	3215	$BDBDIR,
2576	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3216	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2577	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3217	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2578	0666;	3218	0666;
2579		3219
2580	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3220	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2581		3221
2582	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3222	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2583	$DB_ENV->set_lk_detect;	3223	$DB_ENV->set_lk_detect;
2584	};	3224	};
2585		3225
…		…
2601	prio => 6,	3241	prio => 6,
2602	cb => \&IO::AIO::poll_cb,	3242	cb => \&IO::AIO::poll_cb,
2603	);	3243	);
2604	}	3244	}
2605		3245
		3246	my $_log_backtrace;
		3247
		3248	sub _log_backtrace {
		3249	my ($msg, @addr) = @_;
		3250
		3251	$msg =~ s/\n//;
		3252
		3253	# limit the # of concurrent backtraces
		3254	if ($_log_backtrace < 2) {
		3255	++$_log_backtrace;
		3256	async {
		3257	my @bt = fork_call {
		3258	@addr = map { sprintf "%x", $_ } @addr;
		3259	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3260	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3261	or die "addr2line: $!";
		3262
		3263	my @funcs;
		3264	my @res = <$fh>;
		3265	chomp for @res;
		3266	while (@res) {
		3267	my ($func, $line) = splice @res, 0, 2, ();
		3268	push @funcs, "[$func] $line";
		3269	}
		3270
		3271	@funcs
		3272	};
		3273
		3274	LOG llevInfo, "[ABT] $msg\n";
		3275	LOG llevInfo, "[ABT] $_\n" for @bt;
		3276	--$_log_backtrace;
		3277	};
		3278	} else {
		3279	LOG llevInfo, "[ABT] $msg\n";
		3280	LOG llevInfo, "[ABT] [suppressed]\n";
		3281	}
		3282	}
		3283
		3284	# load additional modules
		3285	use cf::pod;
		3286
2606	END { cf::emergency_save }	3287	END { cf::emergency_save }
2607		3288
2608	1	3289	1
2609		3290

Diff Legend

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