ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.214 by root, Wed Feb 14 00:40:05 2007 UTC vs.
Revision 1.293 by root, Tue Jul 3 05:14:15 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	s/^\s+//;
		1420	s/\s+$//;
		1421
		1422	$_
		1423	}
		1424
		1425	sub hintmode {
		1426	$_[0]{hintmode} = $_[1] if @_ > 1;
		1427	$_[0]{hintmode}
		1428	}
		1429
1111	=item $player->ext_reply ($msgid, $msgtype, %msg)	1430	=item $player->ext_reply ($msgid, %msg)
1112		1431
1113	Sends an ext reply to the player.	1432	Sends an ext reply to the player.
1114		1433
1115	=cut	1434	=cut
1116		1435
1117	sub ext_reply($$$%) {	1436	sub ext_reply($$%) {
1118	my ($self, $id, %msg) = @_;	1437	my ($self, $id, %msg) = @_;
1119		1438
1120	$msg{msgid} = $id;	1439	$msg{msgid} = $id;
1121		1440	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1122	$self->send ("ext " . cf::to_json \%msg);
1123	}	1441	}
1124		1442
1125	package cf;	1443	=item $player->ext_event ($type, %msg)
		1444
		1445	Sends an ext event to the client.
		1446
		1447	=cut
		1448
		1449	sub ext_event($$%) {
		1450	my ($self, $type, %msg) = @_;
		1451
		1452	$self->ns->ext_event ($type, %msg);
		1453	}
		1454
		1455	=head3 cf::region
		1456
		1457	=over 4
		1458
		1459	=cut
		1460
		1461	package cf::region;
		1462
		1463	=item cf::region::find_by_path $path
		1464
		1465	Tries to decuce the likely region for a map knowing only its path.
		1466
		1467	=cut
		1468
		1469	sub find_by_path($) {
		1470	my ($path) = @_;
		1471
		1472	my ($match, $specificity);
		1473
		1474	for my $region (list) {
		1475	if ($region->match && $path =~ $region->match) {
		1476	($match, $specificity) = ($region, $region->specificity)
		1477	if $region->specificity > $specificity;
		1478	}
		1479	}
		1480
		1481	$match
		1482	}
