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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.264 by root, Sun May 6 05:44:48 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3;	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use BDB ();
		26	use Data::Dumper;
		27	use Digest::MD5;
20	use Fcntl;	28	use Fcntl;
21	use IO::AIO 2.31 ();
22	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
23	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
24		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
25	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
26		41
27	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
28	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
29		44
30	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
31		46
32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33		48
34	our %COMMAND = ();	49	our %COMMAND = ();
35	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
36	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
37		56
		57	our $RELOAD; # number of reloads so far
38	our @EVENT;	58	our @EVENT;
39	our $LIBDIR = datadir . "/ext";
40		59
41	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(!)
42	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43	our $NEXT_TICK;	76	our $NEXT_TICK;
44	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
45		82
46	our %CFG;	83	our %CFG;
47		84
48	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
49	our $RUNTIME;	86	our $RUNTIME;
50		87
		88	our %PLAYER; # all users
51	our %MAP; # all maps	89	our %MAP; # all maps
52	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
53	our $FREEZE;	91
		92	# used to convert map paths into valid unix filenames by replacing / by ∕
		93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
54		94
55	binmode STDOUT;	95	binmode STDOUT;
56	binmode STDERR;	96	binmode STDERR;
57		97
58	# read virtual server time, if available	98	# read virtual server time, if available
59	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	99	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
60	open my $fh, "<", cf::localdir . "/runtime"	100	open my $fh, "<", "$LOCALDIR/runtime"
61	or die "unable to read runtime file: $!";	101	or die "unable to read runtime file: $!";
62	$RUNTIME = <$fh> + 0.;	102	$RUNTIME = <$fh> + 0.;
63	}	103	}
64		104
65	mkdir cf::localdir;	105	mkdir $_
66	mkdir cf::localdir . "/" . cf::playerdir;	106	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
67	mkdir cf::localdir . "/" . cf::tmpdir;
68	mkdir cf::localdir . "/" . cf::uniquedir;
69		107
70	our %EXT_CORO;	108	our $EMERGENCY_POSITION;
		109
		110	sub cf::map::normalise;
71		111
72	#############################################################################	112	#############################################################################
73		113
74	=head2 GLOBAL VARIABLES	114	=head2 GLOBAL VARIABLES
75		115
…		…
82	=item $cf::RUNTIME	122	=item $cf::RUNTIME
83		123
84	The time this server has run, starts at 0 and is increased by $cf::TICK on	124	The time this server has run, starts at 0 and is increased by $cf::TICK on
85	every server tick.	125	every server tick.
86		126
87	=item $cf::LIBDIR	127	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		128	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		129	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
88		130
89	The perl library directory, where extensions and cf-specific modules can	131	Various directories - "/etc", read-only install directory, perl-library
90	be found. It will be added to C<@INC> automatically.	132	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		133	unique-items directory, player file directory, random maps directory and
		134	database environment.
91		135
92	=item $cf::NOW	136	=item $cf::NOW
93		137
94	The time of the last (current) server tick.	138	The time of the last (current) server tick.
95		139
…		…
99		143
100	=item %cf::CFG	144	=item %cf::CFG
101		145
102	Configuration for the server, loaded from C</etc/crossfire/config>, or	146	Configuration for the server, loaded from C</etc/crossfire/config>, or
103	from wherever your confdir points to.	147	from wherever your confdir points to.
		148
		149	=item cf::wait_for_tick, cf::wait_for_tick_begin
		150
		151	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		152	returns directly I<after> the tick processing (and consequently, can only wake one process
		153	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
104		154
105	=back	155	=back
106		156
107	=cut	157	=cut
108		158
109	BEGIN {	159	BEGIN {
110	*CORE::GLOBAL::warn = sub {	160	*CORE::GLOBAL::warn = sub {
111	my $msg = join "", @_;	161	my $msg = join "", @_;
112	utf8::encode $msg;
113		162
114	$msg .= "\n"	163	$msg .= "\n"
115	unless $msg =~ /\n$/;	164	unless $msg =~ /\n$/;
116		165
		166	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		167
		168	utf8::encode $msg;
117	LOG llevError, "cfperl: $msg";	169	LOG llevError, $msg;
118	};	170	};
119	}	171	}
120		172
121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
140		192
141	$Event::DIED = sub {	193	$Event::DIED = sub {
142	warn "error in event callback: @_";	194	warn "error in event callback: @_";
143	};	195	};
144		196
145	my %ext_pkg;
146	my @exts;
147	my @hook;
148
149	=head2 UTILITY FUNCTIONS	197	=head2 UTILITY FUNCTIONS
150		198
151	=over 4	199	=over 4
152		200
153	=cut	201	=item dumpval $ref
154		202
		203	=cut
		204
		205	sub dumpval {
		206	eval {
		207	local $SIG{__DIE__};
		208	my $d;
		209	if (1) {
		210	$d = new Data::Dumper([$_[0]], ["*var"]);
		211	$d->Terse(1);
		212	$d->Indent(2);
		213	$d->Quotekeys(0);
		214	$d->Useqq(1);
		215	#$d->Bless(...);
		216	$d->Seen($_[1]) if @_ > 1;
		217	$d = $d->Dump();
		218	}
		219	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		220	$d
		221	} || "[unable to dump $_[0]: '$@']";
		222	}
		223
155	use JSON::Syck (); # TODO# replace by JSON::PC once working	224	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
156		225
157	=item $ref = cf::from_json $json	226	=item $ref = cf::from_json $json
158		227
159	Converts a JSON string into the corresponding perl data structure.	228	Converts a JSON string into the corresponding perl data structure.
160		229
161	=cut
162
163	sub from_json($) {
164	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165	JSON::Syck::Load $_[0]
166	}
167
168	=item $json = cf::to_json $ref	230	=item $json = cf::to_json $ref
169		231
170	Converts a perl data structure into its JSON representation.	232	Converts a perl data structure into its JSON representation.
171		233
172	=cut	234	=item cf::lock_wait $string
173		235
174	sub to_json($) {	236	Wait until the given lock is available. See cf::lock_acquire.
175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
176	JSON::Syck::Dump $_[0]
177	}
178		237
179	# main coro must never ever "block" except in Event	238	=item my $lock = cf::lock_acquire $string
180	# sync_job ensures this by running the job in a coroutine	239
181	# and waiting in Event while the server is otherwise frozen	240	Wait until the given lock is available and then acquires it and returns
		241	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		242	for example when the coroutine gets canceled), the lock is automatically
		243	returned.
		244
		245	Lock names should begin with a unique identifier (for example, cf::map::find
		246	uses map_find and cf::map::load uses map_load).
		247
		248	=item $locked = cf::lock_active $string
		249
		250	Return true if the lock is currently active, i.e. somebody has locked it.
		251
		252	=cut
		253
		254	our %LOCK;
		255
		256	sub lock_wait($) {
		257	my ($key) = @_;
		258
		259	# wait for lock, if any
		260	while ($LOCK{$key}) {
		261	push @{ $LOCK{$key} }, $Coro::current;
		262	Coro::schedule;
		263	}
		264	}
		265
		266	sub lock_acquire($) {
		267	my ($key) = @_;
		268
		269	# wait, to be sure we are not locked
		270	lock_wait $key;
		271
		272	$LOCK{$key} = [];
		273
		274	Coro::guard {
		275	# wake up all waiters, to be on the safe side
		276	$_->ready for @{ delete $LOCK{$key} };
		277	}
		278	}
		279
		280	sub lock_active($) {
		281	my ($key) = @_;
		282
		283	! ! $LOCK{$key}
		284	}
		285
		286	sub freeze_mainloop {
		287	return unless $TICK_WATCHER->is_active;
		288
		289	my $guard = Coro::guard {
		290	$TICK_WATCHER->start;
		291	};
		292	$TICK_WATCHER->stop;
		293	$guard
		294	}
		295
		296	=item cf::async { BLOCK }
		297
		298	Currently the same as Coro::async_pool, meaning you cannot use
		299	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		300	thing you are allowed to do is call C<prio> on it.
		301
		302	=cut
		303
		304	BEGIN { *async = \&Coro::async_pool }
		305
		306	=item cf::sync_job { BLOCK }
		307
		308	The design of crossfire+ requires that the main coro ($Coro::main) is
		309	always able to handle events or runnable, as crossfire+ is only partly
		310	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		311
		312	If it must be done, put the blocking parts into C<sync_job>. This will run
		313	the given BLOCK in another coroutine while waiting for the result. The
		314	server will be frozen during this time, so the block should either finish
		315	fast or be very important.
		316
		317	=cut
		318
182	sub sync_job(&) {	319	sub sync_job(&) {
183	my ($job) = @_;	320	my ($job) = @_;
184		321
185	my $busy = 1;
186	my @res;
187
188	local $FREEZE = 1;
189
190	my $coro = Coro::async {
191	@res = eval { $job->() };
192	warn $@ if $@;
193	undef $busy;
194	};
195
196	if ($Coro::current == $Coro::main) {	322	if ($Coro::current == $Coro::main) {
		323	# this is the main coro, too bad, we have to block
		324	# till the operation succeeds, freezing the server :/
		325
		326	# TODO: use suspend/resume instead
		327	# (but this is cancel-safe)
		328	my $freeze_guard = freeze_mainloop;
		329
		330	my $busy = 1;
		331	my @res;
		332
		333	(async {
		334	@res = eval { $job->() };
		335	warn $@ if $@;
		336	undef $busy;
197	$coro->prio (Coro::PRIO_MAX);	337	})->prio (Coro::PRIO_MAX);
		338
198	while ($busy) {	339	while ($busy) {
199	Coro::cede_notself;	340	Coro::cede or Event::one_event;
200	Event::one_event unless Coro::nready;
201	}	341	}
		342
		343	wantarray ? @res : $res[0]
202	} else {	344	} else {
203	$coro->join;	345	# we are in another coroutine, how wonderful, everything just works
		346
		347	$job->()
204	}	348	}
205
206	wantarray ? @res : $res[0]
207	}	349	}
208		350
209	=item $coro = cf::coro { BLOCK }	351	=item $coro = cf::async_ext { BLOCK }
210		352
211	Creates and returns a new coro. This coro is automcatially being canceled	353	Like async, but this coro is automatically being canceled when the
212	when the extension calling this is being unloaded.	354	extension calling this is being unloaded.
213		355
214	=cut	356	=cut
215		357
216	sub coro(&) {	358	sub async_ext(&) {
217	my $cb = shift;	359	my $cb = shift;
218		360
219	my $coro; $coro = async {	361	my $coro = &Coro::async ($cb);
220	eval {
221	$cb->();
222	};
223	warn $@ if $@;
224	};
225		362
226	$coro->on_destroy (sub {	363	$coro->on_destroy (sub {
227	delete $EXT_CORO{$coro+0};	364	delete $EXT_CORO{$coro+0};
228	});	365	});
229	$EXT_CORO{$coro+0} = $coro;	366	$EXT_CORO{$coro+0} = $coro;
230		367
231	$coro	368	$coro
		369	}
		370
		371	sub write_runtime {
		372	my $runtime = "$LOCALDIR/runtime";
		373
		374	# first touch the runtime file to show we are still running:
		375	# the fsync below can take a very very long time.
		376
		377	warn "touching runtime...\n";#d#
		378	if (my $fh = aio_open $runtime, O_WRONLY, 0) {
		379	utime undef, undef, $fh;
		380	}
		381
		382	my $guard = cf::lock_acquire "write_runtime";
		383
		384	warn "starting to write runtime...\n";#d#
		385	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		386	or return;
		387
		388	my $value = $cf::RUNTIME + 90 + 10;
		389	# 10 is the runtime save interval, for a monotonic clock
		390	# 60 allows for the watchdog to kill the server.
		391
		392	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		393	and return;
		394
		395	# always fsync - this file is important
		396	aio_fsync $fh
		397	and return;
		398
		399	# touch it again to show we are up-to-date
		400	utime undef, undef, $fh;
		401
		402	close $fh
		403	or return;
		404
		405	aio_rename "$runtime~", $runtime
		406	and return;
		407
		408	warn "... done writing runtime.\n";#d#
		409
		410	1
		411	}
		412
		413	=item cf::datalog type => key => value, ...
		414
		415	Log a datalog packet of the given type with the given key-value pairs.
		416
		417	=cut
		418
		419	sub datalog($@) {
		420	my ($type, %kv) = @_;
		421	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
232	}	422	}
233		423
234	=back	424	=back
235		425
236	=cut	426	=cut
…		…
367	our @CB_TYPE = (); # registry for type (cf-object class) based events	557	our @CB_TYPE = (); # registry for type (cf-object class) based events
368	our @CB_MAP = ();	558	our @CB_MAP = ();
369		559
370	my %attachment;	560	my %attachment;
371		561
		562	sub cf::attachable::thawer_merge {
		563	# simply override everything except _meta
		564	local $_[0]{_meta};
		565	%{$_[0]} = %{$_[1]};
		566	}
		567
