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.237 by root, Fri Apr 13 05:08:51 2007 UTC vs.
Revision 1.286 by root, Sun Jun 24 04:27:20 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;
9	use Event;	10	use Event;
10	use Opcode;	11	use Opcode;
11	use Safe;	12	use Safe;
12	use Safe::Hole;	13	use Safe::Hole;
13		14
14	use Coro 3.52 ();	15	use Coro 3.61 ();
15	use Coro::State;	16	use Coro::State;
		17	use Coro::Handle;
16	use Coro::Event;	18	use Coro::Event;
17	use Coro::Timer;	19	use Coro::Timer;
18	use Coro::Signal;	20	use Coro::Signal;
19	use Coro::Semaphore;	21	use Coro::Semaphore;
20	use Coro::AIO;	22	use Coro::AIO;
…		…
52	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
53	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
54		56
55	our $RELOAD; # number of reloads so far	57	our $RELOAD; # number of reloads so far
56	our @EVENT;	58	our @EVENT;
57	our $LIBDIR = datadir . "/ext";
58		59
59	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60	our $TICK_WATCHER;	73	our $TICK_WATCHER;
61	our $AIO_POLL_WATCHER;	74	our $AIO_POLL_WATCHER;
62	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63	our $NEXT_TICK;	76	our $NEXT_TICK;
64	our $NOW;	77	our $NOW;
…		…
73	our $RUNTIME;	86	our $RUNTIME;
74		87
75	our %PLAYER; # all users	88	our %PLAYER; # all users
76	our %MAP; # all maps	89	our %MAP; # all maps
77	our $LINK_MAP; # the special {link} map, which is always available	90	our $LINK_MAP; # the special {link} map, which is always available
78	our $RANDOM_MAPS = cf::localdir . "/random";
79	our $BDB_ENV_DIR = cf::localdir . "/db";
80
81	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
82	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
83		91
84	# used to convert map paths into valid unix filenames by replacing / by ∕	92	# used to convert map paths into valid unix filenames by replacing / by ∕
85	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
86		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
		98
87	binmode STDOUT;	99	binmode STDOUT;
88	binmode STDERR;	100	binmode STDERR;
89		101
90	# read virtual server time, if available	102	# read virtual server time, if available
91	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
92	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
93	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
94	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
95	}	107	}
96		108
97	mkdir cf::localdir;	109	mkdir $_
98	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99	mkdir cf::localdir . "/" . cf::tmpdir;
100	mkdir cf::localdir . "/" . cf::uniquedir;
101	mkdir $RANDOM_MAPS;
102	mkdir $BDB_ENV_DIR;
103		111
104	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
105		113
106	sub cf::map::normalise;	114	sub cf::map::normalise;
107		115
…		…
118	=item $cf::RUNTIME	126	=item $cf::RUNTIME
119		127
120	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
121	every server tick.	129	every server tick.
122		130
123	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
124		134
125	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
126	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
127		139
128	=item $cf::NOW	140	=item $cf::NOW
129		141
130	The time of the last (current) server tick.	142	The time of the last (current) server tick.
131		143
132	=item $cf::TICK	144	=item $cf::TICK
133		145
134	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
135		157
136	=item %cf::CFG	158	=item %cf::CFG
137		159
138	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
139	from wherever your confdir points to.	161	from wherever your confdir points to.
140		162
141	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
142		164
143	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
144	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	166	returns directly I<after> the tick processing (and consequently, can only wake one process
145	processing has been done. Call C<< ->wait >> on them to maximise the	167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
146	window of cpu time available, or simply to synchronise to the server tick.
147		168
148	=back	169	=back
149		170
150	=cut	171	=cut
151		172
152	BEGIN {	173	BEGIN {
153	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
154	my $msg = join "", @_;	175	my $msg = join "", @_;
155	utf8::encode $msg;
156		176
157	$msg .= "\n"	177	$msg .= "\n"
158	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
159		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
160	LOG llevError, $msg;	183	LOG llevError, $msg;
161	};	184	};
162	}	185	}
163		186
164	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
169	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
170		194
171	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
172	# within the Safe compartment.	196	# within the Safe compartment.
173	for my $pkg (qw(	197	for my $pkg (qw(
174	cf::global cf::attachable	198	cf::global cf::attachable
…		…
182	}	206	}
183		207
184	$Event::DIED = sub {	208	$Event::DIED = sub {
185	warn "error in event callback: @_";	209	warn "error in event callback: @_";
186	};	210	};
		211
		212	#############################################################################
187		213
188	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
189		215
190	=over 4	216	=over 4
191		217
…		…
234	returned.	260	returned.
235		261
236	Lock names should begin with a unique identifier (for example, cf::map::find	262	Lock names should begin with a unique identifier (for example, cf::map::find
237	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
238		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
239	=cut	269	=cut
240		270
241	our %LOCK;	271	our %LOCK;
242		272
243	sub lock_wait($) {	273	sub lock_wait($) {
…		…
260		290
261	Coro::guard {	291	Coro::guard {
262	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
263	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
264	}	294	}
		295	}
		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
265	}	301	}
266		302
267	sub freeze_mainloop {	303	sub freeze_mainloop {
268	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
269		305
…		…
284		320
285	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
286		322
287	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
288		324
289	The design of crossfire+ requires that the main coro ($Coro::main) is	325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
290	always able to handle events or runnable, as crossfire+ is only partly	326	is always able to handle events or runnable, as Crossfire TRT is only
291	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
292		329
293	If it must be done, put the blocking parts into C<sync_job>. This will run	330	If it must be done, put the blocking parts into C<sync_job>. This will run
294	the given BLOCK in another coroutine while waiting for the result. The	331	the given BLOCK in another coroutine while waiting for the result. The
295	server will be frozen during this time, so the block should either finish	332	server will be frozen during this time, so the block should either finish
296	fast or be very important.	333	fast or be very important.
…		…
299		336
300	sub sync_job(&) {	337	sub sync_job(&) {
301	my ($job) = @_;	338	my ($job) = @_;
302		339
303	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
304	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
305	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
306		345
307	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
308	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
319		358
320	while ($busy) {	359	while ($busy) {
321	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
322	}	361	}
323		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
324	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
325	} else {	371	} else {
326	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
327		373
328	$job->()	374	$job->()
…		…
347	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
348		394
349	$coro	395	$coro
350	}	396	}
351		397
352	sub write_runtime {	398	=item fork_call { }, $args
353	my $guard = cf::lock_acquire "write_runtime";
354		399
355	my $runtime = cf::localdir . "/runtime";	400	Executes the given code block with the given arguments in a seperate
		401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
356		404
357	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	405	=cut
358	or return;
359		406
360	my $value = $cf::RUNTIME + 90 + 10;	407	sub fork_call(&@) {
361	# 10 is the runtime save interval, for a monotonic clock	408	my ($cb, @args) = @_;
362	# 60 allows for the watchdog to kill the server.
363		409
364	(aio_write $fh, 0, (length $value), $value, 0) <= 0	410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
365	and return;	411	# or die "socketpair: $!";
		412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
366		414
367	# always fsync - this file is important	415	if (my $pid = fork) {
368	aio_fsync $fh
369	and return;
370
371	close $fh	416	close $fh2;
372	or return;
373		417
374	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
375	and return;	419	$res = Coro::Storable::thaw $res;
376		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
377	1	439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
378	}	556	}
379		557
380	=item cf::datalog type => key => value, ...	558	=item cf::datalog type => key => value, ...
381		559
382	Log a datalog packet of the given type with the given key-value pairs.	560	Log a datalog packet of the given type with the given key-value pairs.
…		…
400	attach callbacks/event handlers (a collection of which is called an "attachment")	578	attach callbacks/event handlers (a collection of which is called an "attachment")
401	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
402		580
403	In the following description, CLASS can be any of C<global>, C<object>	581	In the following description, CLASS can be any of C<global>, C<object>
404	C<player>, C<client> or C<map> (i.e. the attachable objects in	582	C<player>, C<client> or C<map> (i.e. the attachable objects in
405	crossfire+).	583	Crossfire TRT).
406		584
407	=over 4	585	=over 4
408		586
409	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
410		588
…		…
573	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
574		752
575	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
576	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
577	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
578	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579		757
580	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
581	my $pkg = shift @arg;	759	my $pkg = shift @arg;
582		760
583	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
612	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
613	}	791	}
614		792
615	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
616	} else {	794	} else {
617	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
618	}	796	}
619		797
620	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
621	}	799	}
622		800
…		…
624	if (ref $_[0]) {	802	if (ref $_[0]) {
625	_object_attach @_;	803	_object_attach @_;
626	} else {	804	} else {
627	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
628	}	806	}
		807	_recalc_want;