1126		1483
1127	=back	1484	=back
1128
1129		1485
1130	=head3 cf::map	1486	=head3 cf::map
1131		1487
1132	=over 4	1488	=over 4
1133		1489
…		…
1188	my ($self, $merge) = @_;	1544	my ($self, $merge) = @_;
1189		1545
1190	# we have to keep some variables in memory intact	1546	# we have to keep some variables in memory intact
1191	local $self->{path};	1547	local $self->{path};
1192	local $self->{load_path};	1548	local $self->{load_path};
1193	local $self->{deny_save};
1194	local $self->{deny_reset};
1195		1549
1196	$self->SUPER::thawer_merge ($merge);	1550	$self->SUPER::thawer_merge ($merge);
1197	}	1551	}
1198		1552
1199	sub normalise {	1553	sub normalise {
…		…
1271		1625
1272	# the original (read-only) location	1626	# the original (read-only) location
1273	sub load_path {	1627	sub load_path {
1274	my ($self) = @_;	1628	my ($self) = @_;
1275		1629
1276	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1630	"$MAPDIR/$self->{path}.map"
1277	}	1631	}
1278		1632
1279	# the temporary/swap location	1633	# the temporary/swap location
1280	sub save_path {	1634	sub save_path {
1281	my ($self) = @_;	1635	my ($self) = @_;
1282		1636
1283	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1637	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1284	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1638	"$TMPDIR/$path.map"
1285	}	1639	}
1286		1640
1287	# the unique path, undef == no special unique path	1641	# the unique path, undef == no special unique path
1288	sub uniq_path {	1642	sub uniq_path {
1289	my ($self) = @_;	1643	my ($self) = @_;
1290		1644
1291	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1645	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1292	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1646	"$UNIQUEDIR/$path"
1293	}	1647	}
1294		1648
1295	# and all this just because we cannot iterate over	1649	# and all this just because we cannot iterate over
1296	# all maps in C++...	1650	# all maps in C++...
1297	sub change_all_map_light {	1651	sub change_all_map_light {
…		…
1299		1653
1300	$_->change_map_light ($change)	1654	$_->change_map_light ($change)
1301	for grep $_->outdoor, values %cf::MAP;	1655	for grep $_->outdoor, values %cf::MAP;
1302	}	1656	}
1303		1657
		1658	sub decay_objects {
		1659	my ($self) = @_;
		1660
		1661	return if $self->{deny_reset};
		1662
		1663	$self->do_decay_objects;
		1664	}
		1665
1304	sub unlink_save {	1666	sub unlink_save {
1305	my ($self) = @_;	1667	my ($self) = @_;
1306		1668
1307	utf8::encode (my $save = $self->save_path);	1669	utf8::encode (my $save = $self->save_path);
1308	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1670	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1309	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1671	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	}	1672	}
1316		1673
1317	sub load_header_from($) {	1674	sub load_header_from($) {
1318	my ($self, $path) = @_;	1675	my ($self, $path) = @_;
1319		1676
…		…
1369	$self->load_header_orig	1726	$self->load_header_orig
1370	or return;	1727	or return;
1371	$self->prepare_orig;	1728	$self->prepare_orig;
1372	}	1729	}
1373		1730
		1731	$self->{deny_reset} = 1
		1732	if $self->no_reset;
		1733
		1734	$self->default_region (cf::region::find_by_path $self->{path})
		1735	unless $self->default_region;
		1736
1374	1	1737	1
1375	}	1738	}
1376		1739
1377	sub find;	1740	sub find;
1378	sub find {	1741	sub find {
…		…
1390	$map->{last_save} = $cf::RUNTIME;	1753	$map->{last_save} = $cf::RUNTIME;
1391		1754
1392	$map->load_header	1755	$map->load_header
1393	or return;	1756	or return;
1394		1757
1395	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1758	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1396	# doing this can freeze the server in a sync job, obviously	1759	# doing this can freeze the server in a sync job, obviously
1397	#$cf::WAIT_FOR_TICK->wait;	1760	#$cf::WAIT_FOR_TICK->wait;
1398	$map->reset;	1761	$map->reset;
1399	undef $guard;	1762	undef $guard;
1400	return find $path;	1763	return find $path;
…		…
1411	my ($self) = @_;	1774	my ($self) = @_;
1412		1775
1413	local $self->{deny_reset} = 1; # loading can take a long time	1776	local $self->{deny_reset} = 1; # loading can take a long time
1414		1777
1415	my $path = $self->{path};	1778	my $path = $self->{path};
		1779
		1780	{
1416	my $guard = cf::lock_acquire "map_load:$path";	1781	my $guard = cf::lock_acquire "map_load:$path";
1417		1782
1418	return if $self->in_memory != cf::MAP_SWAPPED;	1783	return if $self->in_memory != cf::MAP_SWAPPED;
1419		1784
1420	$self->in_memory (cf::MAP_LOADING);	1785	$self->in_memory (cf::MAP_LOADING);
1421		1786
1422	$self->alloc;	1787	$self->alloc;
1423		1788
1424	$self->pre_load;	1789	$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;	1790	Coro::cede;
1450	$self->set_darkness_map;	1791
		1792	$self->_load_objects ($self->{load_path}, 1)
		1793	or return;
		1794
		1795	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1796	if delete $self->{load_original};
		1797
		1798	if (my $uniq = $self->uniq_path) {
		1799	utf8::encode $uniq;
		1800	if (aio_open $uniq, O_RDONLY, 0) {
		1801	$self->clear_unique_items;
		1802	$self->_load_objects ($uniq, 0);
		1803	}
		1804	}
		1805
		1806	Coro::cede;
		1807	# now do the right thing for maps
		1808	$self->link_multipart_objects;
1451	$self->difficulty ($self->estimate_difficulty)	1809	$self->difficulty ($self->estimate_difficulty)
1452	unless $self->difficulty;	1810	unless $self->difficulty;
1453	Coro::cede;	1811	Coro::cede;
		1812
		1813	unless ($self->{deny_activate}) {
		1814	$self->decay_objects;
		1815	$self->fix_auto_apply;
		1816	$self->update_buttons;
		1817	Coro::cede;
		1818	$self->set_darkness_map;
		1819	Coro::cede;
1454	$self->activate;	1820	$self->activate;
		1821	}
		1822
		1823	$self->in_memory (cf::MAP_IN_MEMORY);
1455	}	1824	}
1456		1825
1457	$self->post_load;	1826	$self->post_load;
1458
1459	$self->in_memory (cf::MAP_IN_MEMORY);
1460	}	1827	}
1461		1828
1462	sub customise_for {	1829	sub customise_for {
1463	my ($self, $ob) = @_;	1830	my ($self, $ob) = @_;
1464		1831
1465	return find "~" . $ob->name . "/" . $self->{path}	1832	return find "~" . $ob->name . "/" . $self->{path}
1466	if $self->per_player;	1833	if $self->per_player;
		1834
		1835	# return find "?party/" . $ob->name . "/" . $self->{path}
		1836	# if $self->per_party;
1467		1837
1468	$self	1838	$self
1469	}	1839	}
1470		1840
1471	# find and load all maps in the 3x3 area around a map	1841	# find and load all maps in the 3x3 area around a map
…		…
1582		1952
1583	sub reset_at {	1953	sub reset_at {
1584	my ($self) = @_;	1954	my ($self) = @_;
1585		1955
1586	# TODO: safety, remove and allow resettable per-player maps	1956	# 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};	1957	return 1e99 if $self->{deny_reset};
1589		1958
1590	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1959	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1591	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1960	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1592		1961
…		…
1603	my ($self) = @_;	1972	my ($self) = @_;
1604		1973
1605	my $lock = cf::lock_acquire "map_data:$self->{path}";	1974	my $lock = cf::lock_acquire "map_data:$self->{path}";
1606		1975
1607	return if $self->players;	1976	return if $self->players;
1608	return if $self->isa ("ext::map_per_player");#d#
1609		1977
1610	warn "resetting map ", $self->path;#d#	1978	warn "resetting map ", $self->path;
1611		1979
1612	$self->in_memory (cf::MAP_SWAPPED);	1980	$self->in_memory (cf::MAP_SWAPPED);
1613		1981
1614	# need to save uniques path	1982	# need to save uniques path
1615	unless ($self->{deny_save}) {	1983	unless ($self->{deny_save}) {
…		…
1647	$cf::MAP{$self->path} = $self;	2015	$cf::MAP{$self->path} = $self;
1648		2016
1649	$self->reset; # polite request, might not happen	2017	$self->reset; # polite request, might not happen
1650	}	2018	}
1651		2019
		2020	=item $maps = cf::map::tmp_maps
		2021
		2022	Returns an arrayref with all map paths of currently instantiated and saved
		2023	maps. May block.
		2024
		2025	=cut
		2026
		2027	sub tmp_maps() {
		2028	[
		2029	map {
		2030	utf8::decode $_;
		2031	/\.map$/
		2032	? normalise $_
		2033	: ()
		2034	} @{ aio_readdir $TMPDIR or [] }
		2035	]
		2036	}
		2037
		2038	=item $maps = cf::map::random_maps
		2039
		2040	Returns an arrayref with all map paths of currently instantiated and saved
		2041	random maps. May block.
		2042
		2043	=cut
		2044
		2045	sub random_maps() {
		2046	[
		2047	map {
		2048	utf8::decode $_;
		2049	/\.map$/
		2050	? normalise "?random/$_"
		2051	: ()
		2052	} @{ aio_readdir $RANDOMDIR or [] }
		2053	]
		2054	}
		2055
1652	=item cf::map::unique_maps	2056	=item cf::map::unique_maps
1653		2057
1654	Returns an arrayref of paths of all shared maps that have	2058	Returns an arrayref of paths of all shared maps that have
1655	instantiated unique items. May block.	2059	instantiated unique items. May block.
1656		2060
1657	=cut	2061	=cut
1658		2062
1659	sub unique_maps() {	2063	sub unique_maps() {
1660	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2064	[
1661	or return;	2065	map {
1662
1663	my @paths;
1664
1665	for (@$files) {
1666	utf8::decode $_;	2066	utf8::decode $_;
1667	next if /\.pst$/;	2067	/\.map$/
1668	next unless /^$PATH_SEP/o;	2068	? normalise $_
1669		2069	: ()
1670	push @paths, cf::map::normalise $_;	2070	} @{ aio_readdir $UNIQUEDIR or [] }
1671	}	2071	]
1672
1673	\@paths
1674	}	2072	}
1675		2073
1676	package cf;	2074	package cf;
1677		2075
1678	=back	2076	=back
…		…
1724		2122
1725	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2123	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1726		2124
1727	if ($self->{record_replies}) {	2125	if ($self->{record_replies}) {
1728	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2126	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2127
1729	} else {	2128	} else {
		2129	my $pl = $self->contr;
		2130
		2131	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2132	my $diag = $pl->{npc_dialog};
		2133	$diag->{pl}->ext_reply (
		2134	$diag->{id},
		2135	msgtype => "reply",
		2136	msg => $diag->{pl}->expand_cfpod ($msg),
		2137	add_topics => []
		2138	);
		2139
		2140	} else {
1730	$msg = $npc->name . " says: $msg" if $npc;	2141	$msg = $npc->name . " says: $msg" if $npc;
1731	$self->message ($msg, $flags);	2142	$self->message ($msg, $flags);
		2143	}
1732	}	2144	}
1733	}	2145	}
1734		2146
1735	=item $player_object->may ("access")	2147	=item $player_object->may ("access")
1736		2148
…		…
1784	$self->deactivate_recursive;	2196	$self->deactivate_recursive;
1785		2197
1786	return if UNIVERSAL::isa $self->map, "ext::map_link";	2198	return if UNIVERSAL::isa $self->map, "ext::map_link";
1787		2199
1788	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2200	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1789	if $self->map;	2201	if $self->map && $self->map->{path} ne "{link}";
1790		2202
1791	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2203	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1792	}	2204	}
1793		2205
1794	sub cf::object::player::leave_link {	2206	sub cf::object::player::leave_link {
1795	my ($self, $map, $x, $y) = @_;	2207	my ($self, $map, $x, $y) = @_;
		2208
		2209	return unless $self->contr->active;
1796		2210
1797	my $link_pos = delete $self->{_link_pos};	2211	my $link_pos = delete $self->{_link_pos};
1798		2212
1799	unless ($map) {	2213	unless ($map) {
1800	# restore original map position	2214	# restore original map position
…		…
1818	$map->load;	2232	$map->load;
1819	$map->load_diag;	2233	$map->load_diag;
1820		2234
1821	return unless $self->contr->active;	2235	return unless $self->contr->active;
1822	$self->activate_recursive;	2236	$self->activate_recursive;
		2237
		2238	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1823	$self->enter_map ($map, $x, $y);	2239	$self->enter_map ($map, $x, $y);
1824	}	2240	}
1825		2241
1826	cf::player->attach (
1827	on_logout => sub {
1828	my ($pl) = @_;
1829
1830	# abort map switching before logout
1831	if ($pl->ob->{_link_pos}) {
1832	cf::sync_job {
1833	$pl->ob->leave_link
1834	};
1835	}
1836	},
1837	on_login => sub {
1838	my ($pl) = @_;
1839
1840	# try to abort aborted map switching on player login :)
1841	# should happen only on crashes
1842	if ($pl->ob->{_link_pos}) {
1843	$pl->ob->enter_link;
1844	(async {
1845	# we need this sleep as the login has a concurrent enter_exit running
1846	# and this sleep increases chances of the player not ending up in scorn
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	Coro::Timer::sleep 1;
1852	$pl->ob->leave_link;
1853	})->prio (2);
1854	}
1855	},
1856	);
1857
1858	=item $player_object->goto ($path, $x, $y)	2242	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1859		2243
		2244	Moves the player to the given map-path and coordinates by first freezing
		2245	her, loading and preparing them map, calling the provided $check callback
		2246	that has to return the map if sucecssful, and then unfreezes the player on
		2247	the new (success) or old (failed) map position.
		2248
1860	=cut	2249	=cut
		2250
		2251	our $GOTOGEN;
1861		2252
1862	sub cf::object::player::goto {	2253	sub cf::object::player::goto {
1863	my ($self, $path, $x, $y) = @_;	2254	my ($self, $path, $x, $y, $check) = @_;
		2255
		2256	# do generation counting so two concurrent goto's will be executed in-order
		2257	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1864		2258
1865	$self->enter_link;	2259	$self->enter_link;
1866		2260
1867	(async {	2261	(async {
1868	my $map = eval {	2262	my $map = eval {
1869	my $map = cf::map::find $path;	2263	my $map = cf::map::find $path;
		2264
		2265	if ($map) {
1870	$map = $map->customise_for ($self) if $map;	2266	$map = $map->customise_for ($self);
		2267	$map = $check->($map) if $check && $map;
		2268	} else {
		2269	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2270	}
		2271
1871	$map	2272	$map
		2273	};
		2274
		2275	if ($@) {
		2276	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2277	LOG llevError | logBacktrace, Carp::longmess $@;
1872	} or	2278	}
1873	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1874		2279
		2280	if ($gen == $self->{_goto_generation}) {
		2281	delete $self->{_goto_generation};
1875	$self->leave_link ($map, $x, $y);	2282	$self->leave_link ($map, $x, $y);
		2283	}
1876	})->prio (1);	2284	})->prio (1);
1877	}	2285	}
1878		2286
1879	=item $player_object->enter_exit ($exit_object)	2287	=item $player_object->enter_exit ($exit_object)
1880		2288
…		…
1919		2327
1920	$rmp->{random_seed} ||= $exit->random_seed;	2328	$rmp->{random_seed} ||= $exit->random_seed;
1921		2329
1922	my $data = cf::to_json $rmp;	2330	my $data = cf::to_json $rmp;
1923	my $md5 = Digest::MD5::md5_hex $data;	2331	my $md5 = Digest::MD5::md5_hex $data;
1924	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2332	my $meta = "$RANDOMDIR/$md5.meta";
1925		2333
1926	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2334	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1927	aio_write $fh, 0, (length $data), $data, 0;	2335	aio_write $fh, 0, (length $data), $data, 0;
1928	undef $fh;	2336	undef $fh;
1929	aio_rename "$meta~", $meta;	2337	aio_rename "$meta~", $meta;
…		…
1938		2346
1939	return unless $self->type == cf::PLAYER;	2347	return unless $self->type == cf::PLAYER;
1940		2348
1941	if ($exit->slaying eq "/!") {	2349	if ($exit->slaying eq "/!") {
1942	#TODO: this should de-fi-ni-te-ly not be a sync-job	2350	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2351	# the problem is that $exit might not survive long enough
		2352	# so it needs to be done right now, right here
1943	cf::sync_job { prepare_random_map $exit };	2353	cf::sync_job { prepare_random_map $exit };
1944	}	2354	}
1945		2355
1946	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2356	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1947	my $hp = $exit->stats->hp;	2357	my $hp = $exit->stats->hp;
…		…
1955	$self->goto ($slaying, $hp, $sp);	2365	$self->goto ($slaying, $hp, $sp);
1956		2366
1957	1;	2367	1;
1958	}) {	2368	}) {
1959	$self->message ("Something went wrong deep within the crossfire server. "	2369	$self->message ("Something went wrong deep within the crossfire server. "
1960	. "I'll try to bring you back to the map you were before. "	2370	. "I'll try to bring you back to the map you were before. "
1961	. "Please report this to the dungeon master!",	2371	. "Please report this to the dungeon master!",
1962	cf::NDI_UNIQUE | cf::NDI_RED);	2372	cf::NDI_UNIQUE | cf::NDI_RED);
1963		2373
1964	warn "ERROR in enter_exit: $@";	2374	warn "ERROR in enter_exit: $@";
1965	$self->leave_link;	2375	$self->leave_link;
1966	}	2376	}
1967	})->prio (1);	2377	})->prio (1);
…		…
1980		2390
1981	sub cf::client::send_drawinfo {	2391	sub cf::client::send_drawinfo {
1982	my ($self, $text, $flags) = @_;	2392	my ($self, $text, $flags) = @_;
1983		2393
1984	utf8::encode $text;	2394	utf8::encode $text;
1985	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2395	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1986	}	2396	}
1987		2397
		2398	=item $client->send_msg ($color, $type, $msg, [extra...])
		2399
		2400	Send a drawinfo or msg packet to the client, formatting the msg for the
		2401	client if neccessary. C<$type> should be a string identifying the type of
		2402	the message, with C<log> being the default. If C<$color> is negative, suppress
		2403	the message unless the client supports the msg packet.
		2404
		2405	=cut
		2406
		2407	sub cf::client::send_msg {
		2408	my ($self, $color, $type, $msg, @extra) = @_;
		2409
		2410	$msg = $self->pl->expand_cfpod ($msg);
		2411
		2412	if ($self->can_msg) {
		2413	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2414	} else {
		2415	# replace some tags by gcfclient-compatible ones
		2416	for ($msg) {
		2417	1 while
		2418	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2419	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2420	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2421	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2422	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2423	}
		2424
		2425	if ($color >= 0) {
		2426	if (0 && $msg =~ /\[/) {
		2427	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2428	} else {
		2429	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2430	$self->send_packet ("drawinfo $color $msg")
		2431	}
		2432	}
		2433	}
		2434	}
		2435
		2436	=item $client->ext_event ($type, %msg)
		2437
		2438	Sends an ext event to the client.
		2439
		2440	=cut
		2441
		2442	sub cf::client::ext_event($$%) {
		2443	my ($self, $type, %msg) = @_;
		2444
		2445	$msg{msgtype} = "event_$type";
		2446	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2447	}
1988		2448
1989	=item $success = $client->query ($flags, "text", \&cb)	2449	=item $success = $client->query ($flags, "text", \&cb)
1990		2450
1991	Queues a query to the client, calling the given callback with	2451	Queues a query to the client, calling the given callback with
1992	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2452	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1993	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2453	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1994		2454
1995	Queries can fail, so check the return code. Or don't, as queries will become	2455	Queries can fail, so check the return code. Or don't, as queries will
1996	reliable at some point in the future.	2456	become reliable at some point in the future.
1997		2457
1998	=cut	2458	=cut
1999		2459
2000	sub cf::client::query {	2460	sub cf::client::query {
2001	my ($self, $flags, $text, $cb) = @_;	2461	my ($self, $flags, $text, $cb) = @_;
…		…
2009	utf8::encode $text;	2469	utf8::encode $text;
2010	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2470	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2011		2471
2012	$self->send_packet ($self->{query_queue}[0][0])	2472	$self->send_packet ($self->{query_queue}[0][0])
2013	if @{ $self->{query_queue} } == 1;	2473	if @{ $self->{query_queue} } == 1;
		2474
		2475	1
2014	}	2476	}
2015		2477
2016	cf::client->attach (	2478	cf::client->attach (
		2479	on_connect => sub {
		2480	my ($ns) = @_;
		2481
		2482	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2483	},
2017	on_reply => sub {	2484	on_reply => sub {
2018	my ($ns, $msg) = @_;	2485	my ($ns, $msg) = @_;
2019		2486
2020	# this weird shuffling is so that direct followup queries	2487	# this weird shuffling is so that direct followup queries
2021	# get handled first	2488	# get handled first
…		…
2033	} else {	2500	} else {
2034	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2501	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2035	}	2502	}
2036	}	2503	}
2037	},	2504	},
		2505	on_exticmd => sub {
		2506	my ($ns, $buf) = @_;
		2507
		2508	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2509
		2510	if (ref $msg) {
		2511	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2512	if (my %reply = $cb->($ns, $msg)) {
		2513	$reply{msgid} = $msg->{msgid};
		2514	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2515	}
		2516	}
		2517	} else {
		2518	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2519	}
		2520
		2521	cf::override;
		2522	},
