[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC

…		…
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
24		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	169	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		203
194	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	205	# within the Safe compartment.
196	for my $pkg (qw(	206	for my $pkg (qw(
197	cf::global cf::attachable	207	cf::global cf::attachable
…		…
205	}	215	}
206		216
207	$Event::DIED = sub {	217	$Event::DIED = sub {
208	warn "error in event callback: @_";	218	warn "error in event callback: @_";
209	};	219	};
		220
		221	#############################################################################
210		222
211	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
212		224
213	=over 4	225	=over 4
214		226
…		…
233	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234	$d	246	$d
235	} \|\| "[unable to dump $_[0]: '$@']";	247	} \|\| "[unable to dump $_[0]: '$@']";
236	}	248	}
237		249
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
241		251
242	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
243		253
244	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
245		255
246	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
247		264
248	=item cf::lock_wait $string	265	=item cf::lock_wait $string
249		266
250	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
251		268
…		…
317		334
318	BEGIN { *async = \&Coro::async_pool }	335	BEGIN { *async = \&Coro::async_pool }
319		336
320	=item cf::sync_job { BLOCK }	337	=item cf::sync_job { BLOCK }
321		338
322	The design of crossfire+ requires that the main coro ($Coro::main) is	339	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323	always able to handle events or runnable, as crossfire+ is only partly	340	is always able to handle events or runnable, as Crossfire TRT is only
324	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	341	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		342	acceptable.
325		343
326	If it must be done, put the blocking parts into C<sync_job>. This will run	344	If it must be done, put the blocking parts into C<sync_job>. This will run
327	the given BLOCK in another coroutine while waiting for the result. The	345	the given BLOCK in another coroutine while waiting for the result. The
328	server will be frozen during this time, so the block should either finish	346	server will be frozen during this time, so the block should either finish
329	fast or be very important.	347	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	407	$EXT_CORO{$coro+0} = $coro;
390		408
391	$coro	409	$coro
392	}	410	}
393		411
394	sub write_runtime {	412	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		413
397	# first touch the runtime file to show we are still running:	414	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	415	process, returning the results. Everything must be serialisable with
		416	Coro::Storable. May, of course, block. Note that the executed sub may
		417	never block itself or use any form of Event handling.
399		418
400	IO::AIO::aio_utime $runtime, undef, undef;	419	=cut
401		420
402	my $guard = cf::lock_acquire "write_runtime";	421	sub _store_scalar {
403		422	open my $fh, ">", \my $buf
404	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644	423	or die "fork_call: cannot open fh-to-buf in child : $!";
405	or return;	424	Storable::store_fd $_[0], $fh;
406
407	my $value = $cf::RUNTIME + 90 + 10;
408	# 10 is the runtime save interval, for a monotonic clock
409	# 60 allows for the watchdog to kill the server.
410
411	(aio_write $fh, 0, (length $value), $value, 0) <= 0
412	and return;
413
414	# always fsync - this file is important
415	aio_fsync $fh
416	and return;
417
418	# touch it again to show we are up-to-date
419	aio_utime $fh, undef, undef;
420
421	close $fh	425	close $fh;
422	or return;
423		426
424	aio_rename "$runtime~", $runtime	427	$buf
425	and return;	428	}
426		429
427	warn "runtime file written.\n";#d#	430	sub fork_call(&@) {
		431	my ($cb, @args) = @_;
428		432
		433	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		434	# or die "socketpair: $!";
		435	pipe my $fh1, my $fh2
		436	or die "pipe: $!";
		437
		438	if (my $pid = fork) {
		439	close $fh2;
		440
		441	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		442	warn "pst<$res>" unless $res =~ /^pst/;
		443	$res = Coro::Storable::thaw $res;
		444
		445	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		446
		447	Carp::confess $$res unless "ARRAY" eq ref $res;
		448
		449	return wantarray ? @$res : $res->[-1];
		450	} else {
		451	reset_signals;
		452	local $SIG{__WARN__};
		453	local $SIG{__DIE__};
		454	# just in case, this hack effectively disables event
		455	# in the child. cleaner and slower would be canceling all watchers,
		456	# but this works for the time being.
		457	local $Coro::idle;
		458	$Coro::current->prio (Coro::PRIO_MAX);
		459
		460	eval {
		461	close $fh1;
		462
		463	my @res = eval { $cb->(@args) };
		464
		465	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		466	close $fh2;
		467	};
		468
		469	warn $@ if $@;
		470	_exit 0;
429	1	471	}
		472	}
		473
		474	=item $value = cf::db_get $family => $key
		475
		476	Returns a single value from the environment database.
		477
		478	=item cf::db_put $family => $key => $value
		479
		480	Stores the given C<$value> in the family. It can currently store binary
		481	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		482
		483	=cut
		484
		485	our $DB;
		486
		487	sub db_init {
		488	unless ($DB) {
		489	$DB = BDB::db_create $DB_ENV;
		490
		491	cf::sync_job {
		492	eval {
		493	$DB->set_flags (BDB::CHKSUM);
		494
		495	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		496	BDB::CREATE \| BDB::AUTO_COMMIT, 0666;
		497	cf::cleanup "db_open(db): $!" if $!;
		498	};
		499	cf::cleanup "db_open(db): $@" if $@;
		500	};
		501	}
		502	}
		503
		504	sub db_get($$) {
		505	my $key = "$_[0]/$_[1]";
		506
		507	cf::sync_job {
		508	BDB::db_get $DB, undef, $key, my $data;
		509
		510	$! ? ()
		511	: $data
		512	}
		513	}
		514
		515	sub db_put($$$) {
		516	BDB::dbreq_pri 4;
		517	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		518	}
		519
		520	=item cf::cache $id => [$paths...], $processversion => $process
		521
		522	Generic caching function that returns the value of the resource $id,
		523	caching and regenerating as required.
		524
		525	This function can block.
		526
		527	=cut
		528
		529	sub cache {
		530	my ($id, $src, $processversion, $process) = @_;
		531
		532	my $meta =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	aio_stat $_
		537	and Carp::croak "$_: $!";
		538
		539	($_, (stat _)[7,9])
		540	} @$src;
		541
		542	my $dbmeta = db_get cache => "$id/meta";
		543	if ($dbmeta ne $meta) {
		544	# changed, we may need to process
		545
		546	my @data;
		547	my $md5;
		548
		549	for (0 .. $#$src) {
		550	0 <= aio_load $src->[$_], $data[$_]
		551	or Carp::croak "$src->[$_]: $!";
		552	}
		553
		554	# if processing is expensive, check
		555	# checksum first
		556	if (1) {
		557	$md5 =
		558	join "\x00",
		559	$processversion,
		560	map {
		561	Coro::cede;
		562	($src->[$_], Digest::MD5::md5_hex $data[$_])
		563	} 0.. $#$src;
		564
		565
		566	my $dbmd5 = db_get cache => "$id/md5";
		567	if ($dbmd5 eq $md5) {
		568	db_put cache => "$id/meta", $meta;
		569
		570	return db_get cache => "$id/data";
		571	}
		572	}
		573
		574	my $t1 = Time::HiRes::time;
		575	my $data = $process->(\@data);
		576	my $t2 = Time::HiRes::time;
		577
		578	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		579
		580	db_put cache => "$id/data", $data;
		581	db_put cache => "$id/md5" , $md5;
		582	db_put cache => "$id/meta", $meta;
		583
		584	return $data;
		585	}
		586
		587	db_get cache => "$id/data"