629	};	808	};
630		809
631	# all those should be optimised	810	# all those should be optimised
632	sub cf::attachable::detach {	811	sub cf::attachable::detach {
633	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
636	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
637	reattach ($obj);	816	reattach ($obj);
638	} else {	817	} else {
639	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
640	}	819	}
		820	_recalc_want;
641	};	821	};
642		822
643	sub cf::attachable::attached {	823	sub cf::attachable::attached {
644	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
645		825
…		…
818	or return;	998	or return;
819	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
820	}	1000	}
821		1001
822	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
823	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
824	return ($data, $av);	1004	return ($data, $av);
825	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
826		1012
827	#############################################################################	1013	#############################################################################
828	# command handling &c	1014	# command handling &c
829		1015
830	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
843	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
844	}	1030	}
845		1031
846	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
847		1033
848	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
849		1035
850	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
851	called.	1037	called.
852		1038
853	=cut	1039	=cut
…		…
888		1074
889	cf::override;	1075	cf::override;
890	},	1076	},
891	);	1077	);
892		1078
893	sub load_extension {
894	my ($path) = @_;
895
896	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
897	my $base = $1;
898	my $pkg = $1;
899	$pkg =~ s/[^[:word:]]/_/g;
900	$pkg = "ext::$pkg";
901
902	warn "... loading '$path' into '$pkg'\n";
903
904	open my $fh, "<:utf8", $path
905	or die "$path: $!";
906
907	my $source =
908	"package $pkg; use strict; use utf8;\n"
909	. "#line 1 \"$path\"\n{\n"
910	. (do { local $/; <$fh> })
911	. "\n};\n1";
912
913	unless (eval $source) {
914	my $msg = $@ ? "$path: $@\n"
915	: "extension disabled.\n";
916	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917	warn $@;
918	warn "mandatory extension failed to load, exiting.\n";
919	exit 1;
920	}
921	die $@;
922	}
923
924	push @EXTS, $pkg;
925	}
926
927	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
928	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
929	next unless -r $ext;	1084	next unless -r $path;
930	eval {	1085
931	load_extension $ext;	1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
932	1	1143	}
933	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
934	}	1149	};
935	}	1150	}
936		1151
937	#############################################################################	1152	#############################################################################
938		1153
		1154	=back
		1155
939	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
940		1157
941	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
942		1159
943	=cut	1160	=cut
…		…
955	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
956		1173
957	=cut	1174	=cut
958		1175
959	sub playerdir($) {	1176	sub playerdir($) {
960	cf::localdir	1177	"$PLAYERDIR/"
961	. "/"
962	. cf::playerdir
963	. "/"
964	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
965	}	1179	}
966		1180
967	sub path($) {	1181	sub path($) {
968	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
…		…
1088	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1089		1303
1090	=cut	1304	=cut
1091		1305
1092	sub list_logins {	1306	sub list_logins {
1093	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1094	or return [];	1308	or return [];
1095		1309
1096	my @logins;	1310	my @logins;
1097		1311
1098	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1133	}	1347	}
1134		1348
1135	\@paths	1349	\@paths
1136	}	1350	}
1137		1351
		1352	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1353
		1354	Expand crossfire pod fragments into protocol xml.
		1355
		1356	=cut
		1357
		1358	sub expand_cfpod {
		1359	((my $self), (local $_)) = @_;
		1360
		1361	# escape & and <
		1362	s/&/&amp;/g;
		1363	s/(?<![BIUGH])</&lt;/g;
		1364
		1365	# this is buggy, it needs to properly take care of nested <'s
		1366
		1367	1 while
		1368	# replace B<>, I<>, U<> etc.
		1369	s/B<([^\>]*)>/<b>$1<\/b>/
		1370	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1371	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1372	# replace G<male|female> tags
		1373	|| s{G<([^>|]*)\|([^>]*)>}{
		1374	$self->gender ? $2 : $1
		1375	}ge
		1376	# replace H<hint text>
		1377	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1378
		1379	# create single paragraphs (very hackish)
		1380	s/(?<=\S)\n(?=\w)/ /g;
		1381
		1382	$_
		1383	}
		1384
