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.215 by root, Thu Feb 15 03:19:02 2007 UTC vs.
Revision 1.292 by root, Tue Jul 3 00:54:57 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.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	$res = Coro::Storable::thaw $res;
380		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;
381	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 });
382	}	574	}
383		575
384	=back	576	=back
385		577
386	=cut	578	=cut
…		…
393	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")
394	to it. All such attachable objects support the following methods.	586	to it. All such attachable objects support the following methods.
395		587
396	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>
397	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
398	crossfire+).	590	Crossfire TRT).
399		591
400	=over 4	592	=over 4
401		593
402	=item $attachable->attach ($attachment, key => $value...)	594	=item $attachable->attach ($attachment, key => $value...)
403		595
…		…
566	$registry = $CB_TYPE[$object_type] ||= [];	758	$registry = $CB_TYPE[$object_type] ||= [];
567		759
568	} elsif ($type eq "subtype") {	760	} elsif ($type eq "subtype") {
569	defined $object_type or Carp::croak "subtype specified without type";	761	defined $object_type or Carp::croak "subtype specified without type";
570	my $object_subtype = shift @arg;	762	my $object_subtype = shift @arg;
571	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	763	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
572		764
573	} elsif ($type eq "package") {	765	} elsif ($type eq "package") {
574	my $pkg = shift @arg;	766	my $pkg = shift @arg;
575		767
576	while (my ($name, $id) = each %cb_id) {	768	while (my ($name, $id) = each %cb_id) {
…		…
605	_attach $registry, $klass, @attach;	797	_attach $registry, $klass, @attach;
606	}	798	}
607		799
608	$obj->{$name} = \%arg;	800	$obj->{$name} = \%arg;
609	} else {	801	} else {
610	warn "object uses attachment '$name' that is not available, postponing.\n";	802	warn "object uses attachment '$name' which is not available, postponing.\n";
611	}	803	}
612		804
613	$obj->{_attachment}{$name} = undef;	805	$obj->{_attachment}{$name} = undef;
614	}	806	}
615		807
…		…
617	if (ref $_[0]) {	809	if (ref $_[0]) {
618	_object_attach @_;	810	_object_attach @_;
619	} else {	811	} else {
620	_attach shift->_attach_registry, @_;	812	_attach shift->_attach_registry, @_;
621	}	813	}
		814	_recalc_want;
622	};	815	};
623		816
624	# all those should be optimised	817	# all those should be optimised
625	sub cf::attachable::detach {	818	sub cf::attachable::detach {
626	my ($obj, $name) = @_;	819	my ($obj, $name) = @_;
…		…
629	delete $obj->{_attachment}{$name};	822	delete $obj->{_attachment}{$name};
630	reattach ($obj);	823	reattach ($obj);
631	} else {	824	} else {
632	Carp::croak "cannot, currently, detach class attachments";	825	Carp::croak "cannot, currently, detach class attachments";
633	}	826	}
		827	_recalc_want;
