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

Diff Legend

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