1138	=item $player->ext_reply ($msgid, %msg)	1385	=item $player->ext_reply ($msgid, %msg)
1139		1386
1140	Sends an ext reply to the player.	1387	Sends an ext reply to the player.
1141		1388
1142	=cut	1389	=cut
…		…
1159	my ($self, $type, %msg) = @_;	1406	my ($self, $type, %msg) = @_;
1160		1407
1161	$self->ns->ext_event ($type, %msg);	1408	$self->ns->ext_event ($type, %msg);
1162	}	1409	}
1163		1410
1164	package cf;	1411	=head3 cf::region
		1412
		1413	=over 4
		1414
		1415	=cut
		1416
		1417	package cf::region;
		1418
		1419	=item cf::region::find_by_path $path
		1420
		1421	Tries to decuce the likely region for a map knowing only its path.
		1422
		1423	=cut
		1424
		1425	sub find_by_path($) {
		1426	my ($path) = @_;
		1427
		1428	my ($match, $specificity);
		1429
		1430	for my $region (list) {
		1431	if ($region->match && $path =~ $region->match) {
		1432	($match, $specificity) = ($region, $region->specificity)
		1433	if $region->specificity > $specificity;
		1434	}
		1435	}
		1436
		1437	$match
		1438	}
1165		1439
1166	=back	1440	=back
1167
1168		1441
1169	=head3 cf::map	1442	=head3 cf::map
1170		1443
1171	=over 4	1444	=over 4
1172		1445
…		…
1227	my ($self, $merge) = @_;	1500	my ($self, $merge) = @_;
1228		1501
1229	# we have to keep some variables in memory intact	1502	# we have to keep some variables in memory intact
1230	local $self->{path};	1503	local $self->{path};
1231	local $self->{load_path};	1504	local $self->{load_path};
1232	local $self->{deny_save};
1233	local $self->{deny_reset};
1234		1505
1235	$self->SUPER::thawer_merge ($merge);	1506	$self->SUPER::thawer_merge ($merge);
1236	}	1507	}
1237		1508
1238	sub normalise {	1509	sub normalise {
…		…
1310		1581
1311	# the original (read-only) location	1582	# the original (read-only) location
1312	sub load_path {	1583	sub load_path {
1313	my ($self) = @_;	1584	my ($self) = @_;
1314		1585
1315	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1586	"$MAPDIR/$self->{path}.map"
1316	}	1587	}
1317		1588
1318	# the temporary/swap location	1589	# the temporary/swap location
1319	sub save_path {	1590	sub save_path {
1320	my ($self) = @_;	1591	my ($self) = @_;
1321		1592
1322	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1593	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1323	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1594	"$TMPDIR/$path.map"
1324	}	1595	}
1325		1596
1326	# the unique path, undef == no special unique path	1597	# the unique path, undef == no special unique path
1327	sub uniq_path {	1598	sub uniq_path {
1328	my ($self) = @_;	1599	my ($self) = @_;
1329		1600
1330	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1601	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1331	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1602	"$UNIQUEDIR/$path"
1332	}	1603	}
1333		1604
1334	# and all this just because we cannot iterate over	1605	# and all this just because we cannot iterate over
1335	# all maps in C++...	1606	# all maps in C++...
1336	sub change_all_map_light {	1607	sub change_all_map_light {
1337	my ($change) = @_;	1608	my ($change) = @_;
1338		1609
1339	$_->change_map_light ($change)	1610	$_->change_map_light ($change)
1340	for grep $_->outdoor, values %cf::MAP;	1611	for grep $_->outdoor, values %cf::MAP;
		1612	}
		1613
		1614	sub decay_objects {
		1615	my ($self) = @_;
		1616
		1617	return if $self->{deny_reset};
		1618
		1619	$self->do_decay_objects;
1341	}	1620	}
1342		1621
1343	sub unlink_save {	1622	sub unlink_save {
1344	my ($self) = @_;	1623	my ($self) = @_;
1345		1624
…		…
1403	$self->load_header_orig	1682	$self->load_header_orig
1404	or return;	1683	or return;
1405	$self->prepare_orig;	1684	$self->prepare_orig;
1406	}	1685	}
1407		1686
		1687	$self->{deny_reset} = 1
		1688	if $self->no_reset;
		1689
		1690	$self->default_region (cf::region::find_by_path $self->{path})
		1691	unless $self->default_region;
		1692
1408	1	1693	1
1409	}	1694	}
1410		1695
1411	sub find;	1696	sub find;
1412	sub find {	1697	sub find {
…		…
1424	$map->{last_save} = $cf::RUNTIME;	1709	$map->{last_save} = $cf::RUNTIME;
1425		1710
1426	$map->load_header	1711	$map->load_header
1427	or return;	1712	or return;
1428		1713
1429	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1714	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1430	# doing this can freeze the server in a sync job, obviously	1715	# doing this can freeze the server in a sync job, obviously
1431	#$cf::WAIT_FOR_TICK->wait;	1716	#$cf::WAIT_FOR_TICK->wait;
1432	$map->reset;	1717	$map->reset;
1433	undef $guard;	1718	undef $guard;
1434	return find $path;	1719	return find $path;
…		…
1445	my ($self) = @_;	1730	my ($self) = @_;
1446		1731
1447	local $self->{deny_reset} = 1; # loading can take a long time	1732	local $self->{deny_reset} = 1; # loading can take a long time
1448		1733
1449	my $path = $self->{path};	1734	my $path = $self->{path};
		1735
		1736	{
1450	my $guard = cf::lock_acquire "map_load:$path";	1737	my $guard = cf::lock_acquire "map_load:$path";
1451		1738
1452	return if $self->in_memory != cf::MAP_SWAPPED;	1739	return if $self->in_memory != cf::MAP_SWAPPED;
1453		1740
1454	$self->in_memory (cf::MAP_LOADING);	1741	$self->in_memory (cf::MAP_LOADING);
1455		1742
1456	$self->alloc;	1743	$self->alloc;
1457		1744
1458	$self->pre_load;	1745	$self->pre_load;
1459
1460	$self->_load_objects ($self->{load_path}, 1)
1461	or return;
1462
1463	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1464	if delete $self->{load_original};
1465
1466	if (my $uniq = $self->uniq_path) {
1467	utf8::encode $uniq;
1468	if (aio_open $uniq, O_RDONLY, 0) {
1469	$self->clear_unique_items;
1470	$self->_load_objects ($uniq, 0);
1471	}
1472	}
1473
1474	Coro::cede;
1475
1476	# now do the right thing for maps
1477	$self->link_multipart_objects;
1478
1479	unless ($self->{deny_activate}) {
1480	$self->decay_objects;
1481	$self->fix_auto_apply;
1482	$self->update_buttons;
1483	Coro::cede;	1746	Coro::cede;
1484	$self->set_darkness_map;	1747
		1748	$self->_load_objects ($self->{load_path}, 1)
		1749	or return;
		1750
		1751	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1752	if delete $self->{load_original};
		1753
		1754	if (my $uniq = $self->uniq_path) {
		1755	utf8::encode $uniq;
		1756	if (aio_open $uniq, O_RDONLY, 0) {
		1757	$self->clear_unique_items;
		1758	$self->_load_objects ($uniq, 0);
		1759	}
		1760	}
		1761
		1762	Coro::cede;
		1763	# now do the right thing for maps
		1764	$self->link_multipart_objects;
1485	$self->difficulty ($self->estimate_difficulty)	1765	$self->difficulty ($self->estimate_difficulty)
1486	unless $self->difficulty;	1766	unless $self->difficulty;
1487	Coro::cede;	1767	Coro::cede;
		1768
		1769	unless ($self->{deny_activate}) {
		1770	$self->decay_objects;
		1771	$self->fix_auto_apply;
		1772	$self->update_buttons;
		1773	Coro::cede;
		1774	$self->set_darkness_map;
		1775	Coro::cede;
1488	$self->activate;	1776	$self->activate;
		1777	}
		1778
		1779	$self->in_memory (cf::MAP_IN_MEMORY);
1489	}	1780	}
1490		1781
1491	$self->post_load;	1782	$self->post_load;
1492
1493	$self->in_memory (cf::MAP_IN_MEMORY);
1494	}	1783	}
1495		1784
1496	sub customise_for {	1785	sub customise_for {
1497	my ($self, $ob) = @_;	1786	my ($self, $ob) = @_;
1498		1787
1499	return find "~" . $ob->name . "/" . $self->{path}	1788	return find "~" . $ob->name . "/" . $self->{path}
1500	if $self->per_player;	1789	if $self->per_player;
		1790
		1791	# return find "?party/" . $ob->name . "/" . $self->{path}
		1792	# if $self->per_party;
1501		1793
1502	$self	1794	$self
1503	}	1795	}
1504		1796
1505	# find and load all maps in the 3x3 area around a map	1797	# find and load all maps in the 3x3 area around a map
…		…
1616		1908
1617	sub reset_at {	1909	sub reset_at {
1618	my ($self) = @_;	1910	my ($self) = @_;
1619		1911
1620	# TODO: safety, remove and allow resettable per-player maps	1912	# TODO: safety, remove and allow resettable per-player maps
1621	return 1e99 if $self->isa ("ext::map_per_player");#d#
1622	return 1e99 if $self->{deny_reset};	1913	return 1e99 if $self->{deny_reset};
1623		1914
1624	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1915	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1625	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1916	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1626		1917
…		…
1637	my ($self) = @_;	1928	my ($self) = @_;
1638		1929
1639	my $lock = cf::lock_acquire "map_data:$self->{path}";	1930	my $lock = cf::lock_acquire "map_data:$self->{path}";
1640		1931
1641	return if $self->players;	1932	return if $self->players;
1642	return if $self->isa ("ext::map_per_player");#d#
1643		1933
1644	warn "resetting map ", $self->path;#d#	1934	warn "resetting map ", $self->path;
1645		1935
1646	$self->in_memory (cf::MAP_SWAPPED);	1936	$self->in_memory (cf::MAP_SWAPPED);
1647		1937
1648	# need to save uniques path	1938	# need to save uniques path
1649	unless ($self->{deny_save}) {	1939	unless ($self->{deny_save}) {
…		…
1681	$cf::MAP{$self->path} = $self;	1971	$cf::MAP{$self->path} = $self;
1682		1972
1683	$self->reset; # polite request, might not happen	1973	$self->reset; # polite request, might not happen
1684	}	1974	}
1685		1975
		1976	=item $maps = cf::map::tmp_maps
		1977
		1978	Returns an arrayref with all map paths of currently instantiated and saved
		1979	maps. May block.
		1980
		1981	=cut
		1982
		1983	sub tmp_maps() {
		1984	[
		1985	map {
		1986	utf8::decode $_;
		1987	/\.map$/
		1988	? normalise $_
		1989	: ()
		1990	} @{ aio_readdir $TMPDIR or [] }
		1991	]
		1992	}
		1993
		1994	=item $maps = cf::map::random_maps
		1995
		1996	Returns an arrayref with all map paths of currently instantiated and saved
		1997	random maps. May block.
		1998
		1999	=cut
		2000
		2001	sub random_maps() {
		2002	[
		2003	map {
		2004	utf8::decode $_;
		2005	/\.map$/
		2006	? normalise "?random/$_"
		2007	: ()
		2008	} @{ aio_readdir $RANDOMDIR or [] }
		2009	]
		2010	}
		2011
1686	=item cf::map::unique_maps	2012	=item cf::map::unique_maps
1687		2013
1688	Returns an arrayref of paths of all shared maps that have	2014	Returns an arrayref of paths of all shared maps that have
1689	instantiated unique items. May block.	2015	instantiated unique items. May block.
1690		2016
1691	=cut	2017	=cut
1692		2018
1693	sub unique_maps() {	2019	sub unique_maps() {
1694	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2020	[
1695	or return;	2021	map {
1696
1697	my @paths;
1698
1699	for (@$files) {
1700	utf8::decode $_;	2022	utf8::decode $_;
1701	next if /\.pst$/;	2023	/\.map$/
1702	next unless /^$PATH_SEP/o;	2024	? normalise $_
1703		2025	: ()
1704	push @paths, cf::map::normalise $_;	2026	} @{ aio_readdir $UNIQUEDIR or [] }
1705	}	2027	]
1706
1707	\@paths
1708	}	2028	}
1709		2029
1710	package cf;	2030	package cf;
1711		2031
1712	=back	2032	=back
…		…
1758		2078
1759	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2079	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1760		2080
1761	if ($self->{record_replies}) {	2081	if ($self->{record_replies}) {
1762	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2082	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2083
1763	} else {	2084	} else {
		2085	my $pl = $self->contr;
		2086
		2087	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2088	my $diag = $pl->{npc_dialog};
		2089	$diag->{pl}->ext_reply (
		2090	$diag->{id},
		2091	msgtype => "reply",
		2092	msg => $diag->{pl}->expand_cfpod ($msg),
		2093	add_topics => []
		2094	);
		2095
		2096	} else {
1764	$msg = $npc->name . " says: $msg" if $npc;	2097	$msg = $npc->name . " says: $msg" if $npc;
1765	$self->message ($msg, $flags);	2098	$self->message ($msg, $flags);
		2099	}
1766	}	2100	}
1767	}	2101	}
1768		2102
1769	=item $player_object->may ("access")	2103	=item $player_object->may ("access")
1770		2104
…		…
1818	$self->deactivate_recursive;	2152	$self->deactivate_recursive;
1819		2153
1820	return if UNIVERSAL::isa $self->map, "ext::map_link";	2154	return if UNIVERSAL::isa $self->map, "ext::map_link";
1821		2155
1822	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2156	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1823	if $self->map;	2157	if $self->map && $self->map->{path} ne "{link}";
1824		2158
1825	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2159	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1826	}	2160	}
1827		2161
1828	sub cf::object::player::leave_link {	2162	sub cf::object::player::leave_link {
1829	my ($self, $map, $x, $y) = @_;	2163	my ($self, $map, $x, $y) = @_;
		2164
		2165	return unless $self->contr->active;
1830		2166
1831	my $link_pos = delete $self->{_link_pos};	2167	my $link_pos = delete $self->{_link_pos};
1832		2168
1833	unless ($map) {	2169	unless ($map) {
1834	# restore original map position	2170	# restore original map position
…		…
1857		2193
1858	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2194	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1859	$self->enter_map ($map, $x, $y);	2195	$self->enter_map ($map, $x, $y);
1860	}	2196	}
1861		2197
1862	cf::player->attach (
1863	on_logout => sub {
1864	my ($pl) = @_;
1865
1866	# abort map switching before logout
1867	if ($pl->ob->{_link_pos}) {
1868	cf::sync_job {
1869	$pl->ob->leave_link
1870	};
1871	}
1872	},
1873	on_login => sub {
1874	my ($pl) = @_;
1875
1876	# try to abort aborted map switching on player login :)
1877	# should happen only on crashes
1878	if ($pl->ob->{_link_pos}) {
1879	$pl->ob->enter_link;
1880	(async {
1881	$pl->ob->reply (undef,
1882	"There was an internal problem at your last logout, "
1883	. "the server will try to bring you to your intended destination in a second.",
1884	cf::NDI_RED);
1885	# we need this sleep as the login has a concurrent enter_exit running
1886	# and this sleep increases chances of the player not ending up in scorn
1887	Coro::Timer::sleep 1;
1888	$pl->ob->leave_link;
1889	})->prio (2);
1890	}
1891	},
1892	);
1893
1894	=item $player_object->goto ($path, $x, $y)	2198	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1895		2199
		2200	Moves the player to the given map-path and coordinates by first freezing
		2201	her, loading and preparing them map, calling the provided $check callback
		2202	that has to return the map if sucecssful, and then unfreezes the player on
		2203	the new (success) or old (failed) map position.
		2204
1896	=cut	2205	=cut
		2206
		2207	our $GOTOGEN;
1897		2208
1898	sub cf::object::player::goto {	2209	sub cf::object::player::goto {
1899	my ($self, $path, $x, $y) = @_;	2210	my ($self, $path, $x, $y, $check) = @_;
		2211
		2212	# do generation counting so two concurrent goto's will be executed in-order
		2213	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1900		2214
1901	$self->enter_link;	2215	$self->enter_link;
1902		2216
1903	(async {	2217	(async {
1904	my $map = eval {	2218	my $map = eval {
1905	my $map = cf::map::find $path;	2219	my $map = cf::map::find $path;
		2220
		2221	if ($map) {
1906	$map = $map->customise_for ($self) if $map;	2222	$map = $map->customise_for ($self);
		2223	$map = $check->($map) if $check && $map;
		2224	} else {
		2225	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2226	}
		2227
1907	$map	2228	$map
		2229	};
		2230
		2231	if ($@) {
		2232	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2233	LOG llevError | logBacktrace, Carp::longmess $@;
1908	} or	2234	}
1909	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1910		2235
		2236	if ($gen == $self->{_goto_generation}) {
		2237	delete $self->{_goto_generation};
1911	$self->leave_link ($map, $x, $y);	2238	$self->leave_link ($map, $x, $y);
		2239	}
1912	})->prio (1);	2240	})->prio (1);
1913	}	2241	}
1914		2242
1915	=item $player_object->enter_exit ($exit_object)	2243	=item $player_object->enter_exit ($exit_object)
1916		2244
…		…
1955		2283
1956	$rmp->{random_seed} ||= $exit->random_seed;	2284	$rmp->{random_seed} ||= $exit->random_seed;
1957		2285
1958	my $data = cf::to_json $rmp;	2286	my $data = cf::to_json $rmp;
1959	my $md5 = Digest::MD5::md5_hex $data;	2287	my $md5 = Digest::MD5::md5_hex $data;
1960	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2288	my $meta = "$RANDOMDIR/$md5.meta";
1961		2289
1962	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2290	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1963	aio_write $fh, 0, (length $data), $data, 0;	2291	aio_write $fh, 0, (length $data), $data, 0;
1964	undef $fh;	2292	undef $fh;
1965	aio_rename "$meta~", $meta;	2293	aio_rename "$meta~", $meta;
…		…
2019	sub cf::client::send_drawinfo {	2347	sub cf::client::send_drawinfo {
2020	my ($self, $text, $flags) = @_;	2348	my ($self, $text, $flags) = @_;
2021		2349
2022	utf8::encode $text;	2350	utf8::encode $text;
2023	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2351	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2352	}
		2353
		2354	=item $client->send_msg ($color, $type, $msg, [extra...])
		2355
		2356	Send a drawinfo or msg packet to the client, formatting the msg for the
		2357	client if neccessary. C<$type> should be a string identifying the type of
		2358	the message, with C<log> being the default. If C<$color> is negative, suppress
		2359	the message unless the client supports the msg packet.
		2360
		2361	=cut
		2362
		2363	sub cf::client::send_msg {
		2364	my ($self, $color, $type, $msg, @extra) = @_;
		2365
		2366	$msg = $self->pl->expand_cfpod ($msg);
		2367
		2368	if ($self->can_msg) {
		2369	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2370	} else {
		2371	# replace some tags by gcfclient-compatible ones
		2372	for ($msg) {
		2373	1 while
		2374	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2375	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2376	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2377	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2378	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2379	}
		2380
		2381	if ($color >= 0) {
		2382	if (0 && $msg =~ /\[/) {
		2383	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2384	} else {
		2385	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2386	$self->send_packet ("drawinfo $color $msg")
		2387	}
		2388	}
		2389	}
2024	}	2390	}
2025		2391
2026	=item $client->ext_event ($type, %msg)	2392	=item $client->ext_event ($type, %msg)
2027		2393
2028	Sends an exti event to the client.	2394	Sends an exti event to the client.
…		…
2230	=back	2596	=back
2231		2597
2232	=cut	2598	=cut
2233		2599
2234	#############################################################################	2600	#############################################################################
2235
2236	=head2 EXTENSION DATABASE SUPPORT
2237
2238	Crossfire maintains a very simple database for extension use. It can
2239	currently store anything that can be serialised using Storable, which
2240	excludes objects.
2241
2242	The parameter C<$family> should best start with the name of the extension
2243	using it, it should be unique.
2244
2245	=over 4
2246
2247	=item $value = cf::db_get $family => $key
2248
2249	Returns a single value from the database.
2250
2251	=item cf::db_put $family => $key => $value
2252
2253	Stores the given C<$value> in the family.
2254
2255	=cut
2256
2257	our $DB;
2258
2259	sub db_init {
2260	unless ($DB) {
2261	$DB = BDB::db_create $DB_ENV;
2262
2263	cf::sync_job {
2264	eval {
2265	$DB->set_flags (BDB::CHKSUM);
2266
2267	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2268	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2269	cf::cleanup "db_open(db): $!" if $!;
2270	};
2271	cf::cleanup "db_open(db): $@" if $@;
2272	};
2273
2274	my $path = cf::localdir . "/database.pst";
2275	if (stat $path) {
2276	cf::sync_job {
2277	my $pst = Storable::retrieve $path;
2278
2279	cf::db_put (board => data => $pst->{board});
2280	cf::db_put (guildrules => data => $pst->{guildrules});
2281	cf::db_put (rent => balance => $pst->{rent}{balance});
2282	BDB::db_env_txn_checkpoint $DB_ENV;
2283
2284	unlink $path;
2285	};
2286	}
2287	}
2288	}
2289
2290	sub db_get($$) {
2291	my $key = "$_[0]/$_[1]";
2292
2293	cf::sync_job {
2294	BDB::db_get $DB, undef, $key, my $data;
2295
2296	$! ? ()
2297	: Compress::LZF::sthaw $data
2298	}
2299	}
2300
2301	sub db_put($$$) {
2302	BDB::dbreq_pri 4;
2303	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2304	}
2305
2306	#############################################################################
2307	# the server's init and main functions	2601	# the server's init and main functions
2308		2602
2309	sub load_facedata {	2603	sub load_facedata($) {
2310	my $path = sprintf "%s/facedata", cf::datadir;	2604	my ($path) = @_;
2311		2605
2312	warn "loading facedata from $path\n";	2606	warn "loading facedata from $path\n";
2313		2607
2314	my $facedata;	2608	my $facedata;
2315	0 < aio_load $path, $facedata	2609	0 < aio_load $path, $facedata
…		…
2356	}	2650	}
2357		2651
2358	1	2652	1
2359	}	2653	}
2360		2654
		2655	sub reload_regions {
		2656	load_resource_file "$MAPDIR/regions"
		2657	or die "unable to load regions file\n";
		2658	}
		2659
		2660	sub reload_facedata {
		2661	load_facedata "$DATADIR/facedata"
		2662	or die "unable to load facedata\n";
		2663	}
		2664
		2665	sub reload_archetypes {
		2666	load_resource_file "$DATADIR/archetypes"
		2667	or die "unable to load archetypes\n";
		2668	}
		2669
		2670	sub reload_treasures {
		2671	load_resource_file "$DATADIR/treasures"
		2672	or die "unable to load treasurelists\n";
		2673	}
		2674
2361	sub reload_resources {	2675	sub reload_resources {
2362	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2676	warn "reloading resource files...\n";
2363	or die "unable to load regions file\n";#d#	2677
		2678	reload_regions;
2364	load_facedata	2679	reload_facedata;
2365	or die "unable to load facedata\n";#d#	2680	#reload_archetypes;#d#
		2681	reload_archetypes;
		2682	reload_treasures;
		2683
		2684	warn "finished reloading resource files\n";
2366	}	2685	}
2367		2686
2368	sub init {	2687	sub init {
2369	reload_resources;	2688	reload_resources;
2370	}	2689	}
2371		2690
2372	sub cfg_load {	2691	sub cfg_load {
2373	open my $fh, "<:utf8", cf::confdir . "/config"	2692	open my $fh, "<:utf8", "$CONFDIR/config"
2374	or return;	2693	or return;
2375		2694
2376	local $/;	2695	local $/;
2377	*CFG = YAML::Syck::Load <$fh>;	2696	*CFG = YAML::Syck::Load <$fh>;
2378		2697
…		…
2423	},	2742	},
2424	);	2743	);
2425	}	2744	}
2426	}	2745	}
2427		2746
		2747	sub write_runtime {
		2748	my $runtime = "$LOCALDIR/runtime";
		2749
		2750	# first touch the runtime file to show we are still running:
		2751	# the fsync below can take a very very long time.
		2752
		2753	IO::AIO::aio_utime $runtime, undef, undef;
		2754
		2755	my $guard = cf::lock_acquire "write_runtime";
		2756
		2757	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2758	or return;
		2759
		2760	my $value = $cf::RUNTIME + 90 + 10;
		2761	# 10 is the runtime save interval, for a monotonic clock
		2762	# 60 allows for the watchdog to kill the server.
		2763
		2764	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2765	and return;
		2766
		2767	# always fsync - this file is important
		2768	aio_fsync $fh
		2769	and return;
		2770
		2771	# touch it again to show we are up-to-date
		2772	aio_utime $fh, undef, undef;
		2773
		2774	close $fh
		2775	or return;
		2776
		2777	aio_rename "$runtime~", $runtime
		2778	and return;
		2779
		2780	warn "runtime file written.\n";
		2781
		2782	1
		2783	}
		2784