372	sub _attach_cb($$$$) {	568	sub _attach_cb($$$$) {
373	my ($registry, $event, $prio, $cb) = @_;	569	my ($registry, $event, $prio, $cb) = @_;
374		570
375	use sort 'stable';	571	use sort 'stable';
376		572
…		…
547	# object support	743	# object support
548		744
549	sub reattach {	745	sub reattach {
550	# basically do the same as instantiate, without calling instantiate	746	# basically do the same as instantiate, without calling instantiate
551	my ($obj) = @_;	747	my ($obj) = @_;
		748
		749	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552		750
553	my $registry = $obj->registry;	751	my $registry = $obj->registry;
554		752
555	@$registry = ();	753	@$registry = ();
556		754
…		…
603	$filename, length $$rdata, scalar @$objs;	801	$filename, length $$rdata, scalar @$objs;
604		802
605	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	803	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
606	chmod SAVE_MODE, $fh;	804	chmod SAVE_MODE, $fh;
607	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	805	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
608	aio_fsync $fh;	806	aio_fsync $fh if $cf::USE_FSYNC;
609	close $fh;	807	close $fh;
610		808
611	if (@$objs) {	809	if (@$objs) {
612	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	810	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
613	chmod SAVE_MODE, $fh;	811	chmod SAVE_MODE, $fh;
614	my $data = Storable::nfreeze { version => 1, objs => $objs };	812	my $data = Storable::nfreeze { version => 1, objs => $objs };
615	aio_write $fh, 0, (length $data), $data, 0;	813	aio_write $fh, 0, (length $data), $data, 0;
616	aio_fsync $fh;	814	aio_fsync $fh if $cf::USE_FSYNC;
617	close $fh;	815	close $fh;
618	aio_rename "$filename.pst~", "$filename.pst";	816	aio_rename "$filename.pst~", "$filename.pst";
619	}	817	}
620	} else {	818	} else {
621	aio_unlink "$filename.pst";	819	aio_unlink "$filename.pst";
…		…
649	or return;	847	or return;
650		848
651	unless (aio_stat "$filename.pst") {	849	unless (aio_stat "$filename.pst") {
652	(aio_load "$filename.pst", $av) >= 0	850	(aio_load "$filename.pst", $av) >= 0
653	or return;	851	or return;
654	$av = eval { (Storable::thaw <$av>)->{objs} };	852	$av = eval { (Storable::thaw $av)->{objs} };
655	}	853	}
656		854
		855	warn sprintf "loading %s (%d)\n",
		856	$filename, length $data, scalar @{$av || []};#d#
657	return ($data, $av);	857	return ($data, $av);
658	}	858	}
659		859
660	#############################################################################	860	#############################################################################
661	# command handling &c	861	# command handling &c
…		…
686	=cut	886	=cut
687		887
688	sub register_extcmd {	888	sub register_extcmd {
689	my ($name, $cb) = @_;	889	my ($name, $cb) = @_;
690		890
691	my $caller = caller;
692	#warn "registering extcmd '$name' to '$caller'";
693
694	$EXTCMD{$name} = [$cb, $caller];	891	$EXTCMD{$name} = $cb;
695	}	892	}
696		893
697	cf::player->attach (	894	cf::player->attach (
698	on_command => sub {	895	on_command => sub {
699	my ($pl, $name, $params) = @_;	896	my ($pl, $name, $params) = @_;
…		…
712		909
713	my $msg = eval { from_json $buf };	910	my $msg = eval { from_json $buf };
714		911
715	if (ref $msg) {	912	if (ref $msg) {
716	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	913	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
717	if (my %reply = $cb->[0]->($pl, $msg)) {	914	if (my %reply = $cb->($pl, $msg)) {
718	$pl->ext_reply ($msg->{msgid}, %reply);	915	$pl->ext_reply ($msg->{msgid}, %reply);
719	}	916	}
720	}	917	}
721	} else {	918	} else {
722	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	919	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
724		921
725	cf::override;	922	cf::override;
726	},	923	},
727	);	924	);
728		925
729	sub register {
730	my ($base, $pkg) = @_;
731
732	#TODO
733	}
734
735	sub load_extension {	926	sub load_extension {
736	my ($path) = @_;	927	my ($path) = @_;
737		928
738	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	929	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
739	my $base = $1;	930	my $base = $1;
740	my $pkg = $1;	931	my $pkg = $1;
741	$pkg =~ s/[^[:word:]]/_/g;	932	$pkg =~ s/[^[:word:]]/_/g;
742	$pkg = "ext::$pkg";	933	$pkg = "ext::$pkg";
743		934
744	warn "loading '$path' into '$pkg'\n";	935	warn "... loading '$path' into '$pkg'\n";
745		936
746	open my $fh, "<:utf8", $path	937	open my $fh, "<:utf8", $path
747	or die "$path: $!";	938	or die "$path: $!";
748		939
749	my $source =	940	my $source =
750	"package $pkg; use strict; use utf8;\n"	941	"package $pkg; use strict; use utf8;\n"
751	. "#line 1 \"$path\"\n{\n"	942	. "#line 1 \"$path\"\n{\n"
752	. (do { local $/; <$fh> })	943	. (do { local $/; <$fh> })
753	. "\n};\n1";	944	. "\n};\n1";
754		945
755	eval $source	946	unless (eval $source) {
756	or die $@ ? "$path: $@\n"	947	my $msg = $@ ? "$path: $@\n"
757	: "extension disabled.\n";	948	: "extension disabled.\n";
758		949	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
759	push @exts, $pkg;	950	warn $@;
760	$ext_pkg{$base} = $pkg;	951	warn "mandatory extension failed to load, exiting.\n";
761		952	exit 1;
762	# no strict 'refs';	953	}
763	# @{"$pkg\::ISA"} = ext::;	954	die $@;
764
765	register $base, $pkg;
766	}
767
768	sub unload_extension {
769	my ($pkg) = @_;
770
771	warn "removing extension $pkg\n";
772
773	# remove hooks
774	#TODO
775	# for my $idx (0 .. $#PLUGIN_EVENT) {
776	# delete $hook[$idx]{$pkg};
777	# }	955	}
778		956
779	# remove commands	957	push @EXTS, $pkg;
780	for my $name (keys %COMMAND) {
781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
782
783	if (@cb) {
784	$COMMAND{$name} = \@cb;
785	} else {
786	delete $COMMAND{$name};
787	}
788	}
789
790	# remove extcmds
791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
792	delete $EXTCMD{$name};
793	}
794
795	if (my $cb = $pkg->can ("unload")) {
796	eval {
797	$cb->($pkg);
798	1
799	} or warn "$pkg unloaded, but with errors: $@";
800	}
801
802	Symbol::delete_package $pkg;
803	}	958	}
804		959
805	sub load_extensions {	960	sub load_extensions {
806	for my $ext (<$LIBDIR/*.ext>) {	961	for my $ext (<$LIBDIR/*.ext>) {
807	next unless -r $ext;	962	next unless -r $ext;
…		…
811	} or warn "$ext not loaded: $@";	966	} or warn "$ext not loaded: $@";
812	}	967	}
813	}	968	}
814		969
815	#############################################################################	970	#############################################################################
816	# load/save/clean perl data associated with a map
817		971
818	*cf::mapsupport::on_clean = sub {	972	=head2 CORE EXTENSIONS
		973
		974	Functions and methods that extend core crossfire objects.
		975
		976	=cut
		977
		978	package cf::player;
		979
		980	use Coro::AIO;
		981
		982	=head3 cf::player
		983
		984	=over 4
		985
		986	=item cf::player::find $login
		987
		988	Returns the given player object, loading it if necessary (might block).
		989
		990	=cut
		991
		992	sub playerdir($) {
		993	"$PLAYERDIR/"
		994	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		995	}
		996
		997	sub path($) {
		998	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		999
		1000	(playerdir $login) . "/playerdata"
		1001	}
		1002
		1003	sub find_active($) {
		1004	$cf::PLAYER{$_[0]}
		1005	and $cf::PLAYER{$_[0]}->active
		1006	and $cf::PLAYER{$_[0]}
		1007	}
		1008
		1009	sub exists($) {
		1010	my ($login) = @_;
		1011
		1012	$cf::PLAYER{$login}
		1013	or cf::sync_job { !aio_stat path $login }
		1014	}
		1015
		1016	sub find($) {
		1017	return $cf::PLAYER{$_[0]} || do {
		1018	my $login = $_[0];
		1019
		1020	my $guard = cf::lock_acquire "user_find:$login";
		1021
		1022	$cf::PLAYER{$_[0]} || do {
		1023	# rename old playerfiles to new ones
		1024	#TODO: remove when no longer required
		1025	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1026	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1027	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1028	aio_unlink +(playerdir $login) . "/$login.pl";
		1029
		1030	my $pl = load_pl path $login
		1031	or return;
		1032	$cf::PLAYER{$login} = $pl
		1033	}
		1034	}
		1035	}
		1036
		1037	sub save($) {
		1038	my ($pl) = @_;
		1039
		1040	return if $pl->{deny_save};
		1041
		1042	my $path = path $pl;
		1043	my $guard = cf::lock_acquire "user_save:$path";
		1044
		1045	return if $pl->{deny_save};
		1046
		1047	aio_mkdir playerdir $pl, 0770;
		1048	$pl->{last_save} = $cf::RUNTIME;
		1049
		1050	$pl->save_pl ($path);
		1051	Coro::cede;
		1052	}
		1053
		1054	sub new($) {
		1055	my ($login) = @_;
		1056
		1057	my $self = create;
		1058
		1059	$self->ob->name ($login);
		1060	$self->{deny_save} = 1;
		1061
		1062	$cf::PLAYER{$login} = $self;
		1063
		1064	$self
		1065	}
		1066
		1067	=item $pl->quit_character
		1068
		1069	Nukes the player without looking back. If logged in, the connection will
		1070	be destroyed. May block for a long time.
		1071
		1072	=cut
		1073
		1074	sub quit_character {
		1075	my ($pl) = @_;
		1076
		1077	my $name = $pl->ob->name;
		1078
		1079	$pl->{deny_save} = 1;
		1080	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1081
		1082	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1083	$pl->deactivate;
		1084	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1085	$pl->ns->destroy if $pl->ns;
		1086
		1087	my $path = playerdir $pl;
		1088	my $temp = "$path~$cf::RUNTIME~deleting~";
		1089	aio_rename $path, $temp;
		1090	delete $cf::PLAYER{$pl->ob->name};
		1091	$pl->destroy;
		1092
		1093	my $prefix = qr<^~\Q$name\E/>;
		1094
		1095	# nuke player maps
		1096	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1097
		1098	IO::AIO::aio_rmtree $temp;
		1099	}
		1100
		1101	=item $pl->kick
		1102
		1103	Kicks a player out of the game. This destroys the connection.
		1104
		1105	=cut
		1106
		1107	sub kick {
		1108	my ($pl, $kicker) = @_;
		1109
		1110	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1111	$pl->killer ("kicked");
		1112	$pl->ns->destroy;
		1113	}
		1114
		1115	=item cf::player::list_logins
		1116
		1117	Returns am arrayref of all valid playernames in the system, can take a
		1118	while and may block, so not sync_job-capable, ever.
		1119
		1120	=cut
		1121
		1122	sub list_logins {
		1123	my $dirs = aio_readdir $PLAYERDIR
		1124	or return [];
		1125
		1126	my @logins;
		1127
		1128	for my $login (@$dirs) {
		1129	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1130	aio_read $fh, 0, 512, my $buf, 0 or next;
		1131	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1132
		1133	utf8::decode $login;
		1134	push @logins, $login;
		1135	}
		1136
		1137	\@logins
		1138	}
		1139
		1140	=item $player->maps
		1141
		1142	Returns an arrayref of map paths that are private for this
		1143	player. May block.
		1144
		1145	=cut
		1146
		1147	sub maps($) {
		1148	my ($pl) = @_;
		1149
		1150	$pl = ref $pl ? $pl->ob->name : $pl;
		1151
		1152	my $files = aio_readdir playerdir $pl
		1153	or return;
		1154
		1155	my @paths;
		1156
		1157	for (@$files) {
		1158	utf8::decode $_;
		1159	next if /\.(?:pl|pst)$/;
		1160	next unless /^$PATH_SEP/o;
		1161
		1162	push @paths, cf::map::normalise "~$pl/$_";
		1163	}
		1164
		1165	\@paths
		1166	}
		1167
		1168	=item $player->ext_reply ($msgid, %msg)
		1169
		1170	Sends an ext reply to the player.
		1171
		1172	=cut
		1173
		1174	sub ext_reply($$%) {
		1175	my ($self, $id, %msg) = @_;
		1176
		1177	$msg{msgid} = $id;
		1178
		1179	$self->send ("ext " . cf::to_json \%msg);
		1180	}
		1181
		1182	=item $player->ext_event ($type, %msg)
		1183
		1184	Sends an ext event to the client.
		1185
		1186	=cut
		1187
		1188	sub ext_event($$%) {
		1189	my ($self, $type, %msg) = @_;
		1190
		1191	$self->ns->ext_event ($type, %msg);
		1192	}
		1193
		1194	=head3 cf::region
		1195
		1196	=over 4
		1197
		1198	=cut
		1199
		1200	package cf::region;
		1201
		1202	=item cf::region::find_by_path $path
		1203
		1204	Tries to decuce the probable region for a map knowing only its path.
		1205
		1206	=cut
		1207
		1208	sub find_by_path($) {
		1209	my ($path) = @_;
		1210
		1211	my ($match, $specificity);
		1212
		1213	for my $region (list) {
		1214	if ($region->match && $path =~ $region->match) {
		1215	($match, $specificity) = ($region, $region->specificity)
		1216	if $region->specificity > $specificity;
		1217	}
		1218	}
		1219
		1220	$match
		1221	}
		1222
		1223	=back
		1224
		1225	=head3 cf::map
		1226
		1227	=over 4
		1228
		1229	=cut
		1230
		1231	package cf::map;
		1232
		1233	use Fcntl;
		1234	use Coro::AIO;
		1235
		1236	use overload
		1237	'""' => \&as_string,
		1238	fallback => 1;
		1239
		1240	our $MAX_RESET = 3600;
		1241	our $DEFAULT_RESET = 3000;
		1242
		1243	sub generate_random_map {
		1244	my ($self, $rmp) = @_;
		1245	# mit "rum" bekleckern, nicht
		1246	$self->_create_random_map (
		1247	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1248	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1249	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1250	$rmp->{exit_on_final_map},
		1251	$rmp->{xsize}, $rmp->{ysize},
		1252	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1253	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1254	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1255	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1256	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1257	(cf::region::find $rmp->{region}), $rmp->{custom}
		1258	)
		1259	}
		1260
		1261	=item cf::map->register ($regex, $prio)
		1262
		1263	Register a handler for the map path matching the given regex at the
		1264	givne priority (higher is better, built-in handlers have priority 0, the
		1265	default).
		1266
		1267	=cut
		1268
		1269	sub register {
		1270	my (undef, $regex, $prio) = @_;
		1271	my $pkg = caller;
		1272
		1273	no strict;
		1274	push @{"$pkg\::ISA"}, __PACKAGE__;
		1275
		1276	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1277	}
		1278
		1279	# also paths starting with '/'
		1280	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1281
		1282	sub thawer_merge {
		1283	my ($self, $merge) = @_;
		1284
		1285	# we have to keep some variables in memory intact
		1286	local $self->{path};
		1287	local $self->{load_path};
		1288	local $self->{deny_save};
		1289	local $self->{deny_reset};
		1290
		1291	$self->SUPER::thawer_merge ($merge);
		1292	}
		1293
		1294	sub normalise {
		1295	my ($path, $base) = @_;
		1296
		1297	$path = "$path"; # make sure its a string
		1298
		1299	$path =~ s/\.map$//;
		1300
		1301	# map plan:
		1302	#
		1303	# /! non-realised random map exit (special hack!)
		1304	# {... are special paths that are not being touched
		1305	# ?xxx/... are special absolute paths
		1306	# ?random/... random maps
		1307	# /... normal maps
		1308	# ~user/... per-player map of a specific user
		1309
		1310	$path =~ s/$PATH_SEP/\//go;
		1311
		1312	# treat it as relative path if it starts with
		1313	# something that looks reasonable
		1314	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1315	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1316
		1317	$base =~ s{[^/]+/?$}{};
		1318	$path = "$base/$path";
		1319	}
		1320
		1321	for ($path) {
		1322	redo if s{//}{/};
		1323	redo if s{/\.?/}{/};
		1324	redo if s{/[^/]+/\.\./}{/};
		1325	}
		1326
		1327	$path
		1328	}
		1329
		1330	sub new_from_path {
		1331	my (undef, $path, $base) = @_;
		1332
		1333	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1334
		1335	$path = normalise $path, $base;
		1336
		1337	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1338	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1339	my $self = bless cf::map::new, $pkg;
		1340	$self->{path} = $path; $self->path ($path);
		1341	$self->init; # pass $1 etc.
		1342	return $self;
		1343	}
		1344	}
		1345
		1346	Carp::carp "unable to resolve path '$path' (base '$base').";
		1347	()
		1348	}
		1349
		1350	sub init {
		1351	my ($self) = @_;
		1352
		1353	$self
		1354	}
		1355
		1356	sub as_string {
		1357	my ($self) = @_;
		1358
		1359	"$self->{path}"
		1360	}
		1361
		1362	# the displayed name, this is a one way mapping
		1363	sub visible_name {
		1364	&as_string
		1365	}
		1366
		1367	# the original (read-only) location
		1368	sub load_path {
		1369	my ($self) = @_;
		1370
		1371	"$MAPDIR/$self->{path}.map"
		1372	}
		1373
		1374	# the temporary/swap location
		1375	sub save_path {
		1376	my ($self) = @_;
		1377
		1378	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1379	"$TMPDIR/$path.map"
		1380	}
		1381
		1382	# the unique path, undef == no special unique path
		1383	sub uniq_path {
		1384	my ($self) = @_;
		1385
		1386	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1387	"$UNIQUEDIR/$path"
		1388	}
		1389
		1390	# and all this just because we cannot iterate over
		1391	# all maps in C++...
		1392	sub change_all_map_light {
		1393	my ($change) = @_;
		1394
		1395	$_->change_map_light ($change)
		1396	for grep $_->outdoor, values %cf::MAP;
		1397	}
		1398
		1399	sub unlink_save {
		1400	my ($self) = @_;
		1401
		1402	utf8::encode (my $save = $self->save_path);
		1403	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1404	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1405	}
		1406
		1407	sub load_header_from($) {
		1408	my ($self, $path) = @_;
		1409
		1410	utf8::encode $path;
		1411	#aio_open $path, O_RDONLY, 0
		1412	# or return;
		1413
		1414	$self->_load_header ($path)
		1415	or return;
		1416
		1417	$self->{load_path} = $path;
		1418
		1419	1
		1420	}
		1421
		1422	sub load_header_orig {
		1423	my ($self) = @_;
		1424
		1425	$self->load_header_from ($self->load_path)
		1426	}
		1427
		1428	sub load_header_temp {
		1429	my ($self) = @_;
		1430
		1431	$self->load_header_from ($self->save_path)
		1432	}
		1433
		1434	sub prepare_temp {
		1435	my ($self) = @_;
		1436
		1437	$self->last_access ((delete $self->{last_access})
		1438	|| $cf::RUNTIME); #d#
		1439	# safety
		1440	$self->{instantiate_time} = $cf::RUNTIME
		1441	if $self->{instantiate_time} > $cf::RUNTIME;
		1442	}
		1443
		1444	sub prepare_orig {
		1445	my ($self) = @_;
		1446
		1447	$self->{load_original} = 1;
		1448	$self->{instantiate_time} = $cf::RUNTIME;
		1449	$self->last_access ($cf::RUNTIME);
		1450	$self->instantiate;
		1451	}
		1452
		1453	sub load_header {
		1454	my ($self) = @_;
		1455
		1456	if ($self->load_header_temp) {
		1457	$self->prepare_temp;
		1458	} else {
		1459	$self->load_header_orig
		1460	or return;
		1461	$self->prepare_orig;
		1462	}
		1463
		1464	$self->default_region (cf::region::find_by_path $self->{path})
		1465	unless $self->default_region;
		1466
		1467	1
		1468	}
		1469
		1470	sub find;
		1471	sub find {
		1472	my ($path, $origin) = @_;
		1473
		1474	$path = normalise $path, $origin && $origin->path;
		1475
		1476	cf::lock_wait "map_find:$path";
		1477
		1478	$cf::MAP{$path} || do {
		1479	my $guard = cf::lock_acquire "map_find:$path";
		1480	my $map = new_from_path cf::map $path
		1481	or return;
		1482
		1483	$map->{last_save} = $cf::RUNTIME;
		1484
		1485	$map->load_header
		1486	or return;
		1487
		1488	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1489	# doing this can freeze the server in a sync job, obviously
		1490	#$cf::WAIT_FOR_TICK->wait;
		1491	$map->reset;
		1492	undef $guard;
		1493	return find $path;
		1494	}
		1495
		1496	$cf::MAP{$path} = $map
		1497	}
		1498	}
		1499
		1500	sub pre_load { }
		1501	sub post_load { }
		1502
		1503	sub load {
		1504	my ($self) = @_;
		1505
		1506	local $self->{deny_reset} = 1; # loading can take a long time
		1507
		1508	my $path = $self->{path};
		1509
		1510	{
		1511	my $guard = cf::lock_acquire "map_load:$path";
		1512
		1513	return if $self->in_memory != cf::MAP_SWAPPED;
		1514
		1515	$self->in_memory (cf::MAP_LOADING);
		1516
		1517	$self->alloc;
		1518
		1519	$self->pre_load;
		1520	Coro::cede;
		1521
		1522	$self->_load_objects ($self->{load_path}, 1)
		1523	or return;
		1524
		1525	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1526	if delete $self->{load_original};
		1527
		1528	if (my $uniq = $self->uniq_path) {
		1529	utf8::encode $uniq;
		1530	if (aio_open $uniq, O_RDONLY, 0) {
		1531	$self->clear_unique_items;
		1532	$self->_load_objects ($uniq, 0);
		1533	}
		1534	}
		1535
		1536	Coro::cede;
		1537	# now do the right thing for maps
		1538	$self->link_multipart_objects;
		1539	$self->difficulty ($self->estimate_difficulty)
		1540	unless $self->difficulty;
		1541	Coro::cede;
		1542
		1543	unless ($self->{deny_activate}) {
		1544	$self->decay_objects;
		1545	$self->fix_auto_apply;
		1546	$self->update_buttons;
		1547	Coro::cede;
		1548	$self->set_darkness_map;
		1549	Coro::cede;
		1550	$self->activate;
		1551	}
		1552
		1553	$self->in_memory (cf::MAP_IN_MEMORY);
		1554	}
		1555
		1556	$self->post_load;
		1557	}
		1558
		1559	sub customise_for {
		1560	my ($self, $ob) = @_;
		1561
		1562	return find "~" . $ob->name . "/" . $self->{path}
		1563	if $self->per_player;
		1564
		1565	$self
		1566	}
		1567
		1568	# find and load all maps in the 3x3 area around a map
		1569	sub load_diag {
819	my ($map) = @_;	1570	my ($map) = @_;
820		1571
821	my $path = $map->tmpname;	1572	my @diag; # diagonal neighbours
822	defined $path or return;
823		1573
824	unlink "$path.pst";	1574	for (0 .. 3) {
825	};	1575	my $neigh = $map->tile_path ($_)
		1576	or next;
		1577	$neigh = find $neigh, $map
		1578	or next;
		1579	$neigh->load;
826		1580
827	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1581	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1582	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1583	}
828		1584
829	#############################################################################	1585	for (@diag) {
830	# load/save perl data associated with player->ob objects	1586	my $neigh = find @$_
831		1587	or next;
832	sub all_objects(@) {	1588	$neigh->load;
833	@_, map all_objects ($_->inv), @_	1589	}
834	}	1590	}
835		1591
836	# TODO: compatibility cruft, remove when no longer needed	1592	sub find_sync {
837	cf::player->attach (	1593	my ($path, $origin) = @_;
838	on_load => sub {
839	my ($pl, $path) = @_;
840		1594
841	for my $o (all_objects $pl->ob) {	1595	cf::sync_job { find $path, $origin }
842	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1596	}
843	$o->set_ob_key_value ("_perl_data");
844		1597
845	%$o = %{ Storable::thaw pack "H*", $value };	1598	sub do_load_sync {
		1599	my ($map) = @_;
		1600
		1601	cf::sync_job { $map->load };
		1602	}
		1603
		1604	our %MAP_PREFETCH;
		1605	our $MAP_PREFETCHER = undef;
		1606
		1607	sub find_async {
		1608	my ($path, $origin) = @_;
		1609
		1610	$path = normalise $path, $origin && $origin->{path};
		1611
		1612	if (my $map = $cf::MAP{$path}) {
		1613	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1614	}
		1615
		1616	undef $MAP_PREFETCH{$path};
		1617	$MAP_PREFETCHER ||= cf::async {
		1618	while (%MAP_PREFETCH) {
		1619	for my $path (keys %MAP_PREFETCH) {
		1620	my $map = find $path
		1621	or next;
		1622	$map->load;
		1623
		1624	delete $MAP_PREFETCH{$path};
846	}	1625	}
847	}	1626	}
		1627	undef $MAP_PREFETCHER;
		1628	};
		1629	$MAP_PREFETCHER->prio (6);
		1630
		1631	()
		1632	}
		1633
		1634	sub save {
		1635	my ($self) = @_;
		1636
		1637	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1638
		1639	$self->{last_save} = $cf::RUNTIME;
		1640
		1641	return unless $self->dirty;
		1642
		1643	my $save = $self->save_path; utf8::encode $save;
		1644	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1645
		1646	$self->{load_path} = $save;
		1647
		1648	return if $self->{deny_save};
		1649
		1650	local $self->{last_access} = $self->last_access;#d#
		1651
		1652	cf::async {
		1653	$_->contr->save for $self->players;
		1654	};
		1655
		1656	if ($uniq) {
		1657	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1658	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1659	} else {
		1660	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
848	},	1661	}
849	);	1662	}
850		1663
851	#############################################################################	1664	sub swap_out {
		1665	my ($self) = @_;
852		1666
853	=head2 CORE EXTENSIONS	1667	# save first because save cedes
		1668	$self->save;
854		1669
855	Functions and methods that extend core crossfire objects.	1670	my $lock = cf::lock_acquire "map_data:" . $self->path;
856		1671
857	=head3 cf::player	1672	return if $self->players;
		1673	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1674	return if $self->{deny_save};
		1675
		1676	$self->clear;
		1677	$self->in_memory (cf::MAP_SWAPPED);
		1678	}
		1679
		1680	sub reset_at {
		1681	my ($self) = @_;
		1682
		1683	# TODO: safety, remove and allow resettable per-player maps
		1684	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1685	return 1e99 if $self->{deny_reset};
		1686
		1687	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1688	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1689
		1690	$time + $to
		1691	}
		1692
		1693	sub should_reset {
		1694	my ($self) = @_;
		1695
		1696	$self->reset_at <= $cf::RUNTIME
		1697	}
		1698
		1699	sub reset {
		1700	my ($self) = @_;
		1701
		1702	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1703
		1704	return if $self->players;
		1705	return if $self->isa ("ext::map_per_player");#d#
		1706
		1707	warn "resetting map ", $self->path;#d#
		1708
		1709	$self->in_memory (cf::MAP_SWAPPED);
		1710
		1711	# need to save uniques path
		1712	unless ($self->{deny_save}) {
		1713	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1714
		1715	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1716	if $uniq;
		1717	}
		1718
		1719	delete $cf::MAP{$self->path};
		1720
		1721	$self->clear;
		1722
		1723	$_->clear_links_to ($self) for values %cf::MAP;
		1724
		1725	$self->unlink_save;
		1726	$self->destroy;
		1727	}
		1728
		1729	my $nuke_counter = "aaaa";
		1730
		1731	sub nuke {
		1732	my ($self) = @_;
		1733
		1734	delete $cf::MAP{$self->path};
		1735
		1736	$self->unlink_save;
		1737
		1738	bless $self, "cf::map";
		1739	delete $self->{deny_reset};
		1740	$self->{deny_save} = 1;
		1741	$self->reset_timeout (1);
		1742	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1743
		1744	$cf::MAP{$self->path} = $self;
		1745
		1746	$self->reset; # polite request, might not happen
		1747	}
		1748
		1749	=item cf::map::unique_maps
		1750
		1751	Returns an arrayref of paths of all shared maps that have
		1752	instantiated unique items. May block.
		1753
		1754	=cut
		1755
		1756	sub unique_maps() {
		1757	my $files = aio_readdir $UNIQUEDIR
		1758	or return;
		1759
		1760	my @paths;
		1761
		1762	for (@$files) {
		1763	utf8::decode $_;
		1764	next if /\.pst$/;
		1765	next unless /^$PATH_SEP/o;
		1766
		1767	push @paths, cf::map::normalise $_;
		1768	}
		1769
		1770	\@paths
		1771	}
		1772
		1773	package cf;
		1774
		1775	=back
		1776
		1777	=head3 cf::object
		1778
		1779	=cut
		1780
		1781	package cf::object;
858		1782
859	=over 4	1783	=over 4
860		1784
861	=item cf::player::exists $login	1785	=item $ob->inv_recursive
862		1786
863	Returns true when the given account exists.	1787	Returns the inventory of the object _and_ their inventories, recursively.
864		1788
865	=cut	1789	=cut
866		1790
867	sub cf::player::exists($) {	1791	sub inv_recursive_;
868	cf::player::find $_[0]	1792	sub inv_recursive_ {
869	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1793	map { $_, inv_recursive_ $_->inv } @_
870	}	1794	}
871		1795
872	=item $player->ext_reply ($msgid, $msgtype, %msg)	1796	sub inv_recursive {
873		1797	inv_recursive_ inv $_[0]
874	Sends an ext reply to the player.
875
876	=cut
877
878	sub cf::player::ext_reply($$$%) {
879	my ($self, $id, %msg) = @_;
880
881	$msg{msgid} = $id;
882
883	$self->send ("ext " . to_json \%msg);
884	}	1798	}
		1799
		1800	package cf;
885		1801
886	=back	1802	=back
887		1803
888	=head3 cf::object::player	1804	=head3 cf::object::player
889		1805
…		…
927	(ref $cf::CFG{"may_$access"}	1843	(ref $cf::CFG{"may_$access"}
928	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1844	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929	: $cf::CFG{"may_$access"})	1845	: $cf::CFG{"may_$access"})
930	}	1846	}
931		1847
		1848	=item $player_object->enter_link
		1849
		1850	Freezes the player and moves him/her to a special map (C<{link}>).
		1851
		1852	The player should be reasonably safe there for short amounts of time. You
		1853	I<MUST> call C<leave_link> as soon as possible, though.
		1854
		1855	Will never block.
		1856
		1857	=item $player_object->leave_link ($map, $x, $y)
		1858
		1859	Moves the player out of the special C<{link}> map onto the specified
		1860	map. If the map is not valid (or omitted), the player will be moved back
		1861	to the location he/she was before the call to C<enter_link>, or, if that
		1862	fails, to the emergency map position.
		1863
		1864	Might block.
		1865
		1866	=cut
		1867
		1868	sub link_map {
		1869	unless ($LINK_MAP) {
		1870	$LINK_MAP = cf::map::find "{link}"
		1871	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1872	$LINK_MAP->load;
		1873	}
		1874
		1875	$LINK_MAP
		1876	}
		1877
		1878	sub cf::object::player::enter_link {
		1879	my ($self) = @_;
		1880
		1881	$self->deactivate_recursive;
		1882
		1883	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1884
		1885	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1886	if $self->map;
		1887
		1888	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1889	}
		1890
		1891	sub cf::object::player::leave_link {
		1892	my ($self, $map, $x, $y) = @_;
		1893
		1894	my $link_pos = delete $self->{_link_pos};
		1895
		1896	unless ($map) {
		1897	# restore original map position
		1898	($map, $x, $y) = @{ $link_pos || [] };
		1899	$map = cf::map::find $map;
		1900
		1901	unless ($map) {
		1902	($map, $x, $y) = @$EMERGENCY_POSITION;
		1903	$map = cf::map::find $map
		1904	or die "FATAL: cannot load emergency map\n";
		1905	}
		1906	}
		1907
		1908	($x, $y) = (-1, -1)
		1909	unless (defined $x) && (defined $y);
		1910
		1911	# use -1 or undef as default coordinates, not 0, 0
		1912	($x, $y) = ($map->enter_x, $map->enter_y)
		1913	if $x <=0 && $y <= 0;
		1914
		1915	$map->load;
		1916	$map->load_diag;
		1917
		1918	return unless $self->contr->active;
		1919	$self->activate_recursive;
		1920
		1921	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1922	$self->enter_map ($map, $x, $y);
		1923	}
		1924
		1925	cf::player->attach (
		1926	on_logout => sub {
		1927	my ($pl) = @_;
		1928
		1929	# abort map switching before logout
		1930	if ($pl->ob->{_link_pos}) {
		1931	cf::sync_job {
		1932	$pl->ob->leave_link
		1933	};
		1934	}
		1935	},
		1936	on_login => sub {
		1937	my ($pl) = @_;
		1938
		1939	# try to abort aborted map switching on player login :)
		1940	# should happen only on crashes
		1941	if ($pl->ob->{_link_pos}) {
		1942	$pl->ob->enter_link;
		1943	(async {
		1944	$pl->ob->reply (undef,
		1945	"There was an internal problem at your last logout, "
		1946	. "the server will try to bring you to your intended destination in a second.",
		1947	cf::NDI_RED);
		1948	# we need this sleep as the login has a concurrent enter_exit running
		1949	# and this sleep increases chances of the player not ending up in scorn
		1950	Coro::Timer::sleep 1;
		1951	$pl->ob->leave_link;
		1952	})->prio (2);
		1953	}
		1954	},
		1955	);
		1956
		1957	=item $player_object->goto ($path, $x, $y)
		1958
		1959	=cut
		1960
		1961	sub cf::object::player::goto {
		1962	my ($self, $path, $x, $y) = @_;
		1963
		1964	$self->enter_link;
		1965
		1966	(async {
		1967	my $map = eval {
		1968	my $map = cf::map::find $path;
		1969	$map = $map->customise_for ($self) if $map;
		1970	$map
		1971	} or
		1972	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1973
		1974	$self->leave_link ($map, $x, $y);
		1975	})->prio (1);
		1976	}
		1977
		1978	=item $player_object->enter_exit ($exit_object)
		1979
		1980	=cut
		1981
		1982	sub parse_random_map_params {
		1983	my ($spec) = @_;
		1984
		1985	my $rmp = { # defaults
		1986	xsize => (cf::rndm 15, 40),
		1987	ysize => (cf::rndm 15, 40),
		1988	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1989	#layout => string,
		1990	};
		1991
		1992	for (split /\n/, $spec) {
		1993	my ($k, $v) = split /\s+/, $_, 2;
		1994
		1995	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1996	}
		1997
		1998	$rmp
		1999	}
		2000
		2001	sub prepare_random_map {
		2002	my ($exit) = @_;
		2003
		2004	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2005
		2006	# all this does is basically replace the /! path by
		2007	# a new random map path (?random/...) with a seed
		2008	# that depends on the exit object
		2009
		2010	my $rmp = parse_random_map_params $exit->msg;
		2011
		2012	if ($exit->map) {
		2013	$rmp->{region} = $exit->region->name;
		2014	$rmp->{origin_map} = $exit->map->path;
		2015	$rmp->{origin_x} = $exit->x;
		2016	$rmp->{origin_y} = $exit->y;
		2017	}
		2018
		2019	$rmp->{random_seed} ||= $exit->random_seed;
		2020
		2021	my $data = cf::to_json $rmp;
		2022	my $md5 = Digest::MD5::md5_hex $data;
		2023	my $meta = "$RANDOMDIR/$md5.meta";
		2024
		2025	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2026	aio_write $fh, 0, (length $data), $data, 0;
		2027	undef $fh;
		2028	aio_rename "$meta~", $meta;
		2029
		2030	$exit->slaying ("?random/$md5");
		2031	$exit->msg (undef);
		2032	}
		2033	}
		2034
		2035	sub cf::object::player::enter_exit {
		2036	my ($self, $exit) = @_;
		2037
		2038	return unless $self->type == cf::PLAYER;
		2039
		2040	if ($exit->slaying eq "/!") {
		2041	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2042	# the problem is that $exit might not survive long enough
		2043	# so it needs to be done right now, right here
		2044	cf::sync_job { prepare_random_map $exit };
		2045	}
		2046
		2047	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2048	my $hp = $exit->stats->hp;
		2049	my $sp = $exit->stats->sp;
		2050
		2051	$self->enter_link;
		2052
		2053	(async {
		2054	$self->deactivate_recursive; # just to be sure
		2055	unless (eval {
		2056	$self->goto ($slaying, $hp, $sp);
		2057
		2058	1;
		2059	}) {
		2060	$self->message ("Something went wrong deep within the crossfire server. "
		2061	. "I'll try to bring you back to the map you were before. "
		2062	. "Please report this to the dungeon master!",
		2063	cf::NDI_UNIQUE | cf::NDI_RED);
		2064
		2065	warn "ERROR in enter_exit: $@";
		2066	$self->leave_link;
		2067	}
		2068	})->prio (1);
		2069	}
		2070
932	=head3 cf::client	2071	=head3 cf::client
933		2072
934	=over 4	2073	=over 4
935		2074
936	=item $client->send_drawinfo ($text, $flags)	2075	=item $client->send_drawinfo ($text, $flags)
…		…
942		2081
943	sub cf::client::send_drawinfo {	2082	sub cf::client::send_drawinfo {
944	my ($self, $text, $flags) = @_;	2083	my ($self, $text, $flags) = @_;
945		2084
946	utf8::encode $text;	2085	utf8::encode $text;
947	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2086	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
948	}	2087	}
949		2088
		2089	=item $client->ext_event ($type, %msg)
		2090
		2091	Sends an exti event to the client.
		2092
		2093	=cut
		2094
		2095	sub cf::client::ext_event($$%) {
		2096	my ($self, $type, %msg) = @_;
		2097
		2098	$msg{msgtype} = "event_$type";
		2099	$self->send_packet ("ext " . cf::to_json \%msg);
		2100	}
950		2101
951	=item $success = $client->query ($flags, "text", \&cb)	2102	=item $success = $client->query ($flags, "text", \&cb)
952		2103
953	Queues a query to the client, calling the given callback with	2104	Queues a query to the client, calling the given callback with
954	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2105	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
979	on_reply => sub {	2130	on_reply => sub {
980	my ($ns, $msg) = @_;	2131	my ($ns, $msg) = @_;
981		2132
982	# this weird shuffling is so that direct followup queries	2133	# this weird shuffling is so that direct followup queries
983	# get handled first	2134	# get handled first
984	my $queue = delete $ns->{query_queue};	2135	my $queue = delete $ns->{query_queue}
		2136	or return; # be conservative, not sure how that can happen, but we saw a crash here
985		2137
986	(shift @$queue)->[1]->($msg);	2138	(shift @$queue)->[1]->($msg);
		2139	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
987		2140
988	push @{ $ns->{query_queue} }, @$queue;	2141	push @{ $ns->{query_queue} }, @$queue;
989		2142
990	if (@{ $ns->{query_queue} } == @$queue) {	2143	if (@{ $ns->{query_queue} } == @$queue) {
991	if (@$queue) {	2144	if (@$queue) {
…		…
995	}	2148	}
996	}	2149	}
997	},	2150	},
998	);	2151	);
999		2152
1000	=item $client->coro (\&cb)	2153	=item $client->async (\&cb)
1001		2154
1002	Create a new coroutine, running the specified callback. The coroutine will	2155	Create a new coroutine, running the specified callback. The coroutine will
1003	be automatically cancelled when the client gets destroyed (e.g. on logout,	2156	be automatically cancelled when the client gets destroyed (e.g. on logout,
1004	or loss of connection).	2157	or loss of connection).
1005		2158
1006	=cut	2159	=cut
1007		2160
1008	sub cf::client::coro {	2161	sub cf::client::async {
1009	my ($self, $cb) = @_;	2162	my ($self, $cb) = @_;
1010		2163
1011	my $coro; $coro = async {	2164	my $coro = &Coro::async ($cb);
1012	eval {
1013	$cb->();
1014	};
1015	warn $@ if $@;
1016	};
1017		2165
1018	$coro->on_destroy (sub {	2166	$coro->on_destroy (sub {
1019	delete $self->{_coro}{$coro+0};	2167	delete $self->{_coro}{$coro+0};
1020	});	2168	});
1021		2169
…		…
1054		2202
1055	# here we export the classes and methods available to script code	2203	# here we export the classes and methods available to script code
1056		2204
1057	=pod	2205	=pod
1058		2206
1059	The following fucntions and emthods are available within a safe environment:	2207	The following functions and methods are available within a safe environment:
1060		2208
1061	cf::object contr pay_amount pay_player map	2209	cf::object contr pay_amount pay_player map
1062	cf::object::player player	2210	cf::object::player player
1063	cf::player peaceful	2211	cf::player peaceful
1064	cf::map trigger	2212	cf::map trigger
…		…
1149	#############################################################################	2297	#############################################################################
1150		2298
1151	=head2 EXTENSION DATABASE SUPPORT	2299	=head2 EXTENSION DATABASE SUPPORT
1152		2300
1153	Crossfire maintains a very simple database for extension use. It can	2301	Crossfire maintains a very simple database for extension use. It can
1154	currently store anything that can be serialised using Storable, which	2302	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1155	excludes objects.	2303	convert to/from binary).
1156		2304
1157	The parameter C<$family> should best start with the name of the extension	2305	The parameter C<$family> should best start with the name of the extension
1158	using it, it should be unique.	2306	using it, it should be unique.
1159		2307
1160	=over 4	2308	=over 4
1161		2309
1162	=item $hashref = cf::db_get $family
1163
1164	Return a hashref for use by the extension C<$family>, which can be
1165	modified. After modifications, you have to call C<cf::db_dirty> or
1166	C<cf::db_sync>.
1167
1168	=item $value = cf::db_get $family => $key	2310	=item $value = cf::db_get $family => $key
1169		2311
1170	Returns a single value from the database	2312	Returns a single value from the database.
1171
1172	=item cf::db_put $family => $hashref
1173
1174	Stores the given family hashref into the database. Updates are delayed, if
1175	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1176		2313
1177	=item cf::db_put $family => $key => $value	2314	=item cf::db_put $family => $key => $value
1178		2315
1179	Stores the given C<$value> in the family hash. Updates are delayed, if you	2316	Stores the given C<$value> in the family.
1180	want the data to be synced to disk immediately, use C<cf::db_sync>.
1181
1182	=item cf::db_dirty
1183
1184	Marks the database as dirty, to be updated at a later time.
1185
1186	=item cf::db_sync
1187
1188	Immediately write the database to disk I<if it is dirty>.
1189		2317
1190	=cut	2318	=cut
1191		2319
1192	our $DB;	2320	our $DB;
1193		2321
1194	{	2322	sub db_init {
1195	my $path = cf::localdir . "/database.pst";	2323	unless ($DB) {
		2324	$DB = BDB::db_create $DB_ENV;
1196		2325
1197	sub db_load() {	2326	cf::sync_job {
1198	warn "loading database $path\n";#d# remove later	2327	eval {
1199	$DB = stat $path ? Storable::retrieve $path : { };	2328	$DB->set_flags (BDB::CHKSUM);
1200	}
1201		2329
1202	my $pid;	2330	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1203		2331	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1204	sub db_save() {	2332	cf::cleanup "db_open(db): $!" if $!;
1205	warn "saving database $path\n";#d# remove later	2333	};
1206	waitpid $pid, 0 if $pid;	2334	cf::cleanup "db_open(db): $@" if $@;
1207	if (0 == ($pid = fork)) {
1208	$DB->{_meta}{version} = 1;
1209	Storable::nstore $DB, "$path~";
1210	rename "$path~", $path;
1211	cf::_exit 0 if defined $pid;
1212	}	2335	};
1213	}
1214
1215	my $dirty;
1216
1217	sub db_sync() {
1218	db_save if $dirty;
1219	undef $dirty;
1220	}
1221
1222	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1223	db_sync;
1224	});	2336	}
		2337	}
1225		2338
1226	sub db_dirty() {
1227	$dirty = 1;
1228	$idle->start;
1229	}
1230
1231	sub db_get($;$) {	2339	sub db_get($$) {
1232	@_ >= 2	2340	my $key = "$_[0]/$_[1]";
1233	? $DB->{$_[0]}{$_[1]}
1234	: ($DB->{$_[0]} ||= { })
1235	}
1236		2341
		2342	cf::sync_job {
		2343	BDB::db_get $DB, undef, $key, my $data;
		2344
		2345	$! ? ()
		2346	: $data
		2347	}
		2348	}
		2349
1237	sub db_put($$;$) {	2350	sub db_put($$$) {
1238	if (@_ >= 3) {	2351	BDB::dbreq_pri 4;
1239	$DB->{$_[0]}{$_[1]} = $_[2];	2352	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1240	} else {	2353	}
1241	$DB->{$_[0]} = $_[1];
1242	}
1243	db_dirty;
1244	}
1245		2354
1246	cf::global->attach (	2355	=item cf::cache $id => [$paths...], $processversion => $process
1247	prio => 10000,	2356
1248	on_cleanup => sub {	2357	Generic caching function that returns the value of the resource $id,
1249	db_sync;	2358	caching and regenerating as required.
		2359
		2360	This function can block.
		2361
		2362	=cut
		2363
		2364	sub cache {
		2365	my ($id, $src, $processversion, $process) = @_;
		2366
		2367	my $meta =
		2368	join "\x00",
		2369	$processversion,
		2370	map {
		2371	aio_stat $_
		2372	and Carp::croak "$_: $!";
		2373
		2374	($_, (stat _)[7,9])
		2375	} @$src;
		2376
		2377	my $dbmeta = db_get cache => "$id/meta";
		2378	if ($dbmeta ne $meta) {
		2379	# changed, we may need to process
		2380
		2381	my @data;
		2382	my $md5;
		2383
		2384	for (0 .. $#$src) {
		2385	0 <= aio_load $src->[$_], $data[$_]
		2386	or Carp::croak "$src->[$_]: $!";
1250	},	2387	}
1251	);	2388
		2389	# if processing is expensive, check
		2390	# checksum first
		2391	if (1) {
		2392	$md5 =
		2393	join "\x00",
		2394	$processversion,
		2395	map {
		2396	Coro::cede;
		2397	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2398	} 0.. $#$src;
		2399
		2400
		2401	my $dbmd5 = db_get cache => "$id/md5";
		2402	if ($dbmd5 eq $md5) {
		2403	db_put cache => "$id/meta", $meta;
		2404
		2405	return db_get cache => "$id/data";
		2406	}
		2407	}
		2408
		2409	my $t1 = Time::HiRes::time;
		2410	my $data = $process->(\@data);
		2411	my $t2 = Time::HiRes::time;
		2412
		2413	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2414
		2415	db_put cache => "$id/data", $data;
		2416	db_put cache => "$id/md5" , $md5;
		2417	db_put cache => "$id/meta", $meta;
		2418
		2419	return $data;
		2420	}
		2421
		2422	db_get cache => "$id/data"
1252	}	2423	}
		2424
		2425	=item fork_call { }, $args
		2426
		2427	Executes the given code block with the given arguments in a seperate
		2428	process, returning the results. Everything must be serialisable with
		2429	Coro::Storable. May, of course, block. Note that the executed sub may
		2430	never block itself or use any form of Event handling.
		2431
		2432	=cut
		2433
		2434	sub fork_call(&@) {
		2435	my ($cb, @args) = @_;
		2436
		2437	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2438	# or die "socketpair: $!";
		2439	pipe my $fh1, my $fh2
		2440	or die "pipe: $!";
		2441
		2442	if (my $pid = fork) {
		2443	close $fh2;
		2444
		2445	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2446	$res = Coro::Storable::thaw $res;
		2447
		2448	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2449
		2450	die $$res unless "ARRAY" eq ref $res;
		2451
		2452	return wantarray ? @$res : $res->[-1];
		2453	} else {
		2454	reset_signals;
		2455	local $SIG{__WARN__};
		2456	local $SIG{__DIE__};
		2457	eval {
		2458	close $fh1;
		2459
		2460	my @res = eval { $cb->(@args) };
		2461	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2462	};
		2463
		2464	warn $@ if $@;
		2465	_exit 0;
		2466	}
		2467	}
		2468
		2469
1253		2470
1254	#############################################################################	2471	#############################################################################
1255	# the server's main()	2472	# the server's init and main functions
		2473
		2474	sub load_facedata($) {
		2475	my ($path) = @_;
		2476
		2477	warn "loading facedata from $path\n";
		2478
		2479	my $facedata;
		2480	0 < aio_load $path, $facedata
		2481	or die "$path: $!";
		2482
		2483	$facedata = Coro::Storable::thaw $facedata;
		2484
		2485	$facedata->{version} == 2
		2486	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2487
		2488	{
		2489	my $faces = $facedata->{faceinfo};
		2490
		2491	while (my ($face, $info) = each %$faces) {
		2492	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2493	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2494	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2495	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2496	Coro::cede;
		2497	}
		2498
		2499	while (my ($face, $info) = each %$faces) {
		2500	next unless $info->{smooth};
		2501	my $idx = cf::face::find $face
		2502	or next;
		2503	if (my $smooth = cf::face::find $info->{smooth}) {
		2504	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2505	} else {
		2506	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2507	}
		2508	Coro::cede;
		2509	}
		2510	}
		2511
		2512	{
		2513	my $anims = $facedata->{animinfo};
		2514
		2515	while (my ($anim, $info) = each %$anims) {
		2516	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2517	Coro::cede;
		2518	}
		2519
		2520	cf::anim::invalidate_all; # d'oh
		2521	}
		2522
		2523	1
		2524	}
		2525
		2526	sub reload_regions {
		2527	load_resource_file "$MAPDIR/regions"
		2528	or die "unable to load regions file\n";
		2529	}
		2530
		2531	sub reload_facedata {
		2532	load_facedata "$DATADIR/facedata"
		2533	or die "unable to load facedata\n";
		2534	}
		2535
		2536	sub reload_archetypes {
		2537	load_resource_file "$DATADIR/archetypes"
		2538	or die "unable to load archetypes\n";
		2539	}
		2540
		2541	sub reload_treasures {
		2542	load_resource_file "$DATADIR/treasures"
		2543	or die "unable to load treasurelists\n";
		2544	}
		2545
		2546	sub reload_resources {
		2547	warn "reloading resource files...\n";
		2548
		2549	reload_regions;
		2550	reload_facedata;
		2551	reload_archetypes;
		2552	reload_treasures;
		2553
		2554	warn "finished reloading resource files\n";
		2555	}
		2556
		2557	sub init {
		2558	reload_resources;
		2559	}
1256		2560
1257	sub cfg_load {	2561	sub cfg_load {
1258	open my $fh, "<:utf8", cf::confdir . "/config"	2562	open my $fh, "<:utf8", "$CONFDIR/config"
1259	or return;	2563	or return;
1260		2564
1261	local $/;	2565	local $/;
1262	*CFG = YAML::Syck::Load <$fh>;	2566	*CFG = YAML::Syck::Load <$fh>;
		2567
		2568	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2569
		2570	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2571	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2572
		2573	if (exists $CFG{mlockall}) {
		2574	eval {
		2575	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2576	and die "WARNING: m(un)lockall failed: $!\n";
		2577	};
		2578	warn $@ if $@;
		2579	}
1263	}	2580	}
1264		2581
1265	sub main {	2582	sub main {
		2583	# we must not ever block the main coroutine
		2584	local $Coro::idle = sub {
		2585	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2586	(async {
		2587	Event::one_event;
		2588	})->prio (Coro::PRIO_MAX);
		2589	};
		2590
1266	cfg_load;	2591	cfg_load;
1267	db_load;	2592	db_init;
1268	load_extensions;	2593	load_extensions;
		2594
		2595	$TICK_WATCHER->start;
1269	Event::loop;	2596	Event::loop;
1270	}	2597	}
1271		2598
1272	#############################################################################	2599	#############################################################################
1273	# initialisation	2600	# initialisation and cleanup
1274		2601
1275	sub _perl_reload() {	2602	# install some emergency cleanup handlers
		2603	BEGIN {
		2604	for my $signal (qw(INT HUP TERM)) {
		2605	Event->signal (
		2606	reentrant => 0,
		2607	data => WF_AUTOCANCEL,
		2608	signal => $signal,
		2609	prio => 0,
		2610	cb => sub {
		2611	cf::cleanup "SIG$signal";
		2612	},
		2613	);
		2614	}
		2615	}
		2616
		2617	sub emergency_save() {
		2618	my $freeze_guard = cf::freeze_mainloop;
		2619
		2620	warn "enter emergency perl save\n";
		2621
		2622	cf::sync_job {
		2623	# use a peculiar iteration method to avoid tripping on perl
		2624	# refcount bugs in for. also avoids problems with players
		2625	# and maps saved/destroyed asynchronously.
		2626	warn "begin emergency player save\n";
		2627	for my $login (keys %cf::PLAYER) {
		2628	my $pl = $cf::PLAYER{$login} or next;
		2629	$pl->valid or next;
		2630	$pl->save;
		2631	}
		2632	warn "end emergency player save\n";
		2633
		2634	warn "begin emergency map save\n";
		2635	for my $path (keys %cf::MAP) {
		2636	my $map = $cf::MAP{$path} or next;
		2637	$map->valid or next;
		2638	$map->save;
		2639	}
		2640	warn "end emergency map save\n";
		2641
		2642	warn "begin emergency database checkpoint\n";
		2643	BDB::db_env_txn_checkpoint $DB_ENV;
		2644	warn "end emergency database checkpoint\n";
		2645	};
		2646
		2647	warn "leave emergency perl save\n";
		2648	}
		2649
		2650	sub post_cleanup {
		2651	my ($make_core) = @_;
		2652
		2653	warn Carp::longmess "post_cleanup backtrace"
		2654	if $make_core;
		2655	}
		2656
		2657	sub do_reload_perl() {
		2658	# can/must only be called in main
		2659	if ($Coro::current != $Coro::main) {
		2660	warn "can only reload from main coroutine";
		2661	return;
		2662	}
		2663
1276	warn "reloading...";	2664	warn "reloading...";
1277		2665
1278	eval {	2666	warn "entering sync_job";
1279	local $FREEZE = 1;
1280		2667
		2668	cf::sync_job {
		2669	cf::write_runtime; # external watchdog should not bark
1281	cf::emergency_save;	2670	cf::emergency_save;
		2671	cf::write_runtime; # external watchdog should not bark
1282		2672
1283	# cancel all watchers	2673	warn "syncing database to disk";
		2674	BDB::db_env_txn_checkpoint $DB_ENV;
		2675
		2676	# if anything goes wrong in here, we should simply crash as we already saved
		2677
		2678	warn "cancelling all WF_AUTOCANCEL watchers";
1284	for (Event::all_watchers) {	2679	for (Event::all_watchers) {
1285	$_->cancel if $_->data & WF_AUTOCANCEL;	2680	$_->cancel if $_->data & WF_AUTOCANCEL;
1286	}	2681	}
1287		2682
		2683	warn "flushing outstanding aio requests";
		2684	for (;;) {
		2685	BDB::flush;
		2686	IO::AIO::flush;
		2687	Coro::cede;
		2688	last unless IO::AIO::nreqs || BDB::nreqs;
		2689	warn "iterate...";
		2690	}
		2691
		2692	++$RELOAD;
		2693
1288	# cancel all extension coros	2694	warn "cancelling all extension coros";
1289	$_->cancel for values %EXT_CORO;	2695	$_->cancel for values %EXT_CORO;
1290	%EXT_CORO = ();	2696	%EXT_CORO = ();
1291		2697
1292	# unload all extensions	2698	warn "removing commands";
1293	for (@exts) {	2699	%COMMAND = ();
		2700
		2701	warn "removing ext commands";
		2702	%EXTCMD = ();
		2703
		2704	warn "unloading/nuking all extensions";
		2705	for my $pkg (@EXTS) {
1294	warn "unloading <$_>";	2706	warn "... unloading $pkg";
1295	unload_extension $_;	2707
		2708	if (my $cb = $pkg->can ("unload")) {
		2709	eval {
		2710	$cb->($pkg);
		2711	1
		2712	} or warn "$pkg unloaded, but with errors: $@";
1296	}	2713	}
1297		2714
		2715	warn "... nuking $pkg";
		2716	Symbol::delete_package $pkg;
		2717	}
		2718
1298	# unload all modules loaded from $LIBDIR	2719	warn "unloading all perl modules loaded from $LIBDIR";
1299	while (my ($k, $v) = each %INC) {	2720	while (my ($k, $v) = each %INC) {
1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2721	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301		2722
1302	warn "removing <$k>";	2723	warn "... unloading $k";
1303	delete $INC{$k};	2724	delete $INC{$k};
1304		2725
1305	$k =~ s/\.pm$//;	2726	$k =~ s/\.pm$//;
1306	$k =~ s/\//::/g;	2727	$k =~ s/\//::/g;
1307		2728
…		…
1310	}	2731	}
1311		2732
1312	Symbol::delete_package $k;	2733	Symbol::delete_package $k;
1313	}	2734	}
1314		2735
1315	# sync database to disk
1316	cf::db_sync;
1317	IO::AIO::flush;
1318
1319	# get rid of safe::, as good as possible	2736	warn "getting rid of safe::, as good as possible";
1320	Symbol::delete_package "safe::$_"	2737	Symbol::delete_package "safe::$_"
1321	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2738	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322		2739
1323	# remove register_script_function callbacks
1324	# TODO
1325
1326	# unload cf.pm "a bit"	2740	warn "unloading cf.pm \"a bit\"";
1327	delete $INC{"cf.pm"};	2741	delete $INC{"cf.pm"};
		2742	delete $INC{"cf/pod.pm"};
1328		2743
1329	# don't, removes xs symbols, too,	2744	# don't, removes xs symbols, too,
1330	# and global variables created in xs	2745	# and global variables created in xs
1331	#Symbol::delete_package __PACKAGE__;	2746	#Symbol::delete_package __PACKAGE__;
1332		2747
1333	# reload cf.pm	2748	warn "unload completed, starting to reload now";
		2749
1334	warn "reloading cf.pm";	2750	warn "reloading cf.pm";
1335	require cf;	2751	require cf;
1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2752	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337		2753
1338	# load config and database again	2754	warn "loading config and database again";
1339	cf::cfg_load;	2755	cf::cfg_load;
1340	cf::db_load;
1341		2756
1342	# load extensions
1343	warn "load extensions";	2757	warn "loading extensions";
1344	cf::load_extensions;	2758	cf::load_extensions;
1345		2759
1346	# reattach attachments to objects	2760	warn "reattaching attachments to objects/players";
1347	warn "reattach";	2761	_global_reattach; # objects, sockets
1348	_global_reattach;	2762	warn "reattaching attachments to maps";
		2763	reattach $_ for values %MAP;
		2764	warn "reattaching attachments to players";
		2765	reattach $_ for values %PLAYER;
		2766
		2767	warn "leaving sync_job";
		2768
		2769	1
		2770	} or do {
		2771	warn $@;
		2772	warn "error while reloading, exiting.";
		2773	exit 1;
1349	};	2774	};
1350	warn $@ if $@;
1351		2775
1352	warn "reloaded";	2776	warn "reloaded";
1353	};	2777	};
1354		2778
1355	sub perl_reload() {	2779	our $RELOAD_WATCHER; # used only during reload
1356	_perl_reload;
1357	}
1358		2780
1359	register "<global>", __PACKAGE__;	2781	sub reload_perl() {
		2782	# doing reload synchronously and two reloads happen back-to-back,
		2783	# coro crashes during coro_state_free->destroy here.
1360		2784
		2785	$RELOAD_WATCHER ||= Event->timer (
		2786	reentrant => 0,
		2787	after => 0,
		2788	data => WF_AUTOCANCEL,
		2789	cb => sub {
		2790	do_reload_perl;
		2791	undef $RELOAD_WATCHER;
		2792	},
		2793	);
		2794	}
		2795
1361	register_command "perl-reload" => sub {	2796	register_command "reload" => sub {
1362	my ($who, $arg) = @_;	2797	my ($who, $arg) = @_;
1363		2798
1364	if ($who->flag (FLAG_WIZ)) {	2799	if ($who->flag (FLAG_WIZ)) {
1365	$who->message ("reloading...");	2800	$who->message ("reloading server.");
1366	_perl_reload;	2801	async { reload_perl };
1367	}	2802	}
1368	};	2803	};
1369		2804
1370	unshift @INC, $LIBDIR;	2805	unshift @INC, $LIBDIR;
		2806
		2807	my $bug_warning = 0;
		2808
		2809	our @WAIT_FOR_TICK;
		2810	our @WAIT_FOR_TICK_BEGIN;
		2811
		2812	sub wait_for_tick {
		2813	return unless $TICK_WATCHER->is_active;
		2814	return if $Coro::current == $Coro::main;
		2815
		2816	my $signal = new Coro::Signal;
		2817	push @WAIT_FOR_TICK, $signal;
		2818	$signal->wait;
		2819	}
		2820
		2821	sub wait_for_tick_begin {
		2822	return unless $TICK_WATCHER->is_active;
		2823	return if $Coro::current == $Coro::main;
		2824
		2825	my $signal = new Coro::Signal;
		2826	push @WAIT_FOR_TICK_BEGIN, $signal;
		2827	$signal->wait;
		2828	}
1371		2829
1372	$TICK_WATCHER = Event->timer (	2830	$TICK_WATCHER = Event->timer (
1373	reentrant => 0,	2831	reentrant => 0,
		2832	parked => 1,
1374	prio => 0,	2833	prio => 0,
1375	at => $NEXT_TICK || $TICK,	2834	at => $NEXT_TICK || $TICK,
1376	data => WF_AUTOCANCEL,	2835	data => WF_AUTOCANCEL,
1377	cb => sub {	2836	cb => sub {
1378	unless ($FREEZE) {	2837	if ($Coro::current != $Coro::main) {
		2838	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2839	unless ++$bug_warning > 10;
		2840	return;
		2841	}
		2842
		2843	$NOW = Event::time;
		2844
1379	cf::server_tick; # one server iteration	2845	cf::server_tick; # one server iteration
		2846
1380	$RUNTIME += $TICK;	2847	$RUNTIME += $TICK;
1381	}
1382
1383	$NEXT_TICK += $TICK;	2848	$NEXT_TICK += $TICK;
		2849
		2850	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2851	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2852	Coro::async_pool {
		2853	write_runtime
		2854	or warn "ERROR: unable to write runtime file: $!";
		2855	};
		2856	}
		2857
		2858	# my $AFTER = Event::time;
		2859	# warn $AFTER - $NOW;#d#
1384		2860
1385	# if we are delayed by four ticks or more, skip them all	2861	# if we are delayed by four ticks or more, skip them all
1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2862	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387		2863
1388	$TICK_WATCHER->at ($NEXT_TICK);	2864	$TICK_WATCHER->at ($NEXT_TICK);
1389	$TICK_WATCHER->start;	2865	$TICK_WATCHER->start;
		2866
		2867	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2868	$sig->send;
		2869	}
		2870	while (my $sig = shift @WAIT_FOR_TICK) {
		2871	$sig->send;
		2872	}
		2873
		2874	_post_tick;
1390	},	2875	},
1391	);	2876	);
1392		2877
		2878	{
		2879	BDB::max_poll_time $TICK * 0.1;
		2880	$BDB_POLL_WATCHER = Event->io (
		2881	reentrant => 0,
		2882	fd => BDB::poll_fileno,
		2883	poll => 'r',
		2884	prio => 0,
		2885	data => WF_AUTOCANCEL,
		2886	cb => \&BDB::poll_cb,
		2887	);
		2888	BDB::min_parallel 8;
		2889
		2890	BDB::set_sync_prepare {
		2891	my $status;
		2892	my $current = $Coro::current;
		2893	(
		2894	sub {
		2895	$status = $!;
		2896	$current->ready; undef $current;
		2897	},
		2898	sub {
		2899	Coro::schedule while defined $current;
		2900	$! = $status;
		2901	},
		2902	)
		2903	};
		2904
		2905	unless ($DB_ENV) {
		2906	$DB_ENV = BDB::db_env_create;
		2907
		2908	cf::sync_job {
		2909	eval {
		2910	BDB::db_env_open
		2911	$DB_ENV,
		2912	$BDBDIR,
		2913	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2914	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2915	0666;
		2916
		2917	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		2918
		2919	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2920	$DB_ENV->set_lk_detect;
		2921	};
		2922
		2923	cf::cleanup "db_env_open(db): $@" if $@;
		2924	};
		2925	}
		2926	}
		2927
		2928	{
		2929	IO::AIO::min_parallel 8;
		2930
		2931	undef $Coro::AIO::WATCHER;
1393	IO::AIO::max_poll_time $TICK * 0.2;	2932	IO::AIO::max_poll_time $TICK * 0.1;
1394		2933	$AIO_POLL_WATCHER = Event->io (
1395	Event->io (fd => IO::AIO::poll_fileno,	2934	reentrant => 0,
1396	poll => 'r',
1397	prio => 5,
1398	data => WF_AUTOCANCEL,	2935	data => WF_AUTOCANCEL,
		2936	fd => IO::AIO::poll_fileno,
		2937	poll => 'r',
		2938	prio => 6,
1399	cb => \&IO::AIO::poll_cb);	2939	cb => \&IO::AIO::poll_cb,
		2940	);
		2941	}
1400		2942
1401	# we must not ever block the main coroutine	2943	my $_log_backtrace;
1402	$Coro::idle = sub {	2944
1403	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2945	sub _log_backtrace {
1404	warn "FATAL: Coro::idle was called, major BUG\n";	2946	my ($msg, @addr) = @_;
1405	(Coro::unblock_sub {	2947
1406	Event::one_event;	2948	$msg =~ s/\n//;
1407	})->();	2949
1408	};	2950	# limit the # of concurrent backtraces
		2951	if ($_log_backtrace < 2) {
		2952	++$_log_backtrace;
		2953	async {
		2954	my @bt = fork_call {
		2955	@addr = map { sprintf "%x", $_ } @addr;
		2956	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		2957	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		2958	or die "addr2line: $!";
		2959
		2960	my @funcs;
		2961	my @res = <$fh>;
		2962	chomp for @res;
		2963	while (@res) {
		2964	my ($func, $line) = splice @res, 0, 2, ();
		2965	push @funcs, "[$func] $line";
		2966	}
		2967
		2968	@funcs
		2969	};
		2970
		2971	LOG llevInfo, "[ABT] $msg\n";
		2972	LOG llevInfo, "[ABT] $_\n" for @bt;
		2973	--$_log_backtrace;
		2974	};
		2975	} else {
		2976	LOG llevInfo, "[ABT] $msg\n";
		2977	LOG llevInfo, "[ABT] [suppressed]\n";
		2978	}
		2979	}
		2980
		2981	# load additional modules
		2982	use cf::pod;
		2983
		2984	END { cf::emergency_save }
1409		2985
1410	1	2986	1
1411		2987

Diff Legend

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