2038	);	2523	);
2039		2524
2040	=item $client->async (\&cb)	2525	=item $client->async (\&cb)
2041		2526
2042	Create a new coroutine, running the specified callback. The coroutine will	2527	Create a new coroutine, running the specified callback. The coroutine will
…		…
2089		2574
2090	# here we export the classes and methods available to script code	2575	# here we export the classes and methods available to script code
2091		2576
2092	=pod	2577	=pod
2093		2578
2094	The following fucntions and emthods are available within a safe environment:	2579	The following functions and methods are available within a safe environment:
2095		2580
2096	cf::object contr pay_amount pay_player map	2581	cf::object contr pay_amount pay_player map
2097	cf::object::player player	2582	cf::object::player player
2098	cf::player peaceful	2583	cf::player peaceful
2099	cf::map trigger	2584	cf::map trigger
…		…
2180	=back	2665	=back
2181		2666
2182	=cut	2667	=cut
2183		2668
2184	#############################################################################	2669	#############################################################################
2185
2186	=head2 EXTENSION DATABASE SUPPORT
2187
2188	Crossfire maintains a very simple database for extension use. It can
2189	currently store anything that can be serialised using Storable, which
2190	excludes objects.
2191
2192	The parameter C<$family> should best start with the name of the extension
2193	using it, it should be unique.
2194
2195	=over 4
2196
2197	=item $value = cf::db_get $family => $key
2198
2199	Returns a single value from the database.
2200
2201	=item cf::db_put $family => $key => $value
2202
2203	Stores the given C<$value> in the family.
2204
2205	=cut
2206
2207	our $DB;
2208
2209	sub db_init {
2210	unless ($DB) {
2211	$DB = BDB::db_create $DB_ENV;
2212
2213	cf::sync_job {
2214	eval {
2215	$DB->set_flags (BDB::CHKSUM);
2216
2217	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2218	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2219	cf::cleanup "db_open(db): $!" if $!;
2220	};
2221	cf::cleanup "db_open(db): $@" if $@;
2222	};
2223
2224	my $path = cf::localdir . "/database.pst";
2225	if (stat $path) {
2226	cf::sync_job {
2227	my $pst = Storable::retrieve $path;
2228
2229	cf::db_put (board => data => $pst->{board});
2230	cf::db_put (guildrules => data => $pst->{guildrules});
2231	cf::db_put (rent => balance => $pst->{rent}{balance});
2232	BDB::db_env_txn_checkpoint $DB_ENV;
2233
2234	unlink $path;
2235	};
2236	}
2237	}
2238	}
2239
2240	sub db_get($$) {
2241	my $key = "$_[0]/$_[1]";
2242
2243	cf::sync_job {
2244	BDB::db_get $DB, undef, $key, my $data;
2245
2246	$! ? ()
2247	: Compress::LZF::sthaw $data
2248	}
2249	}
2250
2251	sub db_put($$$) {
2252	BDB::dbreq_pri 4;
2253	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2254	}
2255
2256	#############################################################################
2257	# the server's init and main functions	2670	# the server's init and main functions
2258		2671
2259	sub load_resources {	2672	sub load_facedata($) {
2260	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2673	my ($path) = @_;
		2674
		2675	warn "loading facedata from $path\n";
		2676
		2677	my $facedata;
		2678	0 < aio_load $path, $facedata
		2679	or die "$path: $!";
		2680
		2681	$facedata = Coro::Storable::thaw $facedata;
		2682
		2683	$facedata->{version} == 2
		2684	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2685
		2686	{
		2687	my $faces = $facedata->{faceinfo};
		2688
		2689	while (my ($face, $info) = each %$faces) {
		2690	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2691	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2692	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2693	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2694	Coro::cede;
		2695	}
		2696
		2697	while (my ($face, $info) = each %$faces) {
		2698	next unless $info->{smooth};
		2699	my $idx = cf::face::find $face
		2700	or next;
		2701	if (my $smooth = cf::face::find $info->{smooth}) {
		2702	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2703	} else {
		2704	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2705	}
		2706	Coro::cede;
		2707	}
		2708	}
		2709
		2710	{
		2711	my $anims = $facedata->{animinfo};
		2712
		2713	while (my ($anim, $info) = each %$anims) {
		2714	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2715	Coro::cede;
		2716	}
		2717
		2718	cf::anim::invalidate_all; # d'oh
		2719	}
		2720
		2721	1
		2722	}
		2723
		2724	sub reload_regions {
		2725	load_resource_file "$MAPDIR/regions"
2261	or die "unable to load regions file\n";#d#	2726	or die "unable to load regions file\n";
		2727	}
		2728
		2729	sub reload_facedata {
		2730	load_facedata "$DATADIR/facedata"
		2731	or die "unable to load facedata\n";
		2732	}
		2733
		2734	sub reload_archetypes {
		2735	load_resource_file "$DATADIR/archetypes"
		2736	or die "unable to load archetypes\n";
		2737	#d# NEED to laod twice to resolve forward references
		2738	# this really needs to be done in an extra post-pass
		2739	# (which needs to be synchronous, so solve it differently)
		2740	load_resource_file "$DATADIR/archetypes"
		2741	or die "unable to load archetypes\n";
		2742	}
		2743
		2744	sub reload_treasures {
		2745	load_resource_file "$DATADIR/treasures"
		2746	or die "unable to load treasurelists\n";
		2747	}
		2748
		2749	sub reload_resources {
		2750	warn "reloading resource files...\n";
		2751
		2752	reload_regions;
		2753	reload_facedata;
		2754	#reload_archetypes;#d#
		2755	reload_archetypes;
		2756	reload_treasures;
		2757
		2758	warn "finished reloading resource files\n";
		2759	}
		2760
		2761	sub init {
		2762	reload_resources;
2262	}	2763	}
2263		2764
2264	sub cfg_load {	2765	sub cfg_load {
2265	open my $fh, "<:utf8", cf::confdir . "/config"	2766	open my $fh, "<:utf8", "$CONFDIR/config"
2266	or return;	2767	or return;
2267		2768
2268	local $/;	2769	local $/;
2269	*CFG = YAML::Syck::Load <$fh>;	2770	*CFG = YAML::Syck::Load <$fh>;
2270		2771
…		…
2278	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2779	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2279	and die "WARNING: m(un)lockall failed: $!\n";	2780	and die "WARNING: m(un)lockall failed: $!\n";
2280	};	2781	};
2281	warn $@ if $@;	2782	warn $@ if $@;
2282	}	2783	}
2283	}
2284
2285	sub init {
2286	load_resources;
2287	}	2784	}
2288		2785
2289	sub main {	2786	sub main {
2290	# we must not ever block the main coroutine	2787	# we must not ever block the main coroutine
2291	local $Coro::idle = sub {	2788	local $Coro::idle = sub {
…		…
2319	},	2816	},
2320	);	2817	);
2321	}	2818	}
2322	}	2819	}
2323		2820
		2821	sub write_runtime {
		2822	my $runtime = "$LOCALDIR/runtime";
		2823
		2824	# first touch the runtime file to show we are still running:
		2825	# the fsync below can take a very very long time.
		2826
		2827	IO::AIO::aio_utime $runtime, undef, undef;
		2828
		2829	my $guard = cf::lock_acquire "write_runtime";
		2830
		2831	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2832	or return;
		2833
		2834	my $value = $cf::RUNTIME + 90 + 10;
		2835	# 10 is the runtime save interval, for a monotonic clock
		2836	# 60 allows for the watchdog to kill the server.
		2837
		2838	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2839	and return;
		2840
		2841	# always fsync - this file is important
		2842	aio_fsync $fh
		2843	and return;
		2844
		2845	# touch it again to show we are up-to-date
		2846	aio_utime $fh, undef, undef;
		2847
		2848	close $fh
		2849	or return;
		2850
		2851	aio_rename "$runtime~", $runtime
		2852	and return;
		2853
		2854	warn "runtime file written.\n";
		2855
		2856	1
		2857	}
		2858
2324	sub emergency_save() {	2859	sub emergency_save() {
2325	my $freeze_guard = cf::freeze_mainloop;	2860	my $freeze_guard = cf::freeze_mainloop;
2326		2861
2327	warn "enter emergency perl save\n";	2862	warn "enter emergency perl save\n";
2328		2863
…		…
2359		2894
2360	warn Carp::longmess "post_cleanup backtrace"	2895	warn Carp::longmess "post_cleanup backtrace"
2361	if $make_core;	2896	if $make_core;
2362	}	2897	}
2363		2898
2364	sub reload() {	2899	sub do_reload_perl() {
2365	# can/must only be called in main	2900	# can/must only be called in main
2366	if ($Coro::current != $Coro::main) {	2901	if ($Coro::current != $Coro::main) {
2367	warn "can only reload from main coroutine";	2902	warn "can only reload from main coroutine";
2368	return;	2903	return;
2369	}	2904	}
…		…
2394	Coro::cede;	2929	Coro::cede;
2395	last unless IO::AIO::nreqs || BDB::nreqs;	2930	last unless IO::AIO::nreqs || BDB::nreqs;
2396	warn "iterate...";	2931	warn "iterate...";
2397	}	2932	}
2398		2933
		2934	++$RELOAD;
		2935
2399	warn "cancelling all extension coros";	2936	warn "cancelling all extension coros";
2400	$_->cancel for values %EXT_CORO;	2937	$_->cancel for values %EXT_CORO;
2401	%EXT_CORO = ();	2938	%EXT_CORO = ();
2402		2939
2403	warn "removing commands";	2940	warn "removing commands";
2404	%COMMAND = ();	2941	%COMMAND = ();
2405		2942
2406	warn "removing ext commands";	2943	warn "removing ext/exti commands";
2407	%EXTCMD = ();	2944	%EXTCMD = ();
		2945	%EXTICMD = ();
2408		2946
2409	warn "unloading/nuking all extensions";	2947	warn "unloading/nuking all extensions";
2410	for my $pkg (@EXTS) {	2948	for my $pkg (@EXTS) {
2411	warn "... unloading $pkg";	2949	warn "... unloading $pkg";
2412		2950
…		…
2442	Symbol::delete_package "safe::$_"	2980	Symbol::delete_package "safe::$_"
2443	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2981	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2444		2982
2445	warn "unloading cf.pm \"a bit\"";	2983	warn "unloading cf.pm \"a bit\"";
2446	delete $INC{"cf.pm"};	2984	delete $INC{"cf.pm"};
		2985	delete $INC{"cf/pod.pm"};
2447		2986
2448	# don't, removes xs symbols, too,	2987	# don't, removes xs symbols, too,
2449	# and global variables created in xs	2988	# and global variables created in xs
2450	#Symbol::delete_package __PACKAGE__;	2989	#Symbol::delete_package __PACKAGE__;
2451		2990
…		…
2460		2999
2461	warn "loading extensions";	3000	warn "loading extensions";
2462	cf::load_extensions;	3001	cf::load_extensions;
2463		3002
2464	warn "reattaching attachments to objects/players";	3003	warn "reattaching attachments to objects/players";
2465	_global_reattach;	3004	_global_reattach; # objects, sockets
2466	warn "reattaching attachments to maps";	3005	warn "reattaching attachments to maps";
2467	reattach $_ for values %MAP;	3006	reattach $_ for values %MAP;
2468		3007	warn "reattaching attachments to players";
2469	warn "loading reloadable resources";	3008	reattach $_ for values %PLAYER;
2470	load_resources;
2471		3009
2472	warn "leaving sync_job";	3010	warn "leaving sync_job";
2473		3011
2474	1	3012	1
2475	} or do {	3013	} or do {
…		…
2481	warn "reloaded";	3019	warn "reloaded";
2482	};	3020	};
2483		3021
2484	our $RELOAD_WATCHER; # used only during reload	3022	our $RELOAD_WATCHER; # used only during reload
2485		3023
		3024	sub reload_perl() {
		3025	# doing reload synchronously and two reloads happen back-to-back,
		3026	# coro crashes during coro_state_free->destroy here.
		3027
		3028	$RELOAD_WATCHER ||= Event->timer (
		3029	reentrant => 0,
		3030	after => 0,
		3031	data => WF_AUTOCANCEL,
		3032	cb => sub {
		3033	do_reload_perl;
		3034	undef $RELOAD_WATCHER;
		3035	},
		3036	);
		3037	}
		3038
2486	register_command "reload" => sub {	3039	register_command "reload" => sub {
2487	my ($who, $arg) = @_;	3040	my ($who, $arg) = @_;
2488		3041
2489	if ($who->flag (FLAG_WIZ)) {	3042	if ($who->flag (FLAG_WIZ)) {
2490	$who->message ("reloading server.");	3043	$who->message ("reloading server.");
2491		3044	async { reload_perl };
2492	# doing reload synchronously and two reloads happen back-to-back,
2493	# coro crashes during coro_state_free->destroy here.
2494
2495	$RELOAD_WATCHER ||= Event->timer (
2496	reentrant => 0,
2497	after => 0,
2498	data => WF_AUTOCANCEL,
2499	cb => sub {
2500	reload;
2501	undef $RELOAD_WATCHER;
2502	},
2503	);
2504	}	3045	}
2505	};	3046	};
2506		3047
2507	unshift @INC, $LIBDIR;	3048	unshift @INC, $LIBDIR;
2508		3049
2509	my $bug_warning = 0;	3050	my $bug_warning = 0;
2510		3051
		3052	our @WAIT_FOR_TICK;
		3053	our @WAIT_FOR_TICK_BEGIN;
		3054
		3055	sub wait_for_tick {
		3056	return unless $TICK_WATCHER->is_active;
		3057	return if $Coro::current == $Coro::main;
		3058
		3059	my $signal = new Coro::Signal;
		3060	push @WAIT_FOR_TICK, $signal;
		3061	$signal->wait;
		3062	}
		3063
		3064	sub wait_for_tick_begin {
		3065	return unless $TICK_WATCHER->is_active;
		3066	return if $Coro::current == $Coro::main;
		3067
		3068	my $signal = new Coro::Signal;
		3069	push @WAIT_FOR_TICK_BEGIN, $signal;
		3070	$signal->wait;
		3071	}
		3072
		3073	my $min = 1e6;#d#
		3074	my $avg = 10;
2511	$TICK_WATCHER = Event->timer (	3075	$TICK_WATCHER = Event->timer (
2512	reentrant => 0,	3076	reentrant => 0,
2513	parked => 1,	3077	parked => 1,
2514	prio => 0,	3078	prio => 0,
2515	at => $NEXT_TICK || $TICK,	3079	at => $NEXT_TICK || $TICK,
…		…
2519	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3083	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2520	unless ++$bug_warning > 10;	3084	unless ++$bug_warning > 10;
2521	return;	3085	return;
2522	}	3086	}
2523		3087
2524	$NOW = Event::time;	3088	$NOW = $tick_start = Event::time;
2525		3089
2526	cf::server_tick; # one server iteration	3090	cf::server_tick; # one server iteration
		3091
		3092	0 && sync_job {#d#
		3093	for(1..10) {
		3094	my $t = Event::time;
		3095	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3096	or die;
		3097
		3098	$map->width (50);
		3099	$map->height (50);
		3100	$map->alloc;
		3101	$map->_load_objects ("/tmp/x.map", 1);
		3102	my $t = Event::time - $t;
		3103
		3104	#next unless $t < 0.0013;#d#
		3105	if ($t < $min) {
		3106	$min = $t;
		3107	}
		3108	$avg = $avg * 0.99 + $t * 0.01;
		3109	}
		3110	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3111	exit 0;
		3112	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3113	};
		3114
2527	$RUNTIME += $TICK;	3115	$RUNTIME += $TICK;
2528	$NEXT_TICK += $TICK;	3116	$NEXT_TICK += $TICK;
2529		3117
2530	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3118	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2531	$NEXT_RUNTIME_WRITE = $NOW + 10;	3119	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2533	write_runtime	3121	write_runtime
2534	or warn "ERROR: unable to write runtime file: $!";	3122	or warn "ERROR: unable to write runtime file: $!";
2535	};	3123	};
2536	}	3124	}
2537		3125
2538
2539	$WAIT_FOR_TICK->broadcast;
2540	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2541
2542	# my $AFTER = Event::time;	3126	# my $AFTER = Event::time;
2543	# warn $AFTER - $NOW;#d#	3127	# warn $AFTER - $NOW;#d#
2544		3128
		3129	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3130	$sig->send;
		3131	}
		3132	while (my $sig = shift @WAIT_FOR_TICK) {
		3133	$sig->send;
		3134	}
		3135
		3136	$NOW = Event::time;
		3137
2545	# if we are delayed by four ticks or more, skip them all	3138	# if we are delayed by four ticks or more, skip them all
2546	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3139	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2547		3140
2548	$TICK_WATCHER->at ($NEXT_TICK);	3141	$TICK_WATCHER->at ($NEXT_TICK);
2549	$TICK_WATCHER->start;	3142	$TICK_WATCHER->start;
		3143
		3144	$LOAD = ($NOW - $tick_start) / $TICK;
		3145	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3146
		3147	_post_tick;
		3148
		3149
2550	},	3150	},
2551	);	3151	);
2552		3152
2553	{	3153	{
2554	BDB::max_poll_time $TICK * 0.1;	3154	BDB::max_poll_time $TICK * 0.1;
…		…
2582		3182
2583	cf::sync_job {	3183	cf::sync_job {
2584	eval {	3184	eval {
2585	BDB::db_env_open	3185	BDB::db_env_open
2586	$DB_ENV,	3186	$DB_ENV,
2587	$BDB_ENV_DIR,	3187	$BDBDIR,
2588	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3188	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2589	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3189	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2590	0666;	3190	0666;
2591		3191
2592	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3192	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2593		3193
2594	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3194	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2595	$DB_ENV->set_lk_detect;	3195	$DB_ENV->set_lk_detect;
2596	};	3196	};
2597		3197
…		…
2613	prio => 6,	3213	prio => 6,
2614	cb => \&IO::AIO::poll_cb,	3214	cb => \&IO::AIO::poll_cb,
2615	);	3215	);
2616	}	3216	}
2617		3217
		3218	my $_log_backtrace;
		3219
		3220	sub _log_backtrace {
		3221	my ($msg, @addr) = @_;
		3222
		3223	$msg =~ s/\n//;
		3224
		3225	# limit the # of concurrent backtraces
		3226	if ($_log_backtrace < 2) {
		3227	++$_log_backtrace;
		3228	async {
		3229	my @bt = fork_call {
		3230	@addr = map { sprintf "%x", $_ } @addr;
		3231	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3232	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3233	or die "addr2line: $!";
		3234
		3235	my @funcs;
		3236	my @res = <$fh>;
		3237	chomp for @res;
		3238	while (@res) {
		3239	my ($func, $line) = splice @res, 0, 2, ();
		3240	push @funcs, "[$func] $line";
		3241	}
		3242
		3243	@funcs
		3244	};
		3245
		3246	LOG llevInfo, "[ABT] $msg\n";
		3247	LOG llevInfo, "[ABT] $_\n" for @bt;
		3248	--$_log_backtrace;
		3249	};
		3250	} else {
		3251	LOG llevInfo, "[ABT] $msg\n";
		3252	LOG llevInfo, "[ABT] [suppressed]\n";
		3253	}
		3254	}
		3255
		3256	# load additional modules
		3257	use cf::pod;
		3258
2618	END { cf::emergency_save }	3259	END { cf::emergency_save }
2619		3260
2620	1	3261	1
2621		3262

Diff Legend

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