430	}	588	}
431		589
432	=item cf::datalog type => key => value, ...	590	=item cf::datalog type => key => value, ...
433		591
434	Log a datalog packet of the given type with the given key-value pairs.	592	Log a datalog packet of the given type with the given key-value pairs.
…		…
452	attach callbacks/event handlers (a collection of which is called an "attachment")	610	attach callbacks/event handlers (a collection of which is called an "attachment")
453	to it. All such attachable objects support the following methods.	611	to it. All such attachable objects support the following methods.
454		612
455	In the following description, CLASS can be any of C<global>, C<object>	613	In the following description, CLASS can be any of C<global>, C<object>
456	C<player>, C<client> or C<map> (i.e. the attachable objects in	614	C<player>, C<client> or C<map> (i.e. the attachable objects in
457	crossfire+).	615	Crossfire TRT).
458		616
459	=over 4	617	=over 4
460		618
461	=item $attachable->attach ($attachment, key => $value...)	619	=item $attachable->attach ($attachment, key => $value...)
462		620
…		…
664	_attach $registry, $klass, @attach;	822	_attach $registry, $klass, @attach;
665	}	823	}
666		824
667	$obj->{$name} = \%arg;	825	$obj->{$name} = \%arg;
668	} else {	826	} else {
669	warn "object uses attachment '$name' that is not available, postponing.\n";	827	warn "object uses attachment '$name' which is not available, postponing.\n";
670	}	828	}
671		829
672	$obj->{_attachment}{$name} = undef;	830	$obj->{_attachment}{$name} = undef;
673	}	831	}
674		832
…		…
714	";	872	";
715	die if $@;	873	die if $@;
716	}	874	}
717		875
718	our $override;	876	our $override;
719	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	877	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
720		878
721	sub override {	879	sub override {
722	$override = 1;	880	$override = 1;
723	@invoke_results = ();	881	@INVOKE_RESULTS = (@_);
724	}	882	}
725		883
726	sub do_invoke {	884	sub do_invoke {
727	my $event = shift;	885	my $event = shift;
728	my $callbacks = shift;	886	my $callbacks = shift;
729		887
730	@invoke_results = ();	888	@INVOKE_RESULTS = ();
731		889
732	local $override;	890	local $override;
733		891
734	for (@$callbacks) {	892	for (@$callbacks) {
735	eval { &{$_->[1]} };	893	eval { &{$_->[1]} };
…		…
752		910
753	Generate an object-specific event with the given arguments.	911	Generate an object-specific event with the given arguments.
754		912
755	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	913	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
756	removed in future versions), and there is no public API to access override	914	removed in future versions), and there is no public API to access override
757	results (if you must, access C<@cf::invoke_results> directly).	915	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		916
759	=back	917	=back
760		918
761	=cut	919	=cut
762		920
763	#############################################################################	921	#############################################################################
764	# object support	922	# object support
		923	#
		924
		925	sub _can_merge {
		926	my ($ob1, $ob2) = @_;
		927
		928	local $Storable::canonical = 1;
		929	my $fob1 = Storable::freeze $ob1;
		930	my $fob2 = Storable::freeze $ob2;
		931
		932	$fob1 eq $fob2
		933	}
765		934
766	sub reattach {	935	sub reattach {
767	# basically do the same as instantiate, without calling instantiate	936	# basically do the same as instantiate, without calling instantiate
768	my ($obj) = @_;	937	my ($obj) = @_;
769		938
…		…
872	or return;	1041	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1042	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1043	}
875		1044
876	warn sprintf "loading %s (%d)\n",	1045	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av \|\| []};#d#	1046	$filename, length $data, scalar @{$av \|\| []};
878	return ($data, $av);	1047	return ($data, $av);
879	}	1048	}
		1049
		1050	=head2 COMMAND CALLBACKS
		1051
		1052	=over 4
		1053
		1054	=cut
880		1055
881	#############################################################################	1056	#############################################################################
882	# command handling &c	1057	# command handling &c
883		1058
884	=item cf::register_command $name => \&callback($ob,$args);	1059	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1072	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1073	}
899		1074
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1075	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1076
902	Register a callbackf ro execution when the client sends an extcmd packet.	1077	Register a callback for execution when the client sends an (synchronous)
		1078	extcmd packet. Ext commands will be processed in the order they are
		1079	received by the server, like other user commands. The first argument is
		1080	the logged-in player. Ext commands can only be processed after a player
		1081	has logged in successfully.
903		1082
904	If the callback returns something, it is sent back as if reply was being	1083	If the callback returns something, it is sent back as if reply was being
905	called.	1084	called.
906		1085
		1086	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1087
		1088	Register a callback for execution when the client sends an (asynchronous)
		1089	exticmd packet. Exti commands are processed by the server as soon as they
		1090	are received, i.e. out of order w.r.t. other commands. The first argument
		1091	is a client socket. Exti commands can be received anytime, even before
		1092	log-in.
		1093
		1094	If the callback returns something, it is sent back as if reply was being
		1095	called.
		1096