634	};	828	};
635		829
636	sub cf::attachable::attached {	830	sub cf::attachable::attached {
637	my ($obj, $name) = @_;	831	my ($obj, $name) = @_;
638		832
…		…
785	}	979	}
786	} else {	980	} else {
787	aio_unlink $filename;	981	aio_unlink $filename;
788	aio_unlink "$filename.pst";	982	aio_unlink "$filename.pst";
789	}	983	}
790
791	#d##TODO# nuke non .map-files if exist
792	if ($filename =~ s/\.map$//) {
793	aio_unlink $filename;
794	aio_unlink "$filename.pst";
795	}
796	}	984	}
797	}	985	}
798		986
799	sub object_freezer_as_string {	987	sub object_freezer_as_string {
800	my ($rdata, $objs) = @_;	988	my ($rdata, $objs) = @_;
…		…
806		994
807	sub object_thawer_load {	995	sub object_thawer_load {
808	my ($filename) = @_;	996	my ($filename) = @_;
809		997
810	my ($data, $av);	998	my ($data, $av);
811
812	#d#TODO remove .map if file does not exist
813	aio_stat $filename and $filename =~ s/\.map$//;
814		999
815	(aio_load $filename, $data) >= 0	1000	(aio_load $filename, $data) >= 0
816	or return;	1001	or return;
817		1002
818	unless (aio_stat "$filename.pst") {	1003	unless (aio_stat "$filename.pst") {
…		…
820	or return;	1005	or return;
821	$av = eval { (Storable::thaw $av)->{objs} };	1006	$av = eval { (Storable::thaw $av)->{objs} };
822	}	1007	}
823		1008
824	warn sprintf "loading %s (%d)\n",	1009	warn sprintf "loading %s (%d)\n",
825	$filename, length $data, scalar @{$av || []};#d#	1010	$filename, length $data, scalar @{$av || []};
826	return ($data, $av);	1011	return ($data, $av);
827	}	1012	}
		1013
		1014	=head2 COMMAND CALLBACKS
		1015
		1016	=over 4
		1017
		1018	=cut
828		1019
829	#############################################################################	1020	#############################################################################
830	# command handling &c	1021	# command handling &c
831		1022
832	=item cf::register_command $name => \&callback($ob,$args);	1023	=item cf::register_command $name => \&callback($ob,$args);
…		…
845	push @{ $COMMAND{$name} }, [$caller, $cb];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
846	}	1037	}
847		1038
848	=item cf::register_extcmd $name => \&callback($pl,$packet);	1039	=item cf::register_extcmd $name => \&callback($pl,$packet);
849		1040
850	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.
851		1046
852	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
853	called.	1048	called.
854		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
855	=cut	1061	=cut
856		1062
857	sub register_extcmd {	1063	sub register_extcmd {
858	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
859		1065
860	$EXTCMD{$name} = $cb;	1066	$EXTCMD{$name} = $cb;
		1067	}
		1068
		1069	sub register_exticmd {
		1070	my ($name, $cb) = @_;
		1071
		1072	$EXTICMD{$name} = $cb;
861	}	1073	}
862		1074
863	cf::player->attach (	1075	cf::player->attach (
864	on_command => sub {	1076	on_command => sub {
865	my ($pl, $name, $params) = @_;	1077	my ($pl, $name, $params) = @_;
…		…
874	cf::override;	1086	cf::override;
875	},	1087	},
876	on_extcmd => sub {	1088	on_extcmd => sub {
877	my ($pl, $buf) = @_;	1089	my ($pl, $buf) = @_;
878		1090
879	my $msg = eval { from_json $buf };	1091	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
880		1092
881	if (ref $msg) {	1093	if (ref $msg) {
882	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1094	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
883	if (my %reply = $cb->($pl, $msg)) {	1095	if (my %reply = $cb->($pl, $msg)) {
884	$pl->ext_reply ($msg->{msgid}, %reply);	1096	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
890		1102
891	cf::override;	1103	cf::override;
892	},	1104	},
893	);	1105	);
894		1106
895	sub load_extension {
896	my ($path) = @_;
897
898	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
899	my $base = $1;
900	my $pkg = $1;
901	$pkg =~ s/[^[:word:]]/_/g;
902	$pkg = "ext::$pkg";
903
904	warn "... loading '$path' into '$pkg'\n";
905
906	open my $fh, "<:utf8", $path
907	or die "$path: $!";
908
909	my $source =
910	"package $pkg; use strict; use utf8;\n"
911	. "#line 1 \"$path\"\n{\n"
912	. (do { local $/; <$fh> })
913	. "\n};\n1";
914
915	unless (eval $source) {
916	my $msg = $@ ? "$path: $@\n"
917	: "extension disabled.\n";
918	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
919	warn $@;
920	warn "mandatory extension failed to load, exiting.\n";
921	exit 1;
922	}
923	die $@;
924	}
925
926	push @EXTS, $pkg;
927	}
928
929	sub load_extensions {	1107	sub load_extensions {
		1108	cf::sync_job {
		1109	my %todo;
		1110
930	for my $ext (<$LIBDIR/*.ext>) {	1111	for my $path (<$LIBDIR/*.ext>) {
931	next unless -r $ext;	1112	next unless -r $path;
932	eval {	1113
933	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;
934	1	1171	}
935	} or warn "$ext not loaded: $@";	1172
		1173	skip:
		1174	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1175	unless $progress;
		1176	}
936	}	1177	};
937	}	1178	}
938		1179
939	#############################################################################	1180	#############################################################################
940		1181
		1182	=back
		1183
941	=head2 CORE EXTENSIONS	1184	=head2 CORE EXTENSIONS
942		1185
943	Functions and methods that extend core crossfire objects.	1186	Functions and methods that extend core crossfire objects.
944		1187
945	=cut	1188	=cut
…		…
957	Returns the given player object, loading it if necessary (might block).	1200	Returns the given player object, loading it if necessary (might block).
958		1201
959	=cut	1202	=cut
960		1203
961	sub playerdir($) {	1204	sub playerdir($) {
962	cf::localdir	1205	"$PLAYERDIR/"
963	. "/"
964	. cf::playerdir
965	. "/"
966	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1206	. (ref $_[0] ? $_[0]->ob->name : $_[0])
967	}	1207	}
968		1208
969	sub path($) {	1209	sub path($) {
970	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1210	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
971		1211
972	(playerdir $login) . "/$login.pl"	1212	(playerdir $login) . "/playerdata"
973	}	1213	}
974		1214
975	sub find_active($) {	1215	sub find_active($) {
976	$cf::PLAYER{$_[0]}	1216	$cf::PLAYER{$_[0]}
977	and $cf::PLAYER{$_[0]}->active	1217	and $cf::PLAYER{$_[0]}->active
…		…
990	my $login = $_[0];	1230	my $login = $_[0];
991		1231
992	my $guard = cf::lock_acquire "user_find:$login";	1232	my $guard = cf::lock_acquire "user_find:$login";
993		1233
994	$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
995	my $pl = load_pl path $login	1242	my $pl = load_pl path $login
996	or return;	1243	or return;
997	$cf::PLAYER{$login} = $pl	1244	$cf::PLAYER{$login} = $pl
998	}	1245	}
999	}	1246	}
…		…
1036		1283
1037	=cut	1284	=cut
1038		1285
1039	sub quit_character {	1286	sub quit_character {
1040	my ($pl) = @_;	1287	my ($pl) = @_;
		1288
		1289	my $name = $pl->ob->name;
1041		1290
1042	$pl->{deny_save} = 1;	1291	$pl->{deny_save} = 1;
1043	$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
1044		1293
1045	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1294	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1050	my $path = playerdir $pl;	1299	my $path = playerdir $pl;
1051	my $temp = "$path~$cf::RUNTIME~deleting~";	1300	my $temp = "$path~$cf::RUNTIME~deleting~";
1052	aio_rename $path, $temp;	1301	aio_rename $path, $temp;
1053	delete $cf::PLAYER{$pl->ob->name};	1302	delete $cf::PLAYER{$pl->ob->name};
1054	$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
1055	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;
1056	}	1325	}
1057		1326
1058	=item cf::player::list_logins	1327	=item cf::player::list_logins
1059		1328
1060	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
1061	while and may block, so not sync_job-capable, ever.	1330	while and may block, so not sync_job-capable, ever.
1062		1331
1063	=cut	1332	=cut
1064		1333
1065	sub list_logins {	1334	sub list_logins {
1066	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1335	my $dirs = aio_readdir $PLAYERDIR
1067	or return [];	1336	or return [];
1068		1337
1069	my @logins;	1338	my @logins;
1070		1339
1071	for my $login (@$dirs) {	1340	for my $login (@$dirs) {
…		…
1106	}	1375	}
1107		1376
1108	\@paths	1377	\@paths
1109	}	1378	}
1110		1379
		1380	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1381
		1382	Expand crossfire pod fragments into protocol xml.
		1383
		1384	=cut
		1385
		1386	sub expand_cfpod {
		1387	((my $self), (local $_)) = @_;
		1388
		1389	# escape & and <
		1390	s/&/&amp;/g;
		1391	s/(?<![BIUGH])</&lt;/g;
		1392
		1393	# this is buggy, it needs to properly take care of nested <'s
		1394
		1395	1 while
		1396	# replace B<>, I<>, U<> etc.
		1397	s/B<([^\>]*)>/<b>$1<\/b>/
		1398	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1399	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1400	# replace G<male|female> tags
		1401	|| s{G<([^>|]*)\|([^>]*)>}{
		1402	$self->gender ? $2 : $1
		1403	}ge
		1404	# replace H<hint text>
		1405	|| s{H<([^\>]*)>}
		1406	{
		1407	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1408	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1409	"")
		1410	[$self->{hintmode}]
		1411	}ge;
		1412
		1413	# create single paragraphs (very hackish)
		1414	s/(?<=\S)\n(?=\w)/ /g;
		1415
		1416	# compress some whitespace
		1417	1 while s/\s*\n\s*\n\s*/\n/;
		1418
		1419	$_
		1420	}
		1421
		1422	sub hintmode {
		1423	$_[0]{hintmode} = $_[1] if @_ > 1;
		1424	$_[0]{hintmode}
		1425	}
		1426
1111	=item $player->ext_reply ($msgid, $msgtype, %msg)	1427	=item $player->ext_reply ($msgid, %msg)
1112		1428
1113	Sends an ext reply to the player.	1429	Sends an ext reply to the player.
1114		1430
1115	=cut	1431	=cut
1116		1432
1117	sub ext_reply($$$%) {	1433	sub ext_reply($$%) {
1118	my ($self, $id, %msg) = @_;	1434	my ($self, $id, %msg) = @_;
1119		1435
1120	$msg{msgid} = $id;	1436	$msg{msgid} = $id;
1121		1437	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1122	$self->send ("ext " . cf::to_json \%msg);
1123	}	1438	}
1124		1439
1125	package cf;	1440	=item $player->ext_event ($type, %msg)
		1441
		1442	Sends an ext event to the client.
		1443
		1444	=cut
		1445
		1446	sub ext_event($$%) {
		1447	my ($self, $type, %msg) = @_;
		1448
		1449	$self->ns->ext_event ($type, %msg);
		1450	}
		1451
		1452	=head3 cf::region
		1453
		1454	=over 4
		1455
		1456	=cut
		1457
		1458	package cf::region;
		1459
		1460	=item cf::region::find_by_path $path
		1461
		1462	Tries to decuce the likely region for a map knowing only its path.
		1463
		1464	=cut
		1465
		1466	sub find_by_path($) {
		1467	my ($path) = @_;
		1468
		1469	my ($match, $specificity);
		1470
		1471	for my $region (list) {
		1472	if ($region->match && $path =~ $region->match) {
		1473	($match, $specificity) = ($region, $region->specificity)
		1474	if $region->specificity > $specificity;
		1475	}
		1476	}
		1477
		1478	$match
		1479	}
1126		1480
1127	=back	1481	=back
1128
1129		1482
1130	=head3 cf::map	1483	=head3 cf::map
1131		1484
1132	=over 4	1485	=over 4
1133		1486
…		…
1188	my ($self, $merge) = @_;	1541	my ($self, $merge) = @_;
1189		1542
1190	# we have to keep some variables in memory intact	1543	# we have to keep some variables in memory intact
1191	local $self->{path};	1544	local $self->{path};
1192	local $self->{load_path};	1545	local $self->{load_path};
1193	local $self->{deny_save};
1194	local $self->{deny_reset};
1195		1546
1196	$self->SUPER::thawer_merge ($merge);	1547	$self->SUPER::thawer_merge ($merge);
1197	}	1548	}
1198		1549
1199	sub normalise {	1550	sub normalise {
…		…
1271		1622
1272	# the original (read-only) location	1623	# the original (read-only) location
1273	sub load_path {	1624	sub load_path {
1274	my ($self) = @_;	1625	my ($self) = @_;
1275		1626
1276	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1627	"$MAPDIR/$self->{path}.map"
1277	}	1628	}
1278		1629
1279	# the temporary/swap location	1630	# the temporary/swap location
1280	sub save_path {	1631	sub save_path {
1281	my ($self) = @_;	1632	my ($self) = @_;
1282		1633
1283	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1634	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1284	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1635	"$TMPDIR/$path.map"
1285	}	1636	}
1286		1637
1287	# the unique path, undef == no special unique path	1638	# the unique path, undef == no special unique path
1288	sub uniq_path {	1639	sub uniq_path {
1289	my ($self) = @_;	1640	my ($self) = @_;
1290		1641
1291	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1642	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1292	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1643	"$UNIQUEDIR/$path"
1293	}	1644	}
1294		1645
1295	# and all this just because we cannot iterate over	1646	# and all this just because we cannot iterate over
1296	# all maps in C++...	1647	# all maps in C++...
1297	sub change_all_map_light {	1648	sub change_all_map_light {
…		…
1299		1650
1300	$_->change_map_light ($change)	1651	$_->change_map_light ($change)
1301	for grep $_->outdoor, values %cf::MAP;	1652	for grep $_->outdoor, values %cf::MAP;
1302	}	1653	}
1303		1654
		1655	sub decay_objects {
		1656	my ($self) = @_;
		1657
		1658	return if $self->{deny_reset};
		1659
		1660	$self->do_decay_objects;
		1661	}
		1662
1304	sub unlink_save {	1663	sub unlink_save {
1305	my ($self) = @_;	1664	my ($self) = @_;
1306		1665
1307	utf8::encode (my $save = $self->save_path);	1666	utf8::encode (my $save = $self->save_path);
1308	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1667	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1309	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1668	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1310
1311	#d#TODO remove .map and also nuke
1312	$save =~ s/\.map// or return;#d#
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1314	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1315	}	1669	}
1316		1670
1317	sub load_header_from($) {	1671	sub load_header_from($) {
1318	my ($self, $path) = @_;	1672	my ($self, $path) = @_;
1319		1673
…		…
1369	$self->load_header_orig	1723	$self->load_header_orig
1370	or return;	1724	or return;
1371	$self->prepare_orig;	1725	$self->prepare_orig;
1372	}	1726	}
1373		1727
		1728	$self->{deny_reset} = 1
		1729	if $self->no_reset;
		1730
		1731	$self->default_region (cf::region::find_by_path $self->{path})
		1732	unless $self->default_region;
		1733
1374	1	1734	1
1375	}	1735	}
1376		1736
1377	sub find;	1737	sub find;
1378	sub find {	1738	sub find {
…		…
1390	$map->{last_save} = $cf::RUNTIME;	1750	$map->{last_save} = $cf::RUNTIME;
1391		1751
1392	$map->load_header	1752	$map->load_header
1393	or return;	1753	or return;
1394		1754
1395	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1755	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1396	# doing this can freeze the server in a sync job, obviously	1756	# doing this can freeze the server in a sync job, obviously
1397	#$cf::WAIT_FOR_TICK->wait;	1757	#$cf::WAIT_FOR_TICK->wait;
1398	$map->reset;	1758	$map->reset;
1399	undef $guard;	1759	undef $guard;
1400	return find $path;	1760	return find $path;
…		…
1411	my ($self) = @_;	1771	my ($self) = @_;
1412		1772
1413	local $self->{deny_reset} = 1; # loading can take a long time	1773	local $self->{deny_reset} = 1; # loading can take a long time
1414		1774
1415	my $path = $self->{path};	1775	my $path = $self->{path};
		1776
		1777	{
1416	my $guard = cf::lock_acquire "map_load:$path";	1778	my $guard = cf::lock_acquire "map_load:$path";
1417		1779
1418	return if $self->in_memory != cf::MAP_SWAPPED;	1780	return if $self->in_memory != cf::MAP_SWAPPED;
1419		1781
1420	$self->in_memory (cf::MAP_LOADING);	1782	$self->in_memory (cf::MAP_LOADING);
1421		1783
1422	$self->alloc;	1784	$self->alloc;
1423		1785
1424	$self->pre_load;	1786	$self->pre_load;
1425
1426	$self->_load_objects ($self->{load_path}, 1)
1427	or return;
1428
1429	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1430	if delete $self->{load_original};
1431
1432	if (my $uniq = $self->uniq_path) {
1433	utf8::encode $uniq;
1434	if (aio_open $uniq, O_RDONLY, 0) {
1435	$self->clear_unique_items;
1436	$self->_load_objects ($uniq, 0);
1437	}
1438	}
1439
1440	Coro::cede;
1441
1442	# now do the right thing for maps
1443	$self->link_multipart_objects;
1444
1445	unless ($self->{deny_activate}) {
1446	$self->decay_objects;
1447	$self->fix_auto_apply;
1448	$self->update_buttons;
1449	Coro::cede;	1787	Coro::cede;
1450	$self->set_darkness_map;	1788
		1789	$self->_load_objects ($self->{load_path}, 1)
		1790	or return;
		1791
		1792	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1793	if delete $self->{load_original};
		1794
		1795	if (my $uniq = $self->uniq_path) {
		1796	utf8::encode $uniq;
		1797	if (aio_open $uniq, O_RDONLY, 0) {
		1798	$self->clear_unique_items;
		1799	$self->_load_objects ($uniq, 0);
		1800	}
		1801	}
		1802
		1803	Coro::cede;
		1804	# now do the right thing for maps
		1805	$self->link_multipart_objects;
1451	$self->difficulty ($self->estimate_difficulty)	1806	$self->difficulty ($self->estimate_difficulty)
1452	unless $self->difficulty;	1807	unless $self->difficulty;
1453	Coro::cede;	1808	Coro::cede;
		1809
		1810	unless ($self->{deny_activate}) {
		1811	$self->decay_objects;
		1812	$self->fix_auto_apply;
		1813	$self->update_buttons;
		1814	Coro::cede;
		1815	$self->set_darkness_map;
		1816	Coro::cede;
1454	$self->activate;	1817	$self->activate;
		1818	}
		1819
		1820	$self->in_memory (cf::MAP_IN_MEMORY);
1455	}	1821	}
1456		1822
1457	$self->post_load;	1823	$self->post_load;
1458
1459	$self->in_memory (cf::MAP_IN_MEMORY);
1460	}	1824	}
1461		1825
1462	sub customise_for {	1826	sub customise_for {
1463	my ($self, $ob) = @_;	1827	my ($self, $ob) = @_;
1464		1828
1465	return find "~" . $ob->name . "/" . $self->{path}	1829	return find "~" . $ob->name . "/" . $self->{path}
1466	if $self->per_player;	1830	if $self->per_player;
		1831
		1832	# return find "?party/" . $ob->name . "/" . $self->{path}
		1833	# if $self->per_party;
1467		1834
1468	$self	1835	$self
1469	}	1836	}
1470		1837
1471	# find and load all maps in the 3x3 area around a map	1838	# find and load all maps in the 3x3 area around a map
…		…
1582		1949
1583	sub reset_at {	1950	sub reset_at {
1584	my ($self) = @_;	1951	my ($self) = @_;
1585		1952
1586	# TODO: safety, remove and allow resettable per-player maps	1953	# TODO: safety, remove and allow resettable per-player maps
1587	return 1e99 if $self->isa ("ext::map_per_player");#d#
1588	return 1e99 if $self->{deny_reset};	1954	return 1e99 if $self->{deny_reset};
1589		1955
1590	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1956	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1591	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1957	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1592		1958
…		…
1603	my ($self) = @_;	1969	my ($self) = @_;
1604		1970
1605	my $lock = cf::lock_acquire "map_data:$self->{path}";	1971	my $lock = cf::lock_acquire "map_data:$self->{path}";
1606		1972
1607	return if $self->players;	1973	return if $self->players;
1608	return if $self->isa ("ext::map_per_player");#d#
1609		1974
1610	warn "resetting map ", $self->path;#d#	1975	warn "resetting map ", $self->path;
1611		1976
1612	$self->in_memory (cf::MAP_SWAPPED);	1977	$self->in_memory (cf::MAP_SWAPPED);
1613		1978
1614	# need to save uniques path	1979	# need to save uniques path
1615	unless ($self->{deny_save}) {	1980	unless ($self->{deny_save}) {
…		…
1647	$cf::MAP{$self->path} = $self;	2012	$cf::MAP{$self->path} = $self;
1648		2013
1649	$self->reset; # polite request, might not happen	2014	$self->reset; # polite request, might not happen
1650	}	2015	}
1651		2016
		2017	=item $maps = cf::map::tmp_maps
		2018
		2019	Returns an arrayref with all map paths of currently instantiated and saved
		2020	maps. May block.
		2021
		2022	=cut
		2023
		2024	sub tmp_maps() {
		2025	[
		2026	map {
		2027	utf8::decode $_;
		2028	/\.map$/
		2029	? normalise $_
		2030	: ()
		2031	} @{ aio_readdir $TMPDIR or [] }
		2032	]
		2033	}
		2034
		2035	=item $maps = cf::map::random_maps
		2036
		2037	Returns an arrayref with all map paths of currently instantiated and saved
		2038	random maps. May block.
		2039
		2040	=cut
		2041
		2042	sub random_maps() {
		2043	[
		2044	map {
		2045	utf8::decode $_;
		2046	/\.map$/
		2047	? normalise "?random/$_"
		2048	: ()
		2049	} @{ aio_readdir $RANDOMDIR or [] }
		2050	]
		2051	}
		2052
1652	=item cf::map::unique_maps	2053	=item cf::map::unique_maps
1653		2054
1654	Returns an arrayref of paths of all shared maps that have	2055	Returns an arrayref of paths of all shared maps that have
1655	instantiated unique items. May block.	2056	instantiated unique items. May block.
1656		2057
1657	=cut	2058	=cut
1658		2059
1659	sub unique_maps() {	2060	sub unique_maps() {
1660	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2061	[
1661	or return;	2062	map {
1662
1663	my @paths;
1664
1665	for (@$files) {
1666	utf8::decode $_;	2063	utf8::decode $_;
1667	next if /\.pst$/;	2064	/\.map$/
1668	next unless /^$PATH_SEP/o;	2065	? normalise $_
1669		2066	: ()
1670	push @paths, cf::map::normalise $_;	2067	} @{ aio_readdir $UNIQUEDIR or [] }
1671	}	2068	]
1672
1673	\@paths
1674	}	2069	}
1675		2070
1676	package cf;	2071	package cf;
1677		2072
1678	=back	2073	=back
…		…
1724		2119
1725	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2120	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1726		2121
1727	if ($self->{record_replies}) {	2122	if ($self->{record_replies}) {
1728	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2123	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2124
1729	} else {	2125	} else {
		2126	my $pl = $self->contr;
		2127
		2128	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2129	my $diag = $pl->{npc_dialog};
		2130	$diag->{pl}->ext_reply (
		2131	$diag->{id},
		2132	msgtype => "reply",
		2133	msg => $diag->{pl}->expand_cfpod ($msg),
		2134	add_topics => []
		2135	);
		2136
		2137	} else {
1730	$msg = $npc->name . " says: $msg" if $npc;	2138	$msg = $npc->name . " says: $msg" if $npc;
1731	$self->message ($msg, $flags);	2139	$self->message ($msg, $flags);
		2140	}
1732	}	2141	}
1733	}	2142	}
1734		2143
1735	=item $player_object->may ("access")	2144	=item $player_object->may ("access")
1736		2145
…		…
1784	$self->deactivate_recursive;	2193	$self->deactivate_recursive;
1785		2194
1786	return if UNIVERSAL::isa $self->map, "ext::map_link";	2195	return if UNIVERSAL::isa $self->map, "ext::map_link";
1787		2196
1788	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2197	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1789	if $self->map;	2198	if $self->map && $self->map->{path} ne "{link}";
1790		2199
1791	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2200	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1792	}	2201	}
1793		2202
1794	sub cf::object::player::leave_link {	2203	sub cf::object::player::leave_link {
1795	my ($self, $map, $x, $y) = @_;	2204	my ($self, $map, $x, $y) = @_;
		2205
		2206	return unless $self->contr->active;
1796		2207
1797	my $link_pos = delete $self->{_link_pos};	2208	my $link_pos = delete $self->{_link_pos};
1798		2209
1799	unless ($map) {	2210	unless ($map) {
1800	# restore original map position	2211	# restore original map position
…		…
1823		2234
1824	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2235	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1825	$self->enter_map ($map, $x, $y);	2236	$self->enter_map ($map, $x, $y);
1826	}	2237	}
1827		2238
1828	cf::player->attach (
1829	on_logout => sub {
1830	my ($pl) = @_;
1831
1832	# abort map switching before logout
1833	if ($pl->ob->{_link_pos}) {
1834	cf::sync_job {
1835	$pl->ob->leave_link
1836	};
1837	}
1838	},
1839	on_login => sub {
1840	my ($pl) = @_;
1841
1842	# try to abort aborted map switching on player login :)
1843	# should happen only on crashes
1844	if ($pl->ob->{_link_pos}) {
1845	$pl->ob->enter_link;
1846	(async {
1847	$pl->ob->reply (undef,
1848	"There was an internal problem at your last logout, "
1849	. "the server will try to bring you to your intended destination in a second.",
1850	cf::NDI_RED);
1851	# we need this sleep as the login has a concurrent enter_exit running
1852	# and this sleep increases chances of the player not ending up in scorn
1853	Coro::Timer::sleep 1;
1854	$pl->ob->leave_link;
1855	})->prio (2);
1856	}
1857	},
1858	);
1859
1860	=item $player_object->goto ($path, $x, $y)	2239	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1861		2240
		2241	Moves the player to the given map-path and coordinates by first freezing
		2242	her, loading and preparing them map, calling the provided $check callback
		2243	that has to return the map if sucecssful, and then unfreezes the player on
		2244	the new (success) or old (failed) map position.
		2245
1862	=cut	2246	=cut
		2247
		2248	our $GOTOGEN;
1863		2249
1864	sub cf::object::player::goto {	2250	sub cf::object::player::goto {
1865	my ($self, $path, $x, $y) = @_;	2251	my ($self, $path, $x, $y, $check) = @_;
		2252
		2253	# do generation counting so two concurrent goto's will be executed in-order
		2254	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1866		2255
1867	$self->enter_link;	2256	$self->enter_link;
1868		2257
1869	(async {	2258	(async {
1870	my $map = eval {	2259	my $map = eval {
1871	my $map = cf::map::find $path;	2260	my $map = cf::map::find $path;
		2261
		2262	if ($map) {
1872	$map = $map->customise_for ($self) if $map;	2263	$map = $map->customise_for ($self);
		2264	$map = $check->($map) if $check && $map;
		2265	} else {
		2266	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2267	}
		2268
1873	$map	2269	$map
		2270	};
		2271
		2272	if ($@) {
		2273	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2274	LOG llevError | logBacktrace, Carp::longmess $@;
1874	} or	2275	}
1875	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1876		2276
		2277	if ($gen == $self->{_goto_generation}) {
		2278	delete $self->{_goto_generation};
1877	$self->leave_link ($map, $x, $y);	2279	$self->leave_link ($map, $x, $y);
		2280	}
1878	})->prio (1);	2281	})->prio (1);
1879	}	2282	}
1880		2283
1881	=item $player_object->enter_exit ($exit_object)	2284	=item $player_object->enter_exit ($exit_object)
1882		2285
…		…
1921		2324
1922	$rmp->{random_seed} ||= $exit->random_seed;	2325	$rmp->{random_seed} ||= $exit->random_seed;
1923		2326
1924	my $data = cf::to_json $rmp;	2327	my $data = cf::to_json $rmp;
1925	my $md5 = Digest::MD5::md5_hex $data;	2328	my $md5 = Digest::MD5::md5_hex $data;
1926	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2329	my $meta = "$RANDOMDIR/$md5.meta";
1927		2330
1928	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2331	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1929	aio_write $fh, 0, (length $data), $data, 0;	2332	aio_write $fh, 0, (length $data), $data, 0;
1930	undef $fh;	2333	undef $fh;
1931	aio_rename "$meta~", $meta;	2334	aio_rename "$meta~", $meta;
…		…
1940		2343
1941	return unless $self->type == cf::PLAYER;	2344	return unless $self->type == cf::PLAYER;
1942		2345
1943	if ($exit->slaying eq "/!") {	2346	if ($exit->slaying eq "/!") {
1944	#TODO: this should de-fi-ni-te-ly not be a sync-job	2347	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2348	# the problem is that $exit might not survive long enough
		2349	# so it needs to be done right now, right here
1945	cf::sync_job { prepare_random_map $exit };	2350	cf::sync_job { prepare_random_map $exit };
1946	}	2351	}
1947		2352
1948	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2353	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1949	my $hp = $exit->stats->hp;	2354	my $hp = $exit->stats->hp;
…		…
1957	$self->goto ($slaying, $hp, $sp);	2362	$self->goto ($slaying, $hp, $sp);
1958		2363
1959	1;	2364	1;
1960	}) {	2365	}) {
1961	$self->message ("Something went wrong deep within the crossfire server. "	2366	$self->message ("Something went wrong deep within the crossfire server. "
1962	. "I'll try to bring you back to the map you were before. "	2367	. "I'll try to bring you back to the map you were before. "
1963	. "Please report this to the dungeon master!",	2368	. "Please report this to the dungeon master!",
1964	cf::NDI_UNIQUE | cf::NDI_RED);	2369	cf::NDI_UNIQUE | cf::NDI_RED);
1965		2370
1966	warn "ERROR in enter_exit: $@";	2371	warn "ERROR in enter_exit: $@";
1967	$self->leave_link;	2372	$self->leave_link;
1968	}	2373	}
1969	})->prio (1);	2374	})->prio (1);
…		…
1982		2387
1983	sub cf::client::send_drawinfo {	2388	sub cf::client::send_drawinfo {
1984	my ($self, $text, $flags) = @_;	2389	my ($self, $text, $flags) = @_;
1985		2390
1986	utf8::encode $text;	2391	utf8::encode $text;
1987	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2392	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1988	}	2393	}
1989		2394
		2395	=item $client->send_msg ($color, $type, $msg, [extra...])
		2396
		2397	Send a drawinfo or msg packet to the client, formatting the msg for the
		2398	client if neccessary. C<$type> should be a string identifying the type of
		2399	the message, with C<log> being the default. If C<$color> is negative, suppress
		2400	the message unless the client supports the msg packet.
		2401
		2402	=cut
		2403
		2404	sub cf::client::send_msg {
		2405	my ($self, $color, $type, $msg, @extra) = @_;
		2406
		2407	$msg = $self->pl->expand_cfpod ($msg);
		2408
		2409	if ($self->can_msg) {
		2410	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2411	} else {
		2412	# replace some tags by gcfclient-compatible ones
		2413	for ($msg) {
		2414	1 while
		2415	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2416	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2417	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2418	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2419	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2420	}
		2421
		2422	if ($color >= 0) {
		2423	if (0 && $msg =~ /\[/) {
		2424	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2425	} else {
		2426	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2427	$self->send_packet ("drawinfo $color $msg")
		2428	}
		2429	}
		2430	}
		2431	}
		2432
		2433	=item $client->ext_event ($type, %msg)
		2434
		2435	Sends an ext event to the client.
		2436
		2437	=cut
		2438
		2439	sub cf::client::ext_event($$%) {
		2440	my ($self, $type, %msg) = @_;
		2441
		2442	$msg{msgtype} = "event_$type";
		2443	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2444	}
1990		2445
1991	=item $success = $client->query ($flags, "text", \&cb)	2446	=item $success = $client->query ($flags, "text", \&cb)
1992		2447
1993	Queues a query to the client, calling the given callback with	2448	Queues a query to the client, calling the given callback with
1994	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2449	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1995	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2450	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1996		2451
1997	Queries can fail, so check the return code. Or don't, as queries will become	2452	Queries can fail, so check the return code. Or don't, as queries will
1998	reliable at some point in the future.	2453	become reliable at some point in the future.
1999		2454
2000	=cut	2455	=cut
2001		2456
2002	sub cf::client::query {	2457	sub cf::client::query {
2003	my ($self, $flags, $text, $cb) = @_;	2458	my ($self, $flags, $text, $cb) = @_;
…		…
2011	utf8::encode $text;	2466	utf8::encode $text;
2012	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2467	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2013		2468
2014	$self->send_packet ($self->{query_queue}[0][0])	2469	$self->send_packet ($self->{query_queue}[0][0])
2015	if @{ $self->{query_queue} } == 1;	2470	if @{ $self->{query_queue} } == 1;
		2471
		2472	1
2016	}	2473	}
2017		2474
2018	cf::client->attach (	2475	cf::client->attach (
		2476	on_connect => sub {
		2477	my ($ns) = @_;
		2478
		2479	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2480	},
2019	on_reply => sub {	2481	on_reply => sub {
2020	my ($ns, $msg) = @_;	2482	my ($ns, $msg) = @_;
2021		2483
2022	# this weird shuffling is so that direct followup queries	2484	# this weird shuffling is so that direct followup queries
2023	# get handled first	2485	# get handled first
…		…
2035	} else {	2497	} else {
2036	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2498	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2037	}	2499	}
2038	}	2500	}
2039	},	2501	},
		2502	on_exticmd => sub {
		2503	my ($ns, $buf) = @_;
		2504
		2505	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2506
		2507	if (ref $msg) {
		2508	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2509	if (my %reply = $cb->($ns, $msg)) {
		2510	$reply{msgid} = $msg->{msgid};
		2511	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2512	}
		2513	}
		2514	} else {
		2515	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2516	}
		2517
		2518	cf::override;
		2519	},