2428	sub emergency_save() {	2785	sub emergency_save() {
2429	my $freeze_guard = cf::freeze_mainloop;	2786	my $freeze_guard = cf::freeze_mainloop;
2430		2787
2431	warn "enter emergency perl save\n";	2788	warn "enter emergency perl save\n";
2432		2789
…		…
2463		2820
2464	warn Carp::longmess "post_cleanup backtrace"	2821	warn Carp::longmess "post_cleanup backtrace"
2465	if $make_core;	2822	if $make_core;
2466	}	2823	}
2467		2824
2468	sub reload() {	2825	sub do_reload_perl() {
2469	# can/must only be called in main	2826	# can/must only be called in main
2470	if ($Coro::current != $Coro::main) {	2827	if ($Coro::current != $Coro::main) {
2471	warn "can only reload from main coroutine";	2828	warn "can only reload from main coroutine";
2472	return;	2829	return;
2473	}	2830	}
…		…
2548	Symbol::delete_package "safe::$_"	2905	Symbol::delete_package "safe::$_"
2549	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2906	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2550		2907
2551	warn "unloading cf.pm \"a bit\"";	2908	warn "unloading cf.pm \"a bit\"";
2552	delete $INC{"cf.pm"};	2909	delete $INC{"cf.pm"};
		2910	delete $INC{"cf/pod.pm"};
2553		2911
2554	# don't, removes xs symbols, too,	2912	# don't, removes xs symbols, too,
2555	# and global variables created in xs	2913	# and global variables created in xs
2556	#Symbol::delete_package __PACKAGE__;	2914	#Symbol::delete_package __PACKAGE__;
2557		2915
…		…
2572	warn "reattaching attachments to maps";	2930	warn "reattaching attachments to maps";
2573	reattach $_ for values %MAP;	2931	reattach $_ for values %MAP;
2574	warn "reattaching attachments to players";	2932	warn "reattaching attachments to players";
2575	reattach $_ for values %PLAYER;	2933	reattach $_ for values %PLAYER;
2576		2934
2577	warn "loading reloadable resources";
2578	reload_resources;
2579
2580	warn "leaving sync_job";	2935	warn "leaving sync_job";
2581		2936
2582	1	2937	1
2583	} or do {	2938	} or do {
2584	warn $@;	2939	warn $@;
…		…
2589	warn "reloaded";	2944	warn "reloaded";
2590	};	2945	};
2591		2946
2592	our $RELOAD_WATCHER; # used only during reload	2947	our $RELOAD_WATCHER; # used only during reload
2593		2948
		2949	sub reload_perl() {
		2950	# doing reload synchronously and two reloads happen back-to-back,
		2951	# coro crashes during coro_state_free->destroy here.
		2952
		2953	$RELOAD_WATCHER ||= Event->timer (
		2954	reentrant => 0,
		2955	after => 0,
		2956	data => WF_AUTOCANCEL,
		2957	cb => sub {
		2958	do_reload_perl;
		2959	undef $RELOAD_WATCHER;
		2960	},
		2961	);
		2962	}
		2963