907	=cut	1097	=cut
908		1098
909	sub register_extcmd {	1099	sub register_extcmd {
910	my ($name, $cb) = @_;	1100	my ($name, $cb) = @_;
911		1101
912	$EXTCMD{$name} = $cb;	1102	$EXTCMD{$name} = $cb;
		1103	}
		1104
		1105	sub register_exticmd {
		1106	my ($name, $cb) = @_;
		1107
		1108	$EXTICMD{$name} = $cb;
913	}	1109	}
914		1110
915	cf::player->attach (	1111	cf::player->attach (
916	on_command => sub {	1112	on_command => sub {
917	my ($pl, $name, $params) = @_;	1113	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1122	cf::override;
927	},	1123	},
928	on_extcmd => sub {	1124	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1125	my ($pl, $buf) = @_;
930		1126
931	my $msg = eval { from_json $buf };	1127	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1128
933	if (ref $msg) {	1129	if (ref $msg) {
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1130	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935	if (my %reply = $cb->($pl, $msg)) {	1131	if (my %reply = $cb->($pl, $msg)) {
936	$pl->ext_reply ($msg->{msgid}, %reply);	1132	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
942		1138
943	cf::override;	1139	cf::override;
944	},	1140	},
945	);	1141	);
946		1142
947	sub load_extension {
948	my ($path) = @_;
949
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955
956	warn "... loading '$path' into '$pkg'\n";
957
958	open my $fh, "<:utf8", $path
959	or die "$path: $!";
960
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	unless (eval $source) {
968	my $msg = $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970	if ($source =~ /^#!.perl.#.*MANDATORY/m) { # ugly match
971	warn $@;
972	warn "mandatory extension failed to load, exiting.\n";
973	exit 1;
974	}
975	die $@;
976	}
977
978	push @EXTS, $pkg;
979	}
980
981	sub load_extensions {	1143	sub load_extensions {
		1144	cf::sync_job {
		1145	my %todo;
		1146
982	for my $ext (<$LIBDIR/*.ext>) {	1147	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1148	next unless -r $path;
984	eval {	1149
985	load_extension $ext;	1150	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1151	my $base = $1;
		1152	my $pkg = $1;
		1153	$pkg =~ s/[^[:word:]]/_/g;
		1154	$pkg = "ext::$pkg";
		1155
		1156	open my $fh, "<:utf8", $path
		1157	or die "$path: $!";
		1158
		1159	my $source = do { local $/; <$fh> };
		1160
		1161	my %ext = (
		1162	path => $path,
		1163	base => $base,
		1164	pkg => $pkg,
		1165	);
		1166
		1167	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1168	if $source =~ /\A#!.?perl.?#\s(.)$/m;
		1169
		1170	$ext{source} =
		1171	"package $pkg; use strict; use utf8;\n"
		1172	. "#line 1 \"$path\"\n{\n"
		1173	. $source
		1174	. "\n};\n1";
		1175
		1176	$todo{$base} = \%ext;
		1177	}
		1178
		1179	my %done;
		1180	while (%todo) {
		1181	my $progress;
		1182
		1183	while (my ($k, $v) = each %todo) {
		1184	for (split /,\s*/, $v->{meta}{depends}) {
		1185	goto skip
		1186	unless exists $done{$_};
		1187	}
		1188
		1189	warn "... loading '$k' into '$v->{pkg}'\n";
		1190
		1191	unless (eval $v->{source}) {
		1192	my $msg = $@ ? "$v->{path}: $@\n"
		1193	: "$v->{base}: extension inactive.\n";
		1194
		1195	if (exists $v->{meta}{mandatory}) {
		1196	warn $msg;
		1197	warn "mandatory extension failed to load, exiting.\n";
		1198	exit 1;
		1199	}
		1200
		1201	warn $msg;
		1202	}
		1203
		1204	$done{$k} = delete $todo{$k};
		1205	push @EXTS, $v->{pkg};
		1206	$progress = 1;
986	1	1207	}
987	} or warn "$ext not loaded: $@";	1208
		1209	skip:
		1210	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1211	unless $progress;
		1212	}
988	}	1213	};
989	}	1214	}
990		1215
991	#############################################################################	1216	#############################################################################
		1217
		1218	=back
992		1219
993	=head2 CORE EXTENSIONS	1220	=head2 CORE EXTENSIONS
994		1221
995	Functions and methods that extend core crossfire objects.	1222	Functions and methods that extend core crossfire objects.
996		1223
…		…
1184	}	1411	}
1185		1412
1186	\@paths	1413	\@paths
1187	}	1414	}
1188		1415
		1416	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1417
		1418	Expand crossfire pod fragments into protocol xml.
		1419
		1420	=cut
		1421
		1422	sub expand_cfpod {
		1423	((my $self), (local $_)) = @_;
		1424
		1425	# escape & and <
		1426	s/&/&/g;
		1427	s/(?<![BIUGH])</</g;
		1428
		1429	# this is buggy, it needs to properly take care of nested <'s
		1430
		1431	1 while
		1432	# replace B<>, I<>, U<> etc.
		1433	s/B<([^\>]*)>/<b>$1<\/b>/
		1434	\|\| s/I<([^\>]*)>/<i>$1<\/i>/
		1435	\|\| s/U<([^\>]*)>/<u>$1<\/u>/
		1436	# replace G<male\|female> tags
		1437	\|\| s{G<([^>\|])\\|([^>])>}{
		1438	$self->gender ? $2 : $1
		1439	}ge
		1440	# replace H<hint text>
		1441	\|\| s{H<([^\>]*)>}
		1442	{
		1443	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1444	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1445	"")
		1446	[$self->{hintmode}]
		1447	}ge;
		1448
		1449	# create single paragraphs (very hackish)
		1450	s/(?<=\S)\n(?=\w)/ /g;
		1451
		1452	# compress some whitespace
		1453	s/\s+\n/\n/g; # ws line-ends
		1454	s/\n\n+/\n/g; # double lines
		1455	s/^\n+//; # beginning lines
		1456	s/\n+$//; # ending lines
		1457
		1458	$_
		1459	}
		1460
		1461	sub hintmode {
		1462	$_[0]{hintmode} = $_[1] if @_ > 1;
		1463	$_[0]{hintmode}
		1464	}
		1465
