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

Diff Legend

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