2040	);	2520	);
2041		2521
2042	=item $client->async (\&cb)	2522	=item $client->async (\&cb)
2043		2523
2044	Create a new coroutine, running the specified callback. The coroutine will	2524	Create a new coroutine, running the specified callback. The coroutine will
…		…
2091		2571
2092	# here we export the classes and methods available to script code	2572	# here we export the classes and methods available to script code
2093		2573
2094	=pod	2574	=pod
2095		2575
2096	The following fucntions and emthods are available within a safe environment:	2576	The following functions and methods are available within a safe environment:
2097		2577
2098	cf::object contr pay_amount pay_player map	2578	cf::object contr pay_amount pay_player map
2099	cf::object::player player	2579	cf::object::player player
2100	cf::player peaceful	2580	cf::player peaceful
2101	cf::map trigger	2581	cf::map trigger
…		…
2182	=back	2662	=back
2183		2663
2184	=cut	2664	=cut
2185		2665
2186	#############################################################################	2666	#############################################################################
2187
2188	=head2 EXTENSION DATABASE SUPPORT
2189
2190	Crossfire maintains a very simple database for extension use. It can
2191	currently store anything that can be serialised using Storable, which
2192	excludes objects.
2193
2194	The parameter C<$family> should best start with the name of the extension
2195	using it, it should be unique.
2196
2197	=over 4
2198
2199	=item $value = cf::db_get $family => $key
2200
2201	Returns a single value from the database.
2202
2203	=item cf::db_put $family => $key => $value
2204
2205	Stores the given C<$value> in the family.
2206
2207	=cut
2208
2209	our $DB;
2210
2211	sub db_init {
2212	unless ($DB) {
2213	$DB = BDB::db_create $DB_ENV;
2214
2215	cf::sync_job {
2216	eval {
2217	$DB->set_flags (BDB::CHKSUM);
2218
2219	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2220	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2221	cf::cleanup "db_open(db): $!" if $!;
2222	};
2223	cf::cleanup "db_open(db): $@" if $@;
2224	};
2225
2226	my $path = cf::localdir . "/database.pst";
2227	if (stat $path) {
2228	cf::sync_job {
2229	my $pst = Storable::retrieve $path;
2230
2231	cf::db_put (board => data => $pst->{board});
2232	cf::db_put (guildrules => data => $pst->{guildrules});
2233	cf::db_put (rent => balance => $pst->{rent}{balance});
2234	BDB::db_env_txn_checkpoint $DB_ENV;
2235
2236	unlink $path;
2237	};
2238	}
2239	}
2240	}
2241
2242	sub db_get($$) {
2243	my $key = "$_[0]/$_[1]";
2244
2245	cf::sync_job {
2246	BDB::db_get $DB, undef, $key, my $data;
2247
2248	$! ? ()
2249	: Compress::LZF::sthaw $data
2250	}
2251	}
2252
2253	sub db_put($$$) {
2254	BDB::dbreq_pri 4;
2255	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2256	}
2257
2258	#############################################################################
2259	# the server's init and main functions	2667	# the server's init and main functions
2260		2668
2261	sub load_resources {	2669	sub load_facedata($) {
2262	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2670	my ($path) = @_;
		2671
		2672	warn "loading facedata from $path\n";
		2673
		2674	my $facedata;
		2675	0 < aio_load $path, $facedata
		2676	or die "$path: $!";
		2677
		2678	$facedata = Coro::Storable::thaw $facedata;
		2679
		2680	$facedata->{version} == 2
		2681	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2682
		2683	{
		2684	my $faces = $facedata->{faceinfo};
		2685
		2686	while (my ($face, $info) = each %$faces) {
		2687	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2688	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2689	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2690	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2691	Coro::cede;
		2692	}
		2693
		2694	while (my ($face, $info) = each %$faces) {
		2695	next unless $info->{smooth};
		2696	my $idx = cf::face::find $face
		2697	or next;
		2698	if (my $smooth = cf::face::find $info->{smooth}) {
		2699	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2700	} else {
		2701	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2702	}
		2703	Coro::cede;
		2704	}
		2705	}
		2706
		2707	{
		2708	my $anims = $facedata->{animinfo};
		2709
		2710	while (my ($anim, $info) = each %$anims) {
		2711	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2712	Coro::cede;
		2713	}
		2714
		2715	cf::anim::invalidate_all; # d'oh
		2716	}
		2717
		2718	1
		2719	}
		2720
		2721	sub reload_regions {
		2722	load_resource_file "$MAPDIR/regions"
2263	or die "unable to load regions file\n";#d#	2723	or die "unable to load regions file\n";
		2724	}
		2725
		2726	sub reload_facedata {
		2727	load_facedata "$DATADIR/facedata"
		2728	or die "unable to load facedata\n";
		2729	}
		2730
		2731	sub reload_archetypes {
		2732	load_resource_file "$DATADIR/archetypes"
		2733	or die "unable to load archetypes\n";
		2734	#d# NEED to laod twice to resolve forward references
		2735	# this really needs to be done in an extra post-pass
		2736	# (which needs to be synchronous, so solve it differently)
		2737	load_resource_file "$DATADIR/archetypes"
		2738	or die "unable to load archetypes\n";
		2739	}
		2740
		2741	sub reload_treasures {
		2742	load_resource_file "$DATADIR/treasures"
		2743	or die "unable to load treasurelists\n";
		2744	}
		2745
		2746	sub reload_resources {
		2747	warn "reloading resource files...\n";
		2748
		2749	reload_regions;
		2750	reload_facedata;
		2751	#reload_archetypes;#d#
		2752	reload_archetypes;
		2753	reload_treasures;
		2754
		2755	warn "finished reloading resource files\n";
		2756	}
		2757
		2758	sub init {
		2759	reload_resources;
2264	}	2760	}
2265		2761
2266	sub cfg_load {	2762	sub cfg_load {
2267	open my $fh, "<:utf8", cf::confdir . "/config"	2763	open my $fh, "<:utf8", "$CONFDIR/config"
2268	or return;	2764	or return;
2269		2765
2270	local $/;	2766	local $/;
2271	*CFG = YAML::Syck::Load <$fh>;	2767	*CFG = YAML::Syck::Load <$fh>;
2272		2768
…		…
2280	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2776	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2281	and die "WARNING: m(un)lockall failed: $!\n";	2777	and die "WARNING: m(un)lockall failed: $!\n";
2282	};	2778	};
2283	warn $@ if $@;	2779	warn $@ if $@;
2284	}	2780	}
2285	}
2286
2287	sub init {
2288	load_resources;
2289	}	2781	}
2290		2782
2291	sub main {	2783	sub main {
2292	# we must not ever block the main coroutine	2784	# we must not ever block the main coroutine
2293	local $Coro::idle = sub {	2785	local $Coro::idle = sub {
…		…
2321	},	2813	},
2322	);	2814	);
2323	}	2815	}
2324	}	2816	}
2325		2817
		2818	sub write_runtime {
		2819	my $runtime = "$LOCALDIR/runtime";
		2820
		2821	# first touch the runtime file to show we are still running:
		2822	# the fsync below can take a very very long time.
		2823
		2824	IO::AIO::aio_utime $runtime, undef, undef;
		2825
		2826	my $guard = cf::lock_acquire "write_runtime";
		2827
		2828	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2829	or return;
		2830
		2831	my $value = $cf::RUNTIME + 90 + 10;
		2832	# 10 is the runtime save interval, for a monotonic clock
		2833	# 60 allows for the watchdog to kill the server.
		2834
		2835	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2836	and return;
		2837
		2838	# always fsync - this file is important
		2839	aio_fsync $fh
		2840	and return;
		2841
		2842	# touch it again to show we are up-to-date
		2843	aio_utime $fh, undef, undef;
		2844
		2845	close $fh
		2846	or return;
		2847
		2848	aio_rename "$runtime~", $runtime
		2849	and return;
		2850
		2851	warn "runtime file written.\n";
		2852
		2853	1
		2854	}
		2855