1189	=item $player->ext_reply ($msgid, %msg)	1466	=item $player->ext_reply ($msgid, %msg)
1190		1467
1191	Sends an ext reply to the player.	1468	Sends an ext reply to the player.
1192		1469
1193	=cut	1470	=cut
1194		1471
1195	sub ext_reply($$%) {	1472	sub ext_reply($$%) {
1196	my ($self, $id, %msg) = @_;	1473	my ($self, $id, %msg) = @_;
1197		1474
1198	$msg{msgid} = $id;	1475	$msg{msgid} = $id;
1199		1476	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200	$self->send ("ext " . cf::to_json \%msg);
1201	}	1477	}
1202		1478
1203	=item $player->ext_event ($type, %msg)	1479	=item $player->ext_event ($type, %msg)
1204		1480
1205	Sends an ext event to the client.	1481	Sends an ext event to the client.
…		…
1220		1496
1221	package cf::region;	1497	package cf::region;
1222		1498
1223	=item cf::region::find_by_path $path	1499	=item cf::region::find_by_path $path
1224		1500
1225	Tries to decuce the probable region for a map knowing only its path.	1501	Tries to decuce the likely region for a map knowing only its path.
1226		1502
1227	=cut	1503	=cut
1228		1504
1229	sub find_by_path($) {	1505	sub find_by_path($) {
1230	my ($path) = @_;	1506	my ($path) = @_;
1231		1507
1232	my ($match, $specificity);	1508	my ($match, $specificity);
1233		1509
1234	for my $region (list) {	1510	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1511	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1512	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1513	if $region->specificity > $specificity;
1238	}	1514	}
1239	}	1515	}
1240		1516
…		…
1304	my ($self, $merge) = @_;	1580	my ($self, $merge) = @_;
1305		1581
1306	# we have to keep some variables in memory intact	1582	# we have to keep some variables in memory intact
1307	local $self->{path};	1583	local $self->{path};
1308	local $self->{load_path};	1584	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1585
1312	$self->SUPER::thawer_merge ($merge);	1586	$self->SUPER::thawer_merge ($merge);
1313	}	1587	}
1314		1588
1315	sub normalise {	1589	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1636	$self->init; # pass $1 etc.
1363	return $self;	1637	return $self;
1364	}	1638	}
1365	}	1639	}
1366		1640
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1641	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1642	()
1369	}	1643	}
1370		1644
1371	sub init {	1645	sub init {
1372	my ($self) = @_;	1646	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1687	sub change_all_map_light {
1414	my ($change) = @_;	1688	my ($change) = @_;
1415		1689
1416	$_->change_map_light ($change)	1690	$_->change_map_light ($change)
1417	for grep $_->outdoor, values %cf::MAP;	1691	for grep $_->outdoor, values %cf::MAP;
		1692	}
		1693
		1694	sub decay_objects {
		1695	my ($self) = @_;
		1696
		1697	return if $self->{deny_reset};
		1698
		1699	$self->do_decay_objects;
1418	}	1700	}
1419		1701
1420	sub unlink_save {	1702	sub unlink_save {
1421	my ($self) = @_;	1703	my ($self) = @_;
1422		1704
…		…
1480	$self->load_header_orig	1762	$self->load_header_orig
1481	or return;	1763	or return;
1482	$self->prepare_orig;	1764	$self->prepare_orig;
1483	}	1765	}
1484		1766
		1767	$self->{deny_reset} = 1
		1768	if $self->no_reset;
		1769
1485	$self->default_region (cf::region::find_by_path $self->{path})	1770	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1771	unless $self->default_region;
1487		1772
1488	1	1773	1
1489	}	1774	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1789	$map->{last_save} = $cf::RUNTIME;
1505		1790
1506	$map->load_header	1791	$map->load_header
1507	or return;	1792	or return;
1508		1793
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1794	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1795	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1796	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1797	$map->reset;
1513	undef $guard;	1798	undef $guard;
1514	return find $path;	1799	return find $path;
…		…
1581	my ($self, $ob) = @_;	1866	my ($self, $ob) = @_;
1582		1867
1583	return find "~" . $ob->name . "/" . $self->{path}	1868	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1869	if $self->per_player;
1585		1870
		1871	# return find "?party/" . $ob->name . "/" . $self->{path}
		1872	# if $self->per_party;
		1873