2594	register_command "reload" => sub {	2964	register_command "reload" => sub {
2595	my ($who, $arg) = @_;	2965	my ($who, $arg) = @_;
2596		2966
2597	if ($who->flag (FLAG_WIZ)) {	2967	if ($who->flag (FLAG_WIZ)) {
2598	$who->message ("reloading server.");	2968	$who->message ("reloading server.");
2599		2969	async { reload_perl };
2600	# doing reload synchronously and two reloads happen back-to-back,
2601	# coro crashes during coro_state_free->destroy here.
2602
2603	$RELOAD_WATCHER ||= Event->timer (
2604	reentrant => 0,
2605	after => 0,
2606	data => WF_AUTOCANCEL,
2607	cb => sub {
2608	reload;
2609	undef $RELOAD_WATCHER;
2610	},
2611	);
2612	}	2970	}
2613	};	2971	};
2614		2972
2615	unshift @INC, $LIBDIR;	2973	unshift @INC, $LIBDIR;
2616		2974
2617	my $bug_warning = 0;	2975	my $bug_warning = 0;
2618		2976
		2977	our @WAIT_FOR_TICK;
		2978	our @WAIT_FOR_TICK_BEGIN;
		2979
		2980	sub wait_for_tick {
		2981	return unless $TICK_WATCHER->is_active;
		2982	return if $Coro::current == $Coro::main;
		2983
		2984	my $signal = new Coro::Signal;
		2985	push @WAIT_FOR_TICK, $signal;
		2986	$signal->wait;
		2987	}
		2988
		2989	sub wait_for_tick_begin {
		2990	return unless $TICK_WATCHER->is_active;
		2991	return if $Coro::current == $Coro::main;
		2992
		2993	my $signal = new Coro::Signal;
		2994	push @WAIT_FOR_TICK_BEGIN, $signal;
		2995	$signal->wait;
		2996	}
		2997
		2998	my $min = 1e6;#d#
		2999	my $avg = 10;