2326	sub emergency_save() {	2856	sub emergency_save() {
2327	my $freeze_guard = cf::freeze_mainloop;	2857	my $freeze_guard = cf::freeze_mainloop;
2328		2858
2329	warn "enter emergency perl save\n";	2859	warn "enter emergency perl save\n";
2330		2860
…		…
2361		2891
2362	warn Carp::longmess "post_cleanup backtrace"	2892	warn Carp::longmess "post_cleanup backtrace"
2363	if $make_core;	2893	if $make_core;
2364	}	2894	}
2365		2895
2366	sub reload() {	2896	sub do_reload_perl() {
2367	# can/must only be called in main	2897	# can/must only be called in main
2368	if ($Coro::current != $Coro::main) {	2898	if ($Coro::current != $Coro::main) {
2369	warn "can only reload from main coroutine";	2899	warn "can only reload from main coroutine";
2370	return;	2900	return;
2371	}	2901	}
…		…
2396	Coro::cede;	2926	Coro::cede;
2397	last unless IO::AIO::nreqs || BDB::nreqs;	2927	last unless IO::AIO::nreqs || BDB::nreqs;
2398	warn "iterate...";	2928	warn "iterate...";
2399	}	2929	}
2400		2930
		2931	++$RELOAD;
		2932
2401	warn "cancelling all extension coros";	2933	warn "cancelling all extension coros";
2402	$_->cancel for values %EXT_CORO;	2934	$_->cancel for values %EXT_CORO;
2403	%EXT_CORO = ();	2935	%EXT_CORO = ();
2404		2936
2405	warn "removing commands";	2937	warn "removing commands";
2406	%COMMAND = ();	2938	%COMMAND = ();
2407		2939
2408	warn "removing ext commands";	2940	warn "removing ext/exti commands";
2409	%EXTCMD = ();	2941	%EXTCMD = ();
		2942	%EXTICMD = ();
2410		2943
2411	warn "unloading/nuking all extensions";	2944	warn "unloading/nuking all extensions";
2412	for my $pkg (@EXTS) {	2945	for my $pkg (@EXTS) {
2413	warn "... unloading $pkg";	2946	warn "... unloading $pkg";
2414		2947
…		…
2444	Symbol::delete_package "safe::$_"	2977	Symbol::delete_package "safe::$_"
2445	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2978	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2446		2979
2447	warn "unloading cf.pm \"a bit\"";	2980	warn "unloading cf.pm \"a bit\"";
2448	delete $INC{"cf.pm"};	2981	delete $INC{"cf.pm"};
		2982	delete $INC{"cf/pod.pm"};
2449		2983
2450	# don't, removes xs symbols, too,	2984	# don't, removes xs symbols, too,
2451	# and global variables created in xs	2985	# and global variables created in xs
2452	#Symbol::delete_package __PACKAGE__;	2986	#Symbol::delete_package __PACKAGE__;
2453		2987
…		…
2462		2996
2463	warn "loading extensions";	2997	warn "loading extensions";
2464	cf::load_extensions;	2998	cf::load_extensions;
2465		2999
2466	warn "reattaching attachments to objects/players";	3000	warn "reattaching attachments to objects/players";
2467	_global_reattach;	3001	_global_reattach; # objects, sockets
2468	warn "reattaching attachments to maps";	3002	warn "reattaching attachments to maps";
2469	reattach $_ for values %MAP;	3003	reattach $_ for values %MAP;
2470		3004	warn "reattaching attachments to players";
2471	warn "loading reloadable resources";	3005	reattach $_ for values %PLAYER;
2472	load_resources;
2473		3006
2474	warn "leaving sync_job";	3007	warn "leaving sync_job";
2475		3008
2476	1	3009	1
2477	} or do {	3010	} or do {
…		…
2483	warn "reloaded";	3016	warn "reloaded";
2484	};	3017	};
2485		3018
2486	our $RELOAD_WATCHER; # used only during reload	3019	our $RELOAD_WATCHER; # used only during reload
2487		3020
		3021	sub reload_perl() {
		3022	# doing reload synchronously and two reloads happen back-to-back,
		3023	# coro crashes during coro_state_free->destroy here.
		3024
		3025	$RELOAD_WATCHER ||= Event->timer (
		3026	reentrant => 0,
		3027	after => 0,
		3028	data => WF_AUTOCANCEL,
		3029	cb => sub {
		3030	do_reload_perl;
		3031	undef $RELOAD_WATCHER;
		3032	},
		3033	);
		3034	}
		3035
2488	register_command "reload" => sub {	3036	register_command "reload" => sub {
2489	my ($who, $arg) = @_;	3037	my ($who, $arg) = @_;
2490		3038
2491	if ($who->flag (FLAG_WIZ)) {	3039	if ($who->flag (FLAG_WIZ)) {
2492	$who->message ("reloading server.");	3040	$who->message ("reloading server.");
2493		3041	async { reload_perl };
2494	# doing reload synchronously and two reloads happen back-to-back,
2495	# coro crashes during coro_state_free->destroy here.
2496
2497	$RELOAD_WATCHER ||= Event->timer (
2498	reentrant => 0,
2499	after => 0,
2500	data => WF_AUTOCANCEL,
2501	cb => sub {
2502	reload;
2503	undef $RELOAD_WATCHER;
2504	},
2505	);
2506	}	3042	}
2507	};	3043	};
2508		3044
2509	unshift @INC, $LIBDIR;	3045	unshift @INC, $LIBDIR;
2510		3046
2511	my $bug_warning = 0;	3047	my $bug_warning = 0;
2512		3048
		3049	our @WAIT_FOR_TICK;
		3050	our @WAIT_FOR_TICK_BEGIN;
		3051
		3052	sub wait_for_tick {
		3053	return unless $TICK_WATCHER->is_active;
		3054	return if $Coro::current == $Coro::main;
		3055
		3056	my $signal = new Coro::Signal;
		3057	push @WAIT_FOR_TICK, $signal;
		3058	$signal->wait;
		3059	}
		3060
		3061	sub wait_for_tick_begin {
		3062	return unless $TICK_WATCHER->is_active;
		3063	return if $Coro::current == $Coro::main;
		3064
		3065	my $signal = new Coro::Signal;
		3066	push @WAIT_FOR_TICK_BEGIN, $signal;
		3067	$signal->wait;
		3068	}
		3069
		3070	my $min = 1e6;#d#
		3071	my $avg = 10;