1586	$self	1874	$self
1587	}	1875	}
1588		1876
1589	# find and load all maps in the 3x3 area around a map	1877	# find and load all maps in the 3x3 area around a map
1590	sub load_diag {	1878	sub load_diag {
…		…
1636		1924
1637	undef $MAP_PREFETCH{$path};	1925	undef $MAP_PREFETCH{$path};
1638	$MAP_PREFETCHER \|\|= cf::async {	1926	$MAP_PREFETCHER \|\|= cf::async {
1639	while (%MAP_PREFETCH) {	1927	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	1928	for my $path (keys %MAP_PREFETCH) {
1641	my $map = find $path	1929	if (my $map = find $path) {
1642	or next;
1643	$map->load;	1930	$map->load;
		1931	}
1644		1932
1645	delete $MAP_PREFETCH{$path};	1933	delete $MAP_PREFETCH{$path};
1646	}	1934	}
1647	}	1935	}
1648	undef $MAP_PREFETCHER;	1936	undef $MAP_PREFETCHER;
…		…
1700		1988
1701	sub reset_at {	1989	sub reset_at {
1702	my ($self) = @_;	1990	my ($self) = @_;
1703		1991
1704	# TODO: safety, remove and allow resettable per-player maps	1992	# TODO: safety, remove and allow resettable per-player maps
1705	return 1e99 if $self->isa ("ext::map_per_player");#d#
1706	return 1e99 if $self->{deny_reset};	1993	return 1e99 if $self->{deny_reset};
1707		1994
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1995	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	my $to = List::Util::min $MAX_RESET, $self->reset_timeout \|\| $DEFAULT_RESET;	1996	my $to = List::Util::min $MAX_RESET, $self->reset_timeout \|\| $DEFAULT_RESET;
1710		1997
…		…
1721	my ($self) = @_;	2008	my ($self) = @_;
1722		2009
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	2010	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2011
1725	return if $self->players;	2012	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2013
1728	warn "resetting map ", $self->path;#d#	2014	warn "resetting map ", $self->path;
1729		2015
1730	$self->in_memory (cf::MAP_SWAPPED);	2016	$self->in_memory (cf::MAP_SWAPPED);
1731		2017
1732	# need to save uniques path	2018	# need to save uniques path
1733	unless ($self->{deny_save}) {	2019	unless ($self->{deny_save}) {
…		…
1765	$cf::MAP{$self->path} = $self;	2051	$cf::MAP{$self->path} = $self;
1766		2052
1767	$self->reset; # polite request, might not happen	2053	$self->reset; # polite request, might not happen
1768	}	2054	}
1769		2055
		2056	=item $maps = cf::map::tmp_maps
		2057
		2058	Returns an arrayref with all map paths of currently instantiated and saved
		2059	maps. May block.
		2060
		2061	=cut
		2062
		2063	sub tmp_maps() {
		2064	[
		2065	map {
		2066	utf8::decode $_;
		2067	/\.map$/
		2068	? normalise $_
		2069	: ()
		2070	} @{ aio_readdir $TMPDIR or [] }
		2071	]
		2072	}
		2073
		2074	=item $maps = cf::map::random_maps
		2075
		2076	Returns an arrayref with all map paths of currently instantiated and saved
		2077	random maps. May block.
		2078
		2079	=cut
		2080
		2081	sub random_maps() {
		2082	[
		2083	map {
		2084	utf8::decode $_;
		2085	/\.map$/
		2086	? normalise "?random/$_"
		2087	: ()
		2088	} @{ aio_readdir $RANDOMDIR or [] }
		2089	]
		2090	}
		2091
1770	=item cf::map::unique_maps	2092	=item cf::map::unique_maps
1771		2093
1772	Returns an arrayref of paths of all shared maps that have	2094	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2095	instantiated unique items. May block.
1774		2096
1775	=cut	2097	=cut
1776		2098
1777	sub unique_maps() {	2099	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2100	[
1779	or return;	2101	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2102	utf8::decode $_;
1785	next if /\.pst$/;	2103	/\.map$/
1786	next unless /^$PATH_SEP/o;	2104	? normalise $_
1787		2105	: ()
1788	push @paths, cf::map::normalise $_;	2106	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2107	]
1790
1791	\@paths
1792	}	2108	}
1793		2109
1794	package cf;	2110	package cf;
1795		2111
1796	=back	2112	=back
…		…
1842		2158
1843	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	2159	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
1844		2160
1845	if ($self->{record_replies}) {	2161	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2162	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2163
1847	} else {	2164	} else {
		2165	my $pl = $self->contr;
		2166
		2167	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2168	my $diag = $pl->{npc_dialog};
		2169	$diag->{pl}->ext_reply (
		2170	$diag->{id},
		2171	msgtype => "reply",
		2172	msg => $diag->{pl}->expand_cfpod ($msg),
		2173	add_topics => []
		2174	);
		2175
		2176	} else {
1848	$msg = $npc->name . " says: $msg" if $npc;	2177	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2178	$self->message ($msg, $flags);
		2179	}
1850	}	2180	}
1851	}	2181	}
1852		2182
1853	=item $player_object->may ("access")	2183	=item $player_object->may ("access")
1854		2184
…		…
1943		2273
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2274	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2275	$self->enter_map ($map, $x, $y);
1946	}	2276	}
1947		2277
1948	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2278	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949		2279
1950	Moves the player to the given map-path and coordinates by first freezing	2280	Moves the player to the given map-path and coordinates by first freezing
1951	her, loading and preparing them map, calling the provided $check callback	2281	her, loading and preparing them map, calling the provided $check callback
1952	that has to return the map if sucecssful, and then unfreezes the player on	2282	that has to return the map if sucecssful, and then unfreezes the player on
1953	the new (success) or old (failed) map position.	2283	the new (success) or old (failed) map position. In either case, $done will
		2284	be called at the end of this process.
1954		2285
1955	=cut	2286	=cut
1956		2287
1957	our $GOTOGEN;	2288	our $GOTOGEN;
1958		2289
1959	sub cf::object::player::goto {	2290	sub cf::object::player::goto {
1960	my ($self, $path, $x, $y, $check) = @_;	2291	my ($self, $path, $x, $y, $check, $done) = @_;
1961		2292
1962	# do generation counting so two concurrent goto's will be executed in-order	2293	# do generation counting so two concurrent goto's will be executed in-order
1963	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2294	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964		2295
1965	$self->enter_link;	2296	$self->enter_link;
…		…
1985		2316
1986	if ($gen == $self->{_goto_generation}) {	2317	if ($gen == $self->{_goto_generation}) {
1987	delete $self->{_goto_generation};	2318	delete $self->{_goto_generation};
1988	$self->leave_link ($map, $x, $y);	2319	$self->leave_link ($map, $x, $y);
1989	}	2320	}
		2321
		2322	$done->() if $done;
1990	})->prio (1);	2323	})->prio (1);
1991	}	2324	}
1992		2325
1993	=item $player_object->enter_exit ($exit_object)	2326	=item $player_object->enter_exit ($exit_object)
1994		2327
…		…
2063	my $hp = $exit->stats->hp;	2396	my $hp = $exit->stats->hp;
2064	my $sp = $exit->stats->sp;	2397	my $sp = $exit->stats->sp;
2065		2398
2066	$self->enter_link;	2399	$self->enter_link;
2067		2400
		2401	# if exit is damned, update players death & WoR home-position
		2402	$self->contr->savebed ($slaying, $hp, $sp)
		2403	if $exit->flag (FLAG_DAMNED);
		2404