2619	$TICK_WATCHER = Event->timer (	3000	$TICK_WATCHER = Event->timer (
2620	reentrant => 0,	3001	reentrant => 0,
2621	parked => 1,	3002	parked => 1,
2622	prio => 0,	3003	prio => 0,
2623	at => $NEXT_TICK || $TICK,	3004	at => $NEXT_TICK || $TICK,
…		…
2627	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3008	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2628	unless ++$bug_warning > 10;	3009	unless ++$bug_warning > 10;
2629	return;	3010	return;
2630	}	3011	}
2631		3012
2632	$NOW = Event::time;	3013	$NOW = $tick_start = Event::time;
2633		3014
2634	cf::server_tick; # one server iteration	3015	cf::server_tick; # one server iteration
		3016
		3017	0 && sync_job {#d#
		3018	for(1..10) {
		3019	my $t = Event::time;
		3020	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3021	or die;
		3022
		3023	$map->width (50);
		3024	$map->height (50);
		3025	$map->alloc;
		3026	$map->_load_objects ("/tmp/x.map", 1);
		3027	my $t = Event::time - $t;
		3028
		3029	#next unless $t < 0.0013;#d#
		3030	if ($t < $min) {
		3031	$min = $t;
		3032	}
		3033	$avg = $avg * 0.99 + $t * 0.01;
		3034	}
		3035	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3036	exit 0;
		3037	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3038	};
		3039
2635	$RUNTIME += $TICK;	3040	$RUNTIME += $TICK;
2636	$NEXT_TICK += $TICK;	3041	$NEXT_TICK += $TICK;
2637		3042
2638	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3043	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2639	$NEXT_RUNTIME_WRITE = $NOW + 10;	3044	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2641	write_runtime	3046	write_runtime
2642	or warn "ERROR: unable to write runtime file: $!";	3047	or warn "ERROR: unable to write runtime file: $!";
2643	};	3048	};
2644	}	3049	}
2645		3050
2646	$WAIT_FOR_TICK->broadcast;
2647	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2648
2649	# my $AFTER = Event::time;	3051	# my $AFTER = Event::time;
2650	# warn $AFTER - $NOW;#d#	3052	# warn $AFTER - $NOW;#d#
2651		3053
		3054	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3055	$sig->send;
		3056	}
		3057	while (my $sig = shift @WAIT_FOR_TICK) {
		3058	$sig->send;
		3059	}
		3060
		3061	$NOW = Event::time;
		3062
2652	# if we are delayed by four ticks or more, skip them all	3063	# if we are delayed by four ticks or more, skip them all
2653	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3064	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2654		3065
2655	$TICK_WATCHER->at ($NEXT_TICK);	3066	$TICK_WATCHER->at ($NEXT_TICK);
2656	$TICK_WATCHER->start;	3067	$TICK_WATCHER->start;
		3068
		3069	$LOAD = ($NOW - $tick_start) / $TICK;
		3070	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3071
		3072	_post_tick;
		3073
		3074
2657	},	3075	},
2658	);	3076	);
2659		3077
2660	{	3078	{
2661	BDB::max_poll_time $TICK * 0.1;	3079	BDB::max_poll_time $TICK * 0.1;
…		…
2689		3107
2690	cf::sync_job {	3108	cf::sync_job {
2691	eval {	3109	eval {
2692	BDB::db_env_open	3110	BDB::db_env_open
2693	$DB_ENV,	3111	$DB_ENV,
2694	$BDB_ENV_DIR,	3112	$BDBDIR,
2695	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3113	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2696	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3114	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2697	0666;	3115	0666;
2698		3116
2699	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3117	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2700		3118
2701	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3119	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2702	$DB_ENV->set_lk_detect;	3120	$DB_ENV->set_lk_detect;
2703	};	3121	};
2704		3122
…		…
2720	prio => 6,	3138	prio => 6,
2721	cb => \&IO::AIO::poll_cb,	3139	cb => \&IO::AIO::poll_cb,
2722	);	3140	);
2723	}	3141	}
2724		3142
		3143	my $_log_backtrace;
		3144
		3145	sub _log_backtrace {
		3146	my ($msg, @addr) = @_;
		3147
		3148	$msg =~ s/\n//;
		3149
		3150	# limit the # of concurrent backtraces
		3151	if ($_log_backtrace < 2) {
		3152	++$_log_backtrace;
		3153	async {
		3154	my @bt = fork_call {
		3155	@addr = map { sprintf "%x", $_ } @addr;
		3156	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3157	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3158	or die "addr2line: $!";
		3159
		3160	my @funcs;
		3161	my @res = <$fh>;
		3162	chomp for @res;
		3163	while (@res) {
		3164	my ($func, $line) = splice @res, 0, 2, ();
		3165	push @funcs, "[$func] $line";
		3166	}
		3167
		3168	@funcs
		3169	};
		3170
		3171	LOG llevInfo, "[ABT] $msg\n";
		3172	LOG llevInfo, "[ABT] $_\n" for @bt;
		3173	--$_log_backtrace;
		3174	};
		3175	} else {
		3176	LOG llevInfo, "[ABT] $msg\n";
		3177	LOG llevInfo, "[ABT] [suppressed]\n";
		3178	}
		3179	}
		3180
		3181	# load additional modules
		3182	use cf::pod;
		3183
2725	END { cf::emergency_save }	3184	END { cf::emergency_save }
2726		3185
2727	1	3186	1
2728		3187

Diff Legend

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