2513	$TICK_WATCHER = Event->timer (	3072	$TICK_WATCHER = Event->timer (
2514	reentrant => 0,	3073	reentrant => 0,
2515	parked => 1,	3074	parked => 1,
2516	prio => 0,	3075	prio => 0,
2517	at => $NEXT_TICK || $TICK,	3076	at => $NEXT_TICK || $TICK,
…		…
2521	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3080	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2522	unless ++$bug_warning > 10;	3081	unless ++$bug_warning > 10;
2523	return;	3082	return;
2524	}	3083	}
2525		3084
2526	$NOW = Event::time;	3085	$NOW = $tick_start = Event::time;
2527		3086
2528	cf::server_tick; # one server iteration	3087	cf::server_tick; # one server iteration
		3088
		3089	0 && sync_job {#d#
		3090	for(1..10) {
		3091	my $t = Event::time;
		3092	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3093	or die;
		3094
		3095	$map->width (50);
		3096	$map->height (50);
		3097	$map->alloc;
		3098	$map->_load_objects ("/tmp/x.map", 1);
		3099	my $t = Event::time - $t;
		3100
		3101	#next unless $t < 0.0013;#d#
		3102	if ($t < $min) {
		3103	$min = $t;
		3104	}
		3105	$avg = $avg * 0.99 + $t * 0.01;
		3106	}
		3107	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3108	exit 0;
		3109	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3110	};
		3111
2529	$RUNTIME += $TICK;	3112	$RUNTIME += $TICK;
2530	$NEXT_TICK += $TICK;	3113	$NEXT_TICK += $TICK;
2531		3114
2532	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3115	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2533	$NEXT_RUNTIME_WRITE = $NOW + 10;	3116	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2535	write_runtime	3118	write_runtime
2536	or warn "ERROR: unable to write runtime file: $!";	3119	or warn "ERROR: unable to write runtime file: $!";
2537	};	3120	};
2538	}	3121	}
2539		3122
2540
2541	$WAIT_FOR_TICK->broadcast;
2542	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2543
2544	# my $AFTER = Event::time;	3123	# my $AFTER = Event::time;
2545	# warn $AFTER - $NOW;#d#	3124	# warn $AFTER - $NOW;#d#
2546		3125
		3126	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3127	$sig->send;
		3128	}
		3129	while (my $sig = shift @WAIT_FOR_TICK) {
		3130	$sig->send;
		3131	}
		3132
		3133	$NOW = Event::time;
		3134
2547	# if we are delayed by four ticks or more, skip them all	3135	# if we are delayed by four ticks or more, skip them all
2548	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3136	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2549		3137
2550	$TICK_WATCHER->at ($NEXT_TICK);	3138	$TICK_WATCHER->at ($NEXT_TICK);
2551	$TICK_WATCHER->start;	3139	$TICK_WATCHER->start;
		3140
		3141	$LOAD = ($NOW - $tick_start) / $TICK;
		3142	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3143
		3144	_post_tick;
		3145
		3146
2552	},	3147	},
2553	);	3148	);
2554		3149
2555	{	3150	{
2556	BDB::max_poll_time $TICK * 0.1;	3151	BDB::max_poll_time $TICK * 0.1;
…		…
2584		3179
2585	cf::sync_job {	3180	cf::sync_job {
2586	eval {	3181	eval {
2587	BDB::db_env_open	3182	BDB::db_env_open
2588	$DB_ENV,	3183	$DB_ENV,
2589	$BDB_ENV_DIR,	3184	$BDBDIR,
2590	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3185	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2591	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3186	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2592	0666;	3187	0666;
2593		3188
2594	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3189	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2595		3190
2596	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3191	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2597	$DB_ENV->set_lk_detect;	3192	$DB_ENV->set_lk_detect;
2598	};	3193	};
2599		3194
…		…
2615	prio => 6,	3210	prio => 6,
2616	cb => \&IO::AIO::poll_cb,	3211	cb => \&IO::AIO::poll_cb,
2617	);	3212	);
2618	}	3213	}
2619		3214
		3215	my $_log_backtrace;
		3216
		3217	sub _log_backtrace {
		3218	my ($msg, @addr) = @_;
		3219
		3220	$msg =~ s/\n//;
		3221
		3222	# limit the # of concurrent backtraces
		3223	if ($_log_backtrace < 2) {
		3224	++$_log_backtrace;
		3225	async {
		3226	my @bt = fork_call {
		3227	@addr = map { sprintf "%x", $_ } @addr;
		3228	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3229	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3230	or die "addr2line: $!";
		3231
		3232	my @funcs;
		3233	my @res = <$fh>;
		3234	chomp for @res;
		3235	while (@res) {
		3236	my ($func, $line) = splice @res, 0, 2, ();
		3237	push @funcs, "[$func] $line";
		3238	}
		3239
		3240	@funcs
		3241	};
		3242
		3243	LOG llevInfo, "[ABT] $msg\n";
		3244	LOG llevInfo, "[ABT] $_\n" for @bt;
		3245	--$_log_backtrace;
		3246	};
		3247	} else {
		3248	LOG llevInfo, "[ABT] $msg\n";
		3249	LOG llevInfo, "[ABT] [suppressed]\n";
		3250	}
		3251	}
		3252
		3253	# load additional modules
		3254	use cf::pod;
		3255
2620	END { cf::emergency_save }	3256	END { cf::emergency_save }
2621		3257
2622	1	3258	1
2623		3259

Diff Legend

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