2068	(async {	2405	(async {
2069	$self->deactivate_recursive; # just to be sure	2406	$self->deactivate_recursive; # just to be sure
2070	unless (eval {	2407	unless (eval {
2071	$self->goto ($slaying, $hp, $sp);	2408	$self->goto ($slaying, $hp, $sp);
2072		2409
…		…
2099		2436
2100	utf8::encode $text;	2437	utf8::encode $text;
2101	$self->send_packet (sprintf "drawinfo %d %s", $flags \|\| cf::NDI_BLACK, $text);	2438	$self->send_packet (sprintf "drawinfo %d %s", $flags \|\| cf::NDI_BLACK, $text);
2102	}	2439	}
2103		2440
		2441	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2442
		2443	Send a drawinfo or msg packet to the client, formatting the msg for the
		2444	client if neccessary. C<$type> should be a string identifying the type of
		2445	the message, with C<log> being the default. If C<$color> is negative, suppress
		2446	the message unless the client supports the msg packet.
		2447
		2448	=cut
		2449
		2450	sub cf::client::send_msg {
		2451	my ($self, $channel, $msg, $color, @extra) = @_;
		2452
		2453	$msg = $self->pl->expand_cfpod ($msg);
		2454
		2455	return unless @extra \|\| length $msg;
		2456
		2457	$color &= ~cf::NDI_UNIQUE; # just in case...
		2458
		2459	if (ref $channel) {
		2460	# send meta info to client, if not yet sent
		2461	unless (exists $self->{channel}{$channel->{id}}) {
		2462	$self->{channel}{$channel->{id}} = $channel;
		2463	$self->ext_event (channel_info => %$channel);
		2464	}
		2465
		2466	$channel = $channel->{id};
		2467	}
		2468
		2469	if ($self->can_msg) {
		2470	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2471	} else {
		2472	# replace some tags by gcfclient-compatible ones
		2473	for ($msg) {
		2474	1 while
		2475	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2476	\|\| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2477	\|\| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2478	\|\| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2479	\|\| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2480	}
		2481
		2482	if ($color >= 0) {
		2483	if (0 && $msg =~ /\[/) {
		2484	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2485	} else {
		2486	$msg =~ s/\[\/?(?:b\|i\|u\|fixed\|color)[^\]]*\]//g;
		2487	$self->send_packet ("drawinfo $color $msg")
		2488	}
		2489	}
		2490	}
		2491	}
		2492
2104	=item $client->ext_event ($type, %msg)	2493	=item $client->ext_event ($type, %msg)
2105		2494
2106	Sends an exti event to the client.	2495	Sends an ext event to the client.
2107		2496
2108	=cut	2497	=cut
2109		2498
2110	sub cf::client::ext_event($$%) {	2499	sub cf::client::ext_event($$%) {
2111	my ($self, $type, %msg) = @_;	2500	my ($self, $type, %msg) = @_;
2112		2501
		2502	return unless $self->extcmd;
		2503
2113	$msg{msgtype} = "event_$type";	2504	$msg{msgtype} = "event_$type";
2114	$self->send_packet ("ext " . cf::to_json \%msg);	2505	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115	}	2506	}
2116		2507
2117	=item $success = $client->query ($flags, "text", \&cb)	2508	=item $success = $client->query ($flags, "text", \&cb)
2118		2509
2119	Queues a query to the client, calling the given callback with	2510	Queues a query to the client, calling the given callback with
2120	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2511	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2512	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122		2513
2123	Queries can fail, so check the return code. Or don't, as queries will become	2514	Queries can fail, so check the return code. Or don't, as queries will
2124	reliable at some point in the future.	2515	become reliable at some point in the future.
2125		2516
2126	=cut	2517	=cut
2127		2518
2128	sub cf::client::query {	2519	sub cf::client::query {
2129	my ($self, $flags, $text, $cb) = @_;	2520	my ($self, $flags, $text, $cb) = @_;
…		…
2137	utf8::encode $text;	2528	utf8::encode $text;
2138	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2529	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139		2530
2140	$self->send_packet ($self->{query_queue}[0][0])	2531	$self->send_packet ($self->{query_queue}[0][0])
2141	if @{ $self->{query_queue} } == 1;	2532	if @{ $self->{query_queue} } == 1;
		2533
		2534	1
2142	}	2535	}
2143		2536
2144	cf::client->attach (	2537	cf::client->attach (
		2538	on_connect => sub {
		2539	my ($ns) = @_;
		2540
		2541	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2542	},
2145	on_reply => sub {	2543	on_reply => sub {
2146	my ($ns, $msg) = @_;	2544	my ($ns, $msg) = @_;
2147		2545
2148	# this weird shuffling is so that direct followup queries	2546	# this weird shuffling is so that direct followup queries
2149	# get handled first	2547	# get handled first
…		…
2161	} else {	2559	} else {
2162	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2560	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163	}	2561	}
2164	}	2562	}
2165	},	2563	},
		2564	on_exticmd => sub {
		2565	my ($ns, $buf) = @_;
		2566
		2567	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2568
		2569	if (ref $msg) {
		2570	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2571	if (my %reply = $cb->($ns, $msg)) {
		2572	$reply{msgid} = $msg->{msgid};
		2573	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2574	}
		2575	}
		2576	} else {
		2577	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2578	}
		2579
		2580	cf::override;
		2581	},
2166	);	2582	);
2167		2583
2168	=item $client->async (\&cb)	2584	=item $client->async (\&cb)
2169		2585
2170	Create a new coroutine, running the specified callback. The coroutine will	2586	Create a new coroutine, running the specified callback. The coroutine will
…		…
2219		2635
2220	=pod	2636	=pod
2221		2637
2222	The following functions and methods are available within a safe environment:	2638	The following functions and methods are available within a safe environment:
2223		2639
2224	cf::object contr pay_amount pay_player map	2640	cf::object
		2641	contr pay_amount pay_player map x y force_find force_add
		2642	insert remove
		2643
2225	cf::object::player player	2644	cf::object::player
2226	cf::player peaceful	2645	player
2227	cf::map trigger	2646
		2647	cf::player
		2648	peaceful
		2649
		2650	cf::map
		2651	trigger
2228		2652
2229	=cut	2653	=cut
2230		2654
2231	for (	2655	for (
2232	["cf::object" => qw(contr pay_amount pay_player map)],	2656	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2657	insert remove)],
2233	["cf::object::player" => qw(player)],	2658	["cf::object::player" => qw(player)],
2234	["cf::player" => qw(peaceful)],	2659	["cf::player" => qw(peaceful)],
2235	["cf::map" => qw(trigger)],	2660	["cf::map" => qw(trigger)],
2236	) {	2661	) {
2237	no strict 'refs';	2662	no strict 'refs';
…		…
2308	=back	2733	=back
2309		2734
2310	=cut	2735	=cut
2311		2736
2312	#############################################################################	2737	#############################################################################
2313
2314	=head2 EXTENSION DATABASE SUPPORT
2315
2316	Crossfire maintains a very simple database for extension use. It can
2317	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318	convert to/from binary).
2319
2320	The parameter C<$family> should best start with the name of the extension
2321	using it, it should be unique.
2322
2323	=over 4
2324
2325	=item $value = cf::db_get $family => $key
2326
2327	Returns a single value from the database.
2328
2329	=item cf::db_put $family => $key => $value
2330
2331	Stores the given C<$value> in the family.
2332
2333	=cut
2334
2335	our $DB;
2336
2337	sub db_init {
2338	unless ($DB) {
2339	$DB = BDB::db_create $DB_ENV;
2340
2341	cf::sync_job {
2342	eval {
2343	$DB->set_flags (BDB::CHKSUM);
2344
2345	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346	BDB::CREATE \| BDB::AUTO_COMMIT, 0666;
2347	cf::cleanup "db_open(db): $!" if $!;
2348	};
2349	cf::cleanup "db_open(db): $@" if $@;
2350	};
2351	}
2352	}
2353
2354	sub db_get($$) {
2355	my $key = "$_[0]/$_[1]";
2356
2357	cf::sync_job {
2358	BDB::db_get $DB, undef, $key, my $data;
2359
2360	$! ? ()
2361	: $data
2362	}
2363	}
2364
2365	sub db_put($$$) {
2366	BDB::dbreq_pri 4;
2367	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368	}
2369
2370	=item cf::cache $id => [$paths...], $processversion => $process
2371
2372	Generic caching function that returns the value of the resource $id,
2373	caching and regenerating as required.
2374
2375	This function can block.
2376
2377	=cut
2378
2379	sub cache {
2380	my ($id, $src, $processversion, $process) = @_;
2381
2382	my $meta =
2383	join "\x00",
2384	$processversion,
2385	map {
2386	aio_stat $_
2387	and Carp::croak "$_: $!";
2388
2389	($_, (stat _)[7,9])
2390	} @$src;
2391
2392	my $dbmeta = db_get cache => "$id/meta";
2393	if ($dbmeta ne $meta) {
2394	# changed, we may need to process
2395
2396	my @data;
2397	my $md5;
2398
2399	for (0 .. $#$src) {
2400	0 <= aio_load $src->[$_], $data[$_]
2401	or Carp::croak "$src->[$_]: $!";
2402	}
2403
2404	# if processing is expensive, check
2405	# checksum first
2406	if (1) {
2407	$md5 =
2408	join "\x00",
2409	$processversion,
2410	map {
2411	Coro::cede;
2412	($src->[$_], Digest::MD5::md5_hex $data[$_])
2413	} 0.. $#$src;
2414
2415
2416	my $dbmd5 = db_get cache => "$id/md5";
2417	if ($dbmd5 eq $md5) {
2418	db_put cache => "$id/meta", $meta;
2419
2420	return db_get cache => "$id/data";
2421	}
2422	}
2423
2424	my $t1 = Time::HiRes::time;
2425	my $data = $process->(\@data);
2426	my $t2 = Time::HiRes::time;
2427
2428	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430	db_put cache => "$id/data", $data;
2431	db_put cache => "$id/md5" , $md5;
2432	db_put cache => "$id/meta", $meta;
2433
2434	return $data;
2435	}
2436
2437	db_get cache => "$id/data"
2438	}
2439
2440	=item fork_call { }, $args
2441
2442	Executes the given code block with the given arguments in a seperate
2443	process, returning the results. Everything must be serialisable with
2444	Coro::Storable. May, of course, block. Note that the executed sub may
2445	never block itself or use any form of Event handling.
2446
2447	=cut
2448
2449	sub fork_call(&@) {
2450	my ($cb, @args) = @_;
2451
2452	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453	# or die "socketpair: $!";
2454	pipe my $fh1, my $fh2
2455	or die "pipe: $!";
2456
2457	if (my $pid = fork) {
2458	close $fh2;
2459
2460	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461	$res = Coro::Storable::thaw $res;
2462
2463	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465	die $$res unless "ARRAY" eq ref $res;
2466
2467	return wantarray ? @$res : $res->[-1];
2468	} else {
2469	reset_signals;
2470	local $SIG{__WARN__};
2471	local $SIG{__DIE__};
2472	eval {
2473	close $fh1;
2474
2475	my @res = eval { $cb->(@args) };
2476	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477	};
2478
2479	warn $@ if $@;
2480	_exit 0;
2481	}
2482	}
2483
2484	#############################################################################
2485	# the server's init and main functions	2738	# the server's init and main functions
2486		2739
2487	sub load_facedata($) {	2740	sub load_facedata($) {
2488	my ($path) = @_;	2741	my ($path) = @_;
2489		2742
…		…
2501	{	2754	{
2502	my $faces = $facedata->{faceinfo};	2755	my $faces = $facedata->{faceinfo};
2503		2756
2504	while (my ($face, $info) = each %$faces) {	2757	while (my ($face, $info) = each %$faces) {
2505	my $idx = (cf::face::find $face) \|\| cf::face::alloc $face;	2758	my $idx = (cf::face::find $face) \|\| cf::face::alloc $face;
2506	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2759	cf::face::set_visibility $idx, $info->{visibility};
		2760	cf::face::set_magicmap $idx, $info->{magicmap};
2507	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2761	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2508	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2762	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2509	Coro::cede;	2763
		2764	cf::cede_to_tick;
2510	}	2765	}
2511		2766
2512	while (my ($face, $info) = each %$faces) {	2767	while (my ($face, $info) = each %$faces) {
2513	next unless $info->{smooth};	2768	next unless $info->{smooth};
2514	my $idx = cf::face::find $face	2769	my $idx = cf::face::find $face
2515	or next;	2770	or next;
2516	if (my $smooth = cf::face::find $info->{smooth}) {	2771	if (my $smooth = cf::face::find $info->{smooth}) {
		2772	cf::face::set_smooth $idx, $smooth;
2517	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2773	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518	} else {	2774	} else {
2519	warn "smooth face '$info->{smooth}' not found for face '$face'";	2775	warn "smooth face '$info->{smooth}' not found for face '$face'";
2520	}	2776	}
2521	Coro::cede;	2777
		2778	cf::cede_to_tick;
2522	}	2779	}
2523	}	2780	}
2524		2781
2525	{	2782	{
2526	my $anims = $facedata->{animinfo};	2783	my $anims = $facedata->{animinfo};
2527		2784
2528	while (my ($anim, $info) = each %$anims) {	2785	while (my ($anim, $info) = each %$anims) {
2529	cf::anim::set $anim, $info->{frames}, $info->{facings};	2786	cf::anim::set $anim, $info->{frames}, $info->{facings};
2530	Coro::cede;	2787	cf::cede_to_tick;
2531	}	2788	}
2532		2789
2533	cf::anim::invalidate_all; # d'oh	2790	cf::anim::invalidate_all; # d'oh
		2791	}
		2792
		2793	{
		2794	# TODO: for gcfclient pleasure, we should give resources
		2795	# that gcfclient doesn't grok a >10000 face index.
		2796	my $res = $facedata->{resource};
		2797	my $enc = JSON::XS->new->utf8->canonical;
		2798
		2799	while (my ($name, $info) = each %$res) {
		2800	my $meta = $enc->encode ({
		2801	name => $name,
		2802	type => $info->{type},
		2803	copyright => $info->{copyright}, #TODO#
		2804	});
		2805
		2806	my $idx = (cf::face::find $name) \|\| cf::face::alloc $name;
		2807
		2808	if ($name =~ /\.jpg$/) {
		2809	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2810	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2811	} else {
		2812	my $data = pack "(w/a)", $meta, $info->{data};
		2813	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2814
		2815	cf::face::set_type $idx, 1;
		2816	cf::face::set_data $idx, 0, $data, $chk;
		2817	}
		2818
		2819	cf::cede_to_tick;
		2820	}
2534	}	2821	}
2535		2822
2536	1	2823	1
2537	}	2824	}
2538		2825
2539	sub reload_regions {	2826	sub reload_regions {
2540	load_resource_file "$MAPDIR/regions"	2827	load_resource_file "$MAPDIR/regions"
2541	or die "unable to load regions file\n";	2828	or die "unable to load regions file\n";
		2829
		2830	for (cf::region::list) {
		2831	$_->{match} = qr/$_->{match}/
		2832	if exists $_->{match};
		2833	}
2542	}	2834	}
2543		2835
2544	sub reload_facedata {	2836	sub reload_facedata {
2545	load_facedata "$DATADIR/facedata"	2837	load_facedata "$DATADIR/facedata"
2546	or die "unable to load facedata\n";	2838	or die "unable to load facedata\n";
2547	}	2839	}
2548		2840
2549	sub reload_archetypes {	2841	sub reload_archetypes {
2550	load_resource_file "$DATADIR/archetypes"	2842	load_resource_file "$DATADIR/archetypes"
2551	or die "unable to load archetypes\n";	2843	or die "unable to load archetypes\n";
		2844	#d# NEED to laod twice to resolve forward references
		2845	# this really needs to be done in an extra post-pass
		2846	# (which needs to be synchronous, so solve it differently)
		2847	load_resource_file "$DATADIR/archetypes"
		2848	or die "unable to load archetypes\n";
2552	}	2849	}
2553		2850
2554	sub reload_treasures {	2851	sub reload_treasures {
2555	load_resource_file "$DATADIR/treasures"	2852	load_resource_file "$DATADIR/treasures"
2556	or die "unable to load treasurelists\n";	2853	or die "unable to load treasurelists\n";
…		…
2559	sub reload_resources {	2856	sub reload_resources {
2560	warn "reloading resource files...\n";	2857	warn "reloading resource files...\n";
2561		2858
2562	reload_regions;	2859	reload_regions;
2563	reload_facedata;	2860	reload_facedata;
		2861	#reload_archetypes;#d#
2564	reload_archetypes;	2862	reload_archetypes;
2565	reload_treasures;	2863	reload_treasures;
2566		2864
2567	warn "finished reloading resource files\n";	2865	warn "finished reloading resource files\n";
2568	}	2866	}
…		…
2625	},	2923	},
2626	);	2924	);
2627	}	2925	}
2628	}	2926	}
2629		2927
		2928	sub write_runtime {
		2929	my $runtime = "$LOCALDIR/runtime";
		2930
		2931	# first touch the runtime file to show we are still running:
		2932	# the fsync below can take a very very long time.
		2933
		2934	IO::AIO::aio_utime $runtime, undef, undef;
		2935
		2936	my $guard = cf::lock_acquire "write_runtime";
		2937
		2938	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644
		2939	or return;
		2940
		2941	my $value = $cf::RUNTIME + 90 + 10;
		2942	# 10 is the runtime save interval, for a monotonic clock
		2943	# 60 allows for the watchdog to kill the server.
		2944
		2945	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2946	and return;
		2947
		2948	# always fsync - this file is important
		2949	aio_fsync $fh
		2950	and return;
		2951
		2952	# touch it again to show we are up-to-date
		2953	aio_utime $fh, undef, undef;
		2954
		2955	close $fh
		2956	or return;
		2957
		2958	aio_rename "$runtime~", $runtime
		2959	and return;
		2960
		2961	warn "runtime file written.\n";
		2962
		2963	1
		2964	}
		2965
2630	sub emergency_save() {	2966	sub emergency_save() {
2631	my $freeze_guard = cf::freeze_mainloop;	2967	my $freeze_guard = cf::freeze_mainloop;
2632		2968
2633	warn "enter emergency perl save\n";	2969	warn "enter emergency perl save\n";
2634		2970
…		…
2709	%EXT_CORO = ();	3045	%EXT_CORO = ();
2710		3046
2711	warn "removing commands";	3047	warn "removing commands";
2712	%COMMAND = ();	3048	%COMMAND = ();
2713		3049
2714	warn "removing ext commands";	3050	warn "removing ext/exti commands";
2715	%EXTCMD = ();	3051	%EXTCMD = ();
		3052	%EXTICMD = ();
2716		3053
2717	warn "unloading/nuking all extensions";	3054	warn "unloading/nuking all extensions";
2718	for my $pkg (@EXTS) {	3055	for my $pkg (@EXTS) {
2719	warn "... unloading $pkg";	3056	warn "... unloading $pkg";
2720		3057

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs. Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC