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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.228 by root, Mon Mar 26 16:53:33 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
		9	use Event;
6	use Opcode;	10	use Opcode;
7	use Safe;	11	use Safe;
8	use Safe::Hole;	12	use Safe::Hole;
9		13
10	use IO::AIO ();	14	use Coro 3.52 ();
		15	use Coro::State;
		16	use Coro::Event;
		17	use Coro::Timer;
		18	use Coro::Signal;
		19	use Coro::Semaphore;
		20	use Coro::AIO;
		21
		22	use BDB ();
		23	use Data::Dumper;
		24	use Digest::MD5;
		25	use Fcntl;
11	use YAML::Syck ();	26	use YAML::Syck ();
		27	use IO::AIO 2.32 ();
12	use Time::HiRes;	28	use Time::HiRes;
13	use Event;	29	use Compress::LZF;
		30
		31	# configure various modules to our taste
		32	#
		33	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		34	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		35
14	$Event::Eval = 1; # no idea why this is required, but it is	36	$Event::Eval = 1; # no idea why this is required, but it is
15		37
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	38	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	39	$YAML::Syck::ImplicitUnicode = 1;
18		40
19	use strict;	41	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		42
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	43	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		44
23	our %COMMAND = ();	45	our %COMMAND = ();
24	our %COMMAND_TIME = ();	46	our %COMMAND_TIME = ();
		47
		48	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	49	our %EXTCMD = ();
		50	our %EXT_CORO = (); # coroutines bound to extensions
		51	our %EXT_MAP = (); # pluggable maps
26		52
27	_init_vars;	53	our $RELOAD; # number of reloads so far
28
29	our @EVENT;	54	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	55	our $LIBDIR = datadir . "/ext";
31		56
32	our $TICK = MAX_TIME * 1e-6;	57	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	58	our $TICK_WATCHER;
		59	our $AIO_POLL_WATCHER;
		60	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34	our $NEXT_TICK;	61	our $NEXT_TICK;
		62	our $NOW;
		63	our $USE_FSYNC = 1; # use fsync to write maps - default off
		64
		65	our $BDB_POLL_WATCHER;
		66	our $DB_ENV;
35		67
36	our %CFG;	68	our %CFG;
37		69
38	our $UPTIME; $UPTIME ||= time;	70	our $UPTIME; $UPTIME ||= time;
		71	our $RUNTIME;
		72
		73	our %PLAYER; # all users
		74	our %MAP; # all maps
		75	our $LINK_MAP; # the special {link} map, which is always available
		76	our $RANDOM_MAPS = cf::localdir . "/random";
		77	our $BDB_ENV_DIR = cf::localdir . "/db";
		78
		79	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		80	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		81
		82	# used to convert map paths into valid unix filenames by replacing / by ∕
		83	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		84
		85	binmode STDOUT;
		86	binmode STDERR;
		87
		88	# read virtual server time, if available
		89	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		90	open my $fh, "<", cf::localdir . "/runtime"
		91	or die "unable to read runtime file: $!";
		92	$RUNTIME = <$fh> + 0.;
		93	}
		94
		95	mkdir cf::localdir;
		96	mkdir cf::localdir . "/" . cf::playerdir;
		97	mkdir cf::localdir . "/" . cf::tmpdir;
		98	mkdir cf::localdir . "/" . cf::uniquedir;
		99	mkdir $RANDOM_MAPS;
		100	mkdir $BDB_ENV_DIR;
		101
		102	our $EMERGENCY_POSITION;
		103
		104	sub cf::map::normalise;
39		105
40	#############################################################################	106	#############################################################################
41		107
42	=head2 GLOBAL VARIABLES	108	=head2 GLOBAL VARIABLES
43		109
44	=over 4	110	=over 4
45		111
46	=item $cf::UPTIME	112	=item $cf::UPTIME
47		113
48	The timestamp of the server start (so not actually an uptime).	114	The timestamp of the server start (so not actually an uptime).
		115
		116	=item $cf::RUNTIME
		117
		118	The time this server has run, starts at 0 and is increased by $cf::TICK on
		119	every server tick.
49		120
50	=item $cf::LIBDIR	121	=item $cf::LIBDIR
51		122
52	The perl library directory, where extensions and cf-specific modules can	123	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	124	be found. It will be added to C<@INC> automatically.
54		125
		126	=item $cf::NOW
		127
		128	The time of the last (current) server tick.
		129
55	=item $cf::TICK	130	=item $cf::TICK
56		131
57	The interval between server ticks, in seconds.	132	The interval between server ticks, in seconds.
58		133
59	=item %cf::CFG	134	=item %cf::CFG
60		135
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	136	Configuration for the server, loaded from C</etc/crossfire/config>, or
62	from wherever your confdir points to.	137	from wherever your confdir points to.
		138
		139	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		140
		141	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		142	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		143	processing has been done. Call C<< ->wait >> on them to maximise the
		144	window of cpu time available, or simply to synchronise to the server tick.
63		145
64	=back	146	=back
65		147
66	=cut	148	=cut
67		149
68	BEGIN {	150	BEGIN {
69	*CORE::GLOBAL::warn = sub {	151	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	152	my $msg = join "", @_;
		153	utf8::encode $msg;
		154
71	$msg .= "\n"	155	$msg .= "\n"
72	unless $msg =~ /\n$/;	156	unless $msg =~ /\n$/;
73		157
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	158	LOG llevError, $msg;
76	};	159	};
77	}	160	}
78		161
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	162	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	163	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	167	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		168
86	# we bless all objects into (empty) derived classes to force a method lookup	169	# we bless all objects into (empty) derived classes to force a method lookup
87	# within the Safe compartment.	170	# within the Safe compartment.
88	for my $pkg (qw(	171	for my $pkg (qw(
89	cf::global	172	cf::global cf::attachable
90	cf::object cf::object::player	173	cf::object cf::object::player
91	cf::client cf::player	174	cf::client cf::player
92	cf::arch cf::living	175	cf::arch cf::living
93	cf::map cf::party cf::region	176	cf::map cf::party cf::region
94	)) {	177	)) {
…		…
98		181
99	$Event::DIED = sub {	182	$Event::DIED = sub {
100	warn "error in event callback: @_";	183	warn "error in event callback: @_";
101	};	184	};
102		185
103	my %ext_pkg;
104	my @exts;
105	my @hook;
106
107	=head2 UTILITY FUNCTIONS	186	=head2 UTILITY FUNCTIONS
108		187
109	=over 4	188	=over 4
110		189
111	=cut	190	=item dumpval $ref
112		191
		192	=cut
		193
		194	sub dumpval {
		195	eval {
		196	local $SIG{__DIE__};
		197	my $d;
		198	if (1) {
		199	$d = new Data::Dumper([$_[0]], ["*var"]);
		200	$d->Terse(1);
		201	$d->Indent(2);
		202	$d->Quotekeys(0);
		203	$d->Useqq(1);
		204	#$d->Bless(...);
		205	$d->Seen($_[1]) if @_ > 1;
		206	$d = $d->Dump();
		207	}
		208	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		209	$d
		210	} || "[unable to dump $_[0]: '$@']";
		211	}
		212
113	use JSON::Syck (); # TODO# replace by JSON::PC once working	213	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
114		214
115	=item $ref = cf::from_json $json	215	=item $ref = cf::from_json $json
116		216
117	Converts a JSON string into the corresponding perl data structure.	217	Converts a JSON string into the corresponding perl data structure.
118		218
119	=cut
120
121	sub from_json($) {
122	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123	JSON::Syck::Load $_[0]
124	}
125
126	=item $json = cf::to_json $ref	219	=item $json = cf::to_json $ref
127		220
128	Converts a perl data structure into its JSON representation.	221	Converts a perl data structure into its JSON representation.
129		222
130	=cut	223	=item cf::lock_wait $string
131		224
132	sub to_json($) {	225	Wait until the given lock is available. See cf::lock_acquire.
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	226
134	JSON::Syck::Dump $_[0]	227	=item my $lock = cf::lock_acquire $string
		228
		229	Wait until the given lock is available and then acquires it and returns
		230	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		231	for example when the coroutine gets canceled), the lock is automatically
		232	returned.
		233
		234	Lock names should begin with a unique identifier (for example, cf::map::find
		235	uses map_find and cf::map::load uses map_load).
		236
		237	=cut
		238
		239	our %LOCK;
		240
		241	sub lock_wait($) {
		242	my ($key) = @_;
		243
		244	# wait for lock, if any
		245	while ($LOCK{$key}) {
		246	push @{ $LOCK{$key} }, $Coro::current;
		247	Coro::schedule;
		248	}
		249	}
		250
		251	sub lock_acquire($) {
		252	my ($key) = @_;
		253
		254	# wait, to be sure we are not locked
		255	lock_wait $key;
		256
		257	$LOCK{$key} = [];
		258
		259	Coro::guard {
		260	# wake up all waiters, to be on the safe side
		261	$_->ready for @{ delete $LOCK{$key} };
		262	}
		263	}
		264
		265	sub freeze_mainloop {
		266	return unless $TICK_WATCHER->is_active;
		267
		268	my $guard = Coro::guard {
		269	$TICK_WATCHER->start;
		270	};
		271	$TICK_WATCHER->stop;
		272	$guard
		273	}
		274
		275	=item cf::async { BLOCK }
		276
		277	Currently the same as Coro::async_pool, meaning you cannot use
		278	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		279	thing you are allowed to do is call C<prio> on it.
		280
		281	=cut
		282
		283	BEGIN { *async = \&Coro::async_pool }
		284
		285	=item cf::sync_job { BLOCK }
		286
		287	The design of crossfire+ requires that the main coro ($Coro::main) is
		288	always able to handle events or runnable, as crossfire+ is only partly
		289	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		290
		291	If it must be done, put the blocking parts into C<sync_job>. This will run
		292	the given BLOCK in another coroutine while waiting for the result. The
		293	server will be frozen during this time, so the block should either finish
		294	fast or be very important.
		295
		296	=cut
		297
		298	sub sync_job(&) {
		299	my ($job) = @_;
		300
		301	if ($Coro::current == $Coro::main) {
		302	# this is the main coro, too bad, we have to block
		303	# till the operation succeeds, freezing the server :/
		304
		305	# TODO: use suspend/resume instead
		306	# (but this is cancel-safe)
		307	my $freeze_guard = freeze_mainloop;
		308
		309	my $busy = 1;
		310	my @res;
		311
		312	(async {
		313	@res = eval { $job->() };
		314	warn $@ if $@;
		315	undef $busy;
		316	})->prio (Coro::PRIO_MAX);
		317
		318	while ($busy) {
		319	Coro::cede or Event::one_event;
		320	}
		321
		322	wantarray ? @res : $res[0]
		323	} else {
		324	# we are in another coroutine, how wonderful, everything just works
		325
		326	$job->()
		327	}
		328	}
		329
		330	=item $coro = cf::async_ext { BLOCK }
		331
		332	Like async, but this coro is automatically being canceled when the
		333	extension calling this is being unloaded.
		334
		335	=cut
		336
		337	sub async_ext(&) {
		338	my $cb = shift;
		339
		340	my $coro = &Coro::async ($cb);
		341
		342	$coro->on_destroy (sub {
		343	delete $EXT_CORO{$coro+0};
		344	});
		345	$EXT_CORO{$coro+0} = $coro;
		346
		347	$coro
		348	}
		349
		350	sub write_runtime {
		351	my $guard = cf::lock_acquire "write_runtime";
		352
		353	my $runtime = cf::localdir . "/runtime";
		354
		355	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		356	or return;
		357
		358	my $value = $cf::RUNTIME + 90 + 10;
		359	# 10 is the runtime save interval, for a monotonic clock
		360	# 60 allows for the watchdog to kill the server.
		361
		362	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		363	and return;
		364
		365	# always fsync - this file is important
		366	aio_fsync $fh
		367	and return;
		368
		369	close $fh
		370	or return;
		371
		372	aio_rename "$runtime~", $runtime
		373	and return;
		374
		375	1
135	}	376	}
136		377
137	=back	378	=back
138		379
139	=cut	380	=cut
…		…
249	my ($self, $victim) = @_;	490	my ($self, $victim) = @_;
250	...	491	...
251	}	492	}
252	}	493	}
253		494
		495	=item $attachable->valid
		496
		497	Just because you have a perl object does not mean that the corresponding
		498	C-level object still exists. If you try to access an object that has no
		499	valid C counterpart anymore you get an exception at runtime. This method
		500	can be used to test for existence of the C object part without causing an
		501	exception.
		502
254	=cut	503	=cut
255		504
256	# the following variables are defined in .xs and must not be re-created	505	# the following variables are defined in .xs and must not be re-created
257	our @CB_GLOBAL = (); # registry for all global events	506	our @CB_GLOBAL = (); # registry for all global events
		507	our @CB_ATTACHABLE = (); # registry for all attachables
258	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	508	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259	our @CB_PLAYER = ();	509	our @CB_PLAYER = ();
260	our @CB_CLIENT = ();	510	our @CB_CLIENT = ();
261	our @CB_TYPE = (); # registry for type (cf-object class) based events	511	our @CB_TYPE = (); # registry for type (cf-object class) based events
262	our @CB_MAP = ();	512	our @CB_MAP = ();
263		513
264	my %attachment;	514	my %attachment;
		515
		516	sub cf::attachable::thawer_merge {
		517	# simply override everything except _meta
		518	local $_[0]{_meta};
		519	%{$_[0]} = %{$_[1]};
		520	}
265		521
266	sub _attach_cb($$$$) {	522	sub _attach_cb($$$$) {
267	my ($registry, $event, $prio, $cb) = @_;	523	my ($registry, $event, $prio, $cb) = @_;
268		524
269	use sort 'stable';	525	use sort 'stable';
…		…
272		528
273	@{$registry->[$event]} = sort	529	@{$registry->[$event]} = sort
274	{ $a->[0] cmp $b->[0] }	530	{ $a->[0] cmp $b->[0] }
275	@{$registry->[$event] || []}, $cb;	531	@{$registry->[$event] || []}, $cb;
276	}	532	}
		533
		534	# hack
		535	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277		536
278	# attach handles attaching event callbacks	537	# attach handles attaching event callbacks
279	# the only thing the caller has to do is pass the correct	538	# the only thing the caller has to do is pass the correct
280	# registry (== where the callback attaches to).	539	# registry (== where the callback attaches to).
281	sub _attach {	540	sub _attach {
…		…
283		542
284	my $object_type;	543	my $object_type;
285	my $prio = 0;	544	my $prio = 0;
286	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	545	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287		546
		547	#TODO: get rid of this hack
		548	if ($attachable_klass{$klass}) {
		549	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		550	}
		551
288	while (@arg) {	552	while (@arg) {
289	my $type = shift @arg;	553	my $type = shift @arg;
290		554
291	if ($type eq "prio") {	555	if ($type eq "prio") {
292	$prio = shift @arg;	556	$prio = shift @arg;
…		…
367	my ($obj, $name) = @_;	631	my ($obj, $name) = @_;
368		632
369	exists $obj->{_attachment}{$name}	633	exists $obj->{_attachment}{$name}
370	}	634	}
371		635
372	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	636	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373	eval "#line " . __LINE__ . " 'cf.pm'	637	eval "#line " . __LINE__ . " 'cf.pm'
374	sub cf::\L$klass\E::_attach_registry {	638	sub cf::\L$klass\E::_attach_registry {
375	(\\\@CB_$klass, KLASS_$klass)	639	(\\\@CB_$klass, KLASS_$klass)
376	}	640	}
377		641
…		…
413	}	677	}
414		678
415	0	679	0
416	}	680	}
417		681
418	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	682	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419		683
420	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	684	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425		685
426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428	Generate a global/object/player/map-specific event with the given arguments.	686	Generate an object-specific event with the given arguments.
429		687
430	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	688	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
431	removed in future versions), and there is no public API to access override	689	removed in future versions), and there is no public API to access override
432	results (if you must, access C<@cf::invoke_results> directly).	690	results (if you must, access C<@cf::invoke_results> directly).
433		691
434	=back	692	=back
435		693
436	=cut	694	=cut
437		695
438	#############################################################################	696	#############################################################################
439
440	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442	Attachable objects includes objects, players, clients and maps.
443
444	=over 4
445
446	=item $object->valid
447
448	Just because you have a perl object does not mean that the corresponding
449	C-level object still exists. If you try to access an object that has no
450	valid C counterpart anymore you get an exception at runtime. This method
451	can be used to test for existence of the C object part without causing an
452	exception.
453
454	=back
455
456	=cut
457
458	#############################################################################
459	# object support	697	# object support
460		698
461	sub instantiate {
462	my ($obj, $data) = @_;
463
464	$data = from_json $data;
465
466	for (@$data) {
467	my ($name, $args) = @$_;
468
469	$obj->attach ($name, %{$args || {} });
470	}
471	}
472
473	# basically do the same as instantiate, without calling instantiate
474	sub reattach {	699	sub reattach {
		700	# basically do the same as instantiate, without calling instantiate
475	my ($obj) = @_;	701	my ($obj) = @_;
		702
		703	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		704
476	my $registry = $obj->registry;	705	my $registry = $obj->registry;
477		706
478	@$registry = ();	707	@$registry = ();
479		708
480	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	709	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
489	warn "object uses attachment '$name' that is not available, postponing.\n";	718	warn "object uses attachment '$name' that is not available, postponing.\n";
490	}	719	}
491	}	720	}
492	}	721	}
493		722
494	sub object_freezer_save {	723	cf::attachable->attach (
495	my ($filename, $rdata, $objs) = @_;
496
497	if (length $$rdata) {
498	warn sprintf "saving %s (%d,%d)\n",
499	$filename, length $$rdata, scalar @$objs;
500
501	if (open my $fh, ">:raw", "$filename~") {
502	chmod SAVE_MODE, $fh;
503	syswrite $fh, $$rdata;
504	close $fh;
505
506	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507	chmod SAVE_MODE, $fh;
508	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509	close $fh;
510	rename "$filename.pst~", "$filename.pst";
511	} else {
512	unlink "$filename.pst";
513	}
514
515	rename "$filename~", $filename;
516	} else {
517	warn "FATAL: $filename~: $!\n";
518	}
519	} else {
520	unlink $filename;
521	unlink "$filename.pst";
522	}
523	}
524
525	sub object_freezer_as_string {
526	my ($rdata, $objs) = @_;
527
528	use Data::Dumper;
529
530	$$rdata . Dumper $objs
531	}
532
533	sub object_thawer_load {
534	my ($filename) = @_;
535
536	local $/;
537
538	my $av;
539
540	#TODO: use sysread etc.
541	if (open my $data, "<:raw:perlio", $filename) {
542	$data = <$data>;
543	if (open my $pst, "<:raw:perlio", "$filename.pst") {
544	$av = eval { (Storable::thaw <$pst>)->{objs} };
545	}
546	return ($data, $av);
547	}
548
549	()
550	}
551
552	cf::object->attach (
553	prio => -1000000,	724	prio => -1000000,
		725	on_instantiate => sub {
		726	my ($obj, $data) = @_;
		727
		728	$data = from_json $data;
		729
		730	for (@$data) {
		731	my ($name, $args) = @$_;
		732
		733	$obj->attach ($name, %{$args || {} });
		734	}
		735	},
		736	on_reattach => \&reattach,
554	on_clone => sub {	737	on_clone => sub {
555	my ($src, $dst) = @_;	738	my ($src, $dst) = @_;
556		739
557	@{$dst->registry} = @{$src->registry};	740	@{$dst->registry} = @{$src->registry};
558		741
…		…
561	%{$dst->{_attachment}} = %{$src->{_attachment}}	744	%{$dst->{_attachment}} = %{$src->{_attachment}}
562	if exists $src->{_attachment};	745	if exists $src->{_attachment};
563	},	746	},
564	);	747	);
565		748
		749	sub object_freezer_save {
		750	my ($filename, $rdata, $objs) = @_;
		751
		752	sync_job {
		753	if (length $$rdata) {
		754	warn sprintf "saving %s (%d,%d)\n",
		755	$filename, length $$rdata, scalar @$objs;
		756
		757	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		758	chmod SAVE_MODE, $fh;
		759	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		760	aio_fsync $fh if $cf::USE_FSYNC;
		761	close $fh;
		762
		763	if (@$objs) {
		764	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		765	chmod SAVE_MODE, $fh;
		766	my $data = Storable::nfreeze { version => 1, objs => $objs };
		767	aio_write $fh, 0, (length $data), $data, 0;
		768	aio_fsync $fh if $cf::USE_FSYNC;
		769	close $fh;
		770	aio_rename "$filename.pst~", "$filename.pst";
		771	}
		772	} else {
		773	aio_unlink "$filename.pst";
		774	}
		775
		776	aio_rename "$filename~", $filename;
		777	} else {
		778	warn "FATAL: $filename~: $!\n";
		779	}
		780	} else {
		781	aio_unlink $filename;
		782	aio_unlink "$filename.pst";
		783	}
		784	}
		785	}
		786
		787	sub object_freezer_as_string {
		788	my ($rdata, $objs) = @_;
		789
		790	use Data::Dumper;
		791
		792	$$rdata . Dumper $objs
		793	}
		794
		795	sub object_thawer_load {
		796	my ($filename) = @_;
		797
		798	my ($data, $av);
		799
		800	(aio_load $filename, $data) >= 0
		801	or return;
		802
		803	unless (aio_stat "$filename.pst") {
		804	(aio_load "$filename.pst", $av) >= 0
		805	or return;
		806	$av = eval { (Storable::thaw $av)->{objs} };
		807	}
		808
		809	warn sprintf "loading %s (%d)\n",
		810	$filename, length $data, scalar @{$av || []};#d#
		811	return ($data, $av);
		812	}
		813
566	#############################################################################	814	#############################################################################
567	# command handling &c	815	# command handling &c
568		816
569	=item cf::register_command $name => \&callback($ob,$args);	817	=item cf::register_command $name => \&callback($ob,$args);
570		818
…		…
592	=cut	840	=cut
593		841
594	sub register_extcmd {	842	sub register_extcmd {
595	my ($name, $cb) = @_;	843	my ($name, $cb) = @_;
596		844
597	my $caller = caller;
598	#warn "registering extcmd '$name' to '$caller'";
599
600	$EXTCMD{$name} = [$cb, $caller];	845	$EXTCMD{$name} = $cb;
601	}	846	}
602		847
603	cf::player->attach (	848	cf::player->attach (
604	on_command => sub {	849	on_command => sub {
605	my ($pl, $name, $params) = @_;	850	my ($pl, $name, $params) = @_;
…		…
618		863
619	my $msg = eval { from_json $buf };	864	my $msg = eval { from_json $buf };
620		865
621	if (ref $msg) {	866	if (ref $msg) {
622	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	867	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623	if (my %reply = $cb->[0]->($pl, $msg)) {	868	if (my %reply = $cb->($pl, $msg)) {
624	$pl->ext_reply ($msg->{msgid}, %reply);	869	$pl->ext_reply ($msg->{msgid}, %reply);
625	}	870	}
626	}	871	}
627	} else {	872	} else {
628	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	873	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
630		875
631	cf::override;	876	cf::override;
632	},	877	},
633	);	878	);
634		879
635	sub register {
636	my ($base, $pkg) = @_;
637
638	#TODO
639	}
640
641	sub load_extension {	880	sub load_extension {
642	my ($path) = @_;	881	my ($path) = @_;
643		882
644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	883	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
645	my $base = $1;	884	my $base = $1;
646	my $pkg = $1;	885	my $pkg = $1;
647	$pkg =~ s/[^[:word:]]/_/g;	886	$pkg =~ s/[^[:word:]]/_/g;
648	$pkg = "ext::$pkg";	887	$pkg = "ext::$pkg";
649		888
650	warn "loading '$path' into '$pkg'\n";	889	warn "... loading '$path' into '$pkg'\n";
651		890
652	open my $fh, "<:utf8", $path	891	open my $fh, "<:utf8", $path
653	or die "$path: $!";	892	or die "$path: $!";
654		893
655	my $source =	894	my $source =
656	"package $pkg; use strict; use utf8;\n"	895	"package $pkg; use strict; use utf8;\n"
657	. "#line 1 \"$path\"\n{\n"	896	. "#line 1 \"$path\"\n{\n"
658	. (do { local $/; <$fh> })	897	. (do { local $/; <$fh> })
659	. "\n};\n1";	898	. "\n};\n1";
660		899
661	eval $source	900	unless (eval $source) {
662	or die $@ ? "$path: $@\n"	901	my $msg = $@ ? "$path: $@\n"
663	: "extension disabled.\n";	902	: "extension disabled.\n";
664		903	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665	push @exts, $pkg;	904	warn $@;
666	$ext_pkg{$base} = $pkg;	905	warn "mandatory extension failed to load, exiting.\n";
667		906	exit 1;
668	# no strict 'refs';	907	}
669	# @{"$pkg\::ISA"} = ext::;	908	die $@;
670
671	register $base, $pkg;
672	}
673
674	sub unload_extension {
675	my ($pkg) = @_;
676
677	warn "removing extension $pkg\n";
678
679	# remove hooks
680	#TODO
681	# for my $idx (0 .. $#PLUGIN_EVENT) {
682	# delete $hook[$idx]{$pkg};
683	# }	909	}
684		910
685	# remove commands	911	push @EXTS, $pkg;
686	for my $name (keys %COMMAND) {
687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
688
689	if (@cb) {
690	$COMMAND{$name} = \@cb;
691	} else {
692	delete $COMMAND{$name};
693	}
694	}
695
696	# remove extcmds
697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
698	delete $EXTCMD{$name};
699	}
700
701	if (my $cb = $pkg->can ("unload")) {
702	eval {
703	$cb->($pkg);
704	1
705	} or warn "$pkg unloaded, but with errors: $@";
706	}
707
708	Symbol::delete_package $pkg;
709	}	912	}
710		913
711	sub load_extensions {	914	sub load_extensions {
712	for my $ext (<$LIBDIR/*.ext>) {	915	for my $ext (<$LIBDIR/*.ext>) {
713	next unless -r $ext;	916	next unless -r $ext;
…		…
717	} or warn "$ext not loaded: $@";	920	} or warn "$ext not loaded: $@";
718	}	921	}
719	}	922	}
720		923
721	#############################################################################	924	#############################################################################
722	# load/save/clean perl data associated with a map
723		925
724	*cf::mapsupport::on_clean = sub {	926	=head2 CORE EXTENSIONS
		927
		928	Functions and methods that extend core crossfire objects.
		929
		930	=cut
		931
		932	package cf::player;
		933
		934	use Coro::AIO;
		935
		936	=head3 cf::player
		937
		938	=over 4
		939
		940	=item cf::player::find $login
		941
		942	Returns the given player object, loading it if necessary (might block).
		943
		944	=cut
		945
		946	sub playerdir($) {
		947	cf::localdir
		948	. "/"
		949	. cf::playerdir
		950	. "/"
		951	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		952	}
		953
		954	sub path($) {
		955	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		956
		957	(playerdir $login) . "/$login.pl"
		958	}
		959
		960	sub find_active($) {
		961	$cf::PLAYER{$_[0]}
		962	and $cf::PLAYER{$_[0]}->active
		963	and $cf::PLAYER{$_[0]}
		964	}
		965
		966	sub exists($) {
		967	my ($login) = @_;
		968
		969	$cf::PLAYER{$login}
		970	or cf::sync_job { !aio_stat path $login }
		971	}
		972
		973	sub find($) {
		974	return $cf::PLAYER{$_[0]} || do {
		975	my $login = $_[0];
		976
		977	my $guard = cf::lock_acquire "user_find:$login";
		978
		979	$cf::PLAYER{$_[0]} || do {
		980	my $pl = load_pl path $login
		981	or return;
		982	$cf::PLAYER{$login} = $pl
		983	}
		984	}
		985	}
		986
		987	sub save($) {
		988	my ($pl) = @_;
		989
		990	return if $pl->{deny_save};
		991
		992	my $path = path $pl;
		993	my $guard = cf::lock_acquire "user_save:$path";
		994
		995	return if $pl->{deny_save};
		996
		997	aio_mkdir playerdir $pl, 0770;
		998	$pl->{last_save} = $cf::RUNTIME;
		999
		1000	$pl->save_pl ($path);
		1001	Coro::cede;
		1002	}
		1003
		1004	sub new($) {
		1005	my ($login) = @_;
		1006
		1007	my $self = create;
		1008
		1009	$self->ob->name ($login);
		1010	$self->{deny_save} = 1;
		1011
		1012	$cf::PLAYER{$login} = $self;
		1013
		1014	$self
		1015	}
		1016
		1017	=item $pl->quit_character
		1018
		1019	Nukes the player without looking back. If logged in, the connection will
		1020	be destroyed. May block for a long time.
		1021
		1022	=cut
		1023
		1024	sub quit_character {
		1025	my ($pl) = @_;
		1026
		1027	my $name = $pl->ob->name;
		1028
		1029	$pl->{deny_save} = 1;
		1030	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1031
		1032	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1033	$pl->deactivate;
		1034	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1035	$pl->ns->destroy if $pl->ns;
		1036
		1037	my $path = playerdir $pl;
		1038	my $temp = "$path~$cf::RUNTIME~deleting~";
		1039	aio_rename $path, $temp;
		1040	delete $cf::PLAYER{$pl->ob->name};
		1041	$pl->destroy;
		1042
		1043	my $prefix = qr<^~\Q$name\E/>;
		1044
		1045	# nuke player maps
		1046	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1047
		1048	IO::AIO::aio_rmtree $temp;
		1049	}
		1050
		1051	=item $pl->kick
		1052
		1053	Kicks a player out of the game. This destroys the connection.
		1054
		1055	=cut
		1056
		1057	sub kick {
		1058	my ($pl, $kicker) = @_;
		1059
		1060	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1061	$pl->killer ("kicked");
		1062	$pl->ns->destroy;
		1063	}
		1064
		1065	=item cf::player::list_logins
		1066
		1067	Returns am arrayref of all valid playernames in the system, can take a
		1068	while and may block, so not sync_job-capable, ever.
		1069
		1070	=cut
		1071
		1072	sub list_logins {
		1073	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1074	or return [];
		1075
		1076	my @logins;
		1077
		1078	for my $login (@$dirs) {
		1079	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1080	aio_read $fh, 0, 512, my $buf, 0 or next;
		1081	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1082
		1083	utf8::decode $login;
		1084	push @logins, $login;
		1085	}
		1086
		1087	\@logins
		1088	}
		1089
		1090	=item $player->maps
		1091
		1092	Returns an arrayref of map paths that are private for this
		1093	player. May block.
		1094
		1095	=cut
		1096
		1097	sub maps($) {
		1098	my ($pl) = @_;
		1099
		1100	$pl = ref $pl ? $pl->ob->name : $pl;
		1101
		1102	my $files = aio_readdir playerdir $pl
		1103	or return;
		1104
		1105	my @paths;
		1106
		1107	for (@$files) {
		1108	utf8::decode $_;
		1109	next if /\.(?:pl|pst)$/;
		1110	next unless /^$PATH_SEP/o;
		1111
		1112	push @paths, cf::map::normalise "~$pl/$_";
		1113	}
		1114
		1115	\@paths
		1116	}
		1117
		1118	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1119
		1120	Sends an ext reply to the player.
		1121
		1122	=cut
		1123
		1124	sub ext_reply($$$%) {
		1125	my ($self, $id, %msg) = @_;
		1126
		1127	$msg{msgid} = $id;
		1128
		1129	$self->send ("ext " . cf::to_json \%msg);
		1130	}
		1131
		1132	package cf;
		1133
		1134	=back
		1135
		1136
		1137	=head3 cf::map
		1138
		1139	=over 4
		1140
		1141	=cut
		1142
		1143	package cf::map;
		1144
		1145	use Fcntl;
		1146	use Coro::AIO;
		1147
		1148	use overload
		1149	'""' => \&as_string,
		1150	fallback => 1;
		1151
		1152	our $MAX_RESET = 3600;
		1153	our $DEFAULT_RESET = 3000;
		1154
		1155	sub generate_random_map {
		1156	my ($self, $rmp) = @_;
		1157	# mit "rum" bekleckern, nicht
		1158	$self->_create_random_map (
		1159	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1160	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1161	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1162	$rmp->{exit_on_final_map},
		1163	$rmp->{xsize}, $rmp->{ysize},
		1164	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1165	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1166	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1167	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1168	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1169	(cf::region::find $rmp->{region}), $rmp->{custom}
		1170	)
		1171	}
		1172
		1173	=item cf::map->register ($regex, $prio)
		1174
		1175	Register a handler for the map path matching the given regex at the
		1176	givne priority (higher is better, built-in handlers have priority 0, the
		1177	default).
		1178
		1179	=cut
		1180
		1181	sub register {
		1182	my (undef, $regex, $prio) = @_;
		1183	my $pkg = caller;
		1184
		1185	no strict;
		1186	push @{"$pkg\::ISA"}, __PACKAGE__;
		1187
		1188	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1189	}
		1190
		1191	# also paths starting with '/'
		1192	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1193
		1194	sub thawer_merge {
		1195	my ($self, $merge) = @_;
		1196
		1197	# we have to keep some variables in memory intact
		1198	local $self->{path};
		1199	local $self->{load_path};
		1200	local $self->{deny_save};
		1201	local $self->{deny_reset};
		1202
		1203	$self->SUPER::thawer_merge ($merge);
		1204	}
		1205
		1206	sub normalise {
		1207	my ($path, $base) = @_;
		1208
		1209	$path = "$path"; # make sure its a string
		1210
		1211	$path =~ s/\.map$//;
		1212
		1213	# map plan:
		1214	#
		1215	# /! non-realised random map exit (special hack!)
		1216	# {... are special paths that are not being touched
		1217	# ?xxx/... are special absolute paths
		1218	# ?random/... random maps
		1219	# /... normal maps
		1220	# ~user/... per-player map of a specific user
		1221
		1222	$path =~ s/$PATH_SEP/\//go;
		1223
		1224	# treat it as relative path if it starts with
		1225	# something that looks reasonable
		1226	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1227	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1228
		1229	$base =~ s{[^/]+/?$}{};
		1230	$path = "$base/$path";
		1231	}
		1232
		1233	for ($path) {
		1234	redo if s{//}{/};
		1235	redo if s{/\.?/}{/};
		1236	redo if s{/[^/]+/\.\./}{/};
		1237	}
		1238
		1239	$path
		1240	}
		1241
		1242	sub new_from_path {
		1243	my (undef, $path, $base) = @_;
		1244
		1245	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1246
		1247	$path = normalise $path, $base;
		1248
		1249	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1250	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1251	my $self = bless cf::map::new, $pkg;
		1252	$self->{path} = $path; $self->path ($path);
		1253	$self->init; # pass $1 etc.
		1254	return $self;
		1255	}
		1256	}
		1257
		1258	Carp::carp "unable to resolve path '$path' (base '$base').";
		1259	()
		1260	}
		1261
		1262	sub init {
		1263	my ($self) = @_;
		1264
		1265	$self
		1266	}
		1267
		1268	sub as_string {
		1269	my ($self) = @_;
		1270
		1271	"$self->{path}"
		1272	}
		1273
		1274	# the displayed name, this is a one way mapping
		1275	sub visible_name {
		1276	&as_string
		1277	}
		1278
		1279	# the original (read-only) location
		1280	sub load_path {
		1281	my ($self) = @_;
		1282
		1283	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1284	}
		1285
		1286	# the temporary/swap location
		1287	sub save_path {
		1288	my ($self) = @_;
		1289
		1290	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1291	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1292	}
		1293
		1294	# the unique path, undef == no special unique path
		1295	sub uniq_path {
		1296	my ($self) = @_;
		1297
		1298	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1299	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1300	}
		1301
		1302	# and all this just because we cannot iterate over
		1303	# all maps in C++...
		1304	sub change_all_map_light {
		1305	my ($change) = @_;
		1306
		1307	$_->change_map_light ($change)
		1308	for grep $_->outdoor, values %cf::MAP;
		1309	}
		1310
		1311	sub unlink_save {
		1312	my ($self) = @_;
		1313
		1314	utf8::encode (my $save = $self->save_path);
		1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1317	}
		1318
		1319	sub load_header_from($) {
		1320	my ($self, $path) = @_;
		1321
		1322	utf8::encode $path;
		1323	#aio_open $path, O_RDONLY, 0
		1324	# or return;
		1325
		1326	$self->_load_header ($path)
		1327	or return;
		1328
		1329	$self->{load_path} = $path;
		1330
		1331	1
		1332	}
		1333
		1334	sub load_header_orig {
		1335	my ($self) = @_;
		1336
		1337	$self->load_header_from ($self->load_path)
		1338	}
		1339
		1340	sub load_header_temp {
		1341	my ($self) = @_;
		1342
		1343	$self->load_header_from ($self->save_path)
		1344	}
		1345
		1346	sub prepare_temp {
		1347	my ($self) = @_;
		1348
		1349	$self->last_access ((delete $self->{last_access})
		1350	|| $cf::RUNTIME); #d#
		1351	# safety
		1352	$self->{instantiate_time} = $cf::RUNTIME
		1353	if $self->{instantiate_time} > $cf::RUNTIME;
		1354	}
		1355
		1356	sub prepare_orig {
		1357	my ($self) = @_;
		1358
		1359	$self->{load_original} = 1;
		1360	$self->{instantiate_time} = $cf::RUNTIME;
		1361	$self->last_access ($cf::RUNTIME);
		1362	$self->instantiate;
		1363	}
		1364
		1365	sub load_header {
		1366	my ($self) = @_;
		1367
		1368	if ($self->load_header_temp) {
		1369	$self->prepare_temp;
		1370	} else {
		1371	$self->load_header_orig
		1372	or return;
		1373	$self->prepare_orig;
		1374	}
		1375
		1376	1
		1377	}
		1378
		1379	sub find;
		1380	sub find {
		1381	my ($path, $origin) = @_;
		1382
		1383	$path = normalise $path, $origin && $origin->path;
		1384
		1385	cf::lock_wait "map_find:$path";
		1386
		1387	$cf::MAP{$path} || do {
		1388	my $guard = cf::lock_acquire "map_find:$path";
		1389	my $map = new_from_path cf::map $path
		1390	or return;
		1391
		1392	$map->{last_save} = $cf::RUNTIME;
		1393
		1394	$map->load_header
		1395	or return;
		1396
		1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1398	# doing this can freeze the server in a sync job, obviously
		1399	#$cf::WAIT_FOR_TICK->wait;
		1400	$map->reset;
		1401	undef $guard;
		1402	return find $path;
		1403	}
		1404
		1405	$cf::MAP{$path} = $map
		1406	}
		1407	}
		1408
		1409	sub pre_load { }
		1410	sub post_load { }
		1411
		1412	sub load {
		1413	my ($self) = @_;
		1414
		1415	local $self->{deny_reset} = 1; # loading can take a long time
		1416
		1417	my $path = $self->{path};
		1418	my $guard = cf::lock_acquire "map_load:$path";
		1419
		1420	return if $self->in_memory != cf::MAP_SWAPPED;
		1421
		1422	$self->in_memory (cf::MAP_LOADING);
		1423
		1424	$self->alloc;
		1425
		1426	$self->pre_load;
		1427
		1428	$self->_load_objects ($self->{load_path}, 1)
		1429	or return;
		1430
		1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1432	if delete $self->{load_original};
		1433
		1434	if (my $uniq = $self->uniq_path) {
		1435	utf8::encode $uniq;
		1436	if (aio_open $uniq, O_RDONLY, 0) {
		1437	$self->clear_unique_items;
		1438	$self->_load_objects ($uniq, 0);
		1439	}
		1440	}
		1441
		1442	Coro::cede;
		1443
		1444	# now do the right thing for maps
		1445	$self->link_multipart_objects;
		1446
		1447	unless ($self->{deny_activate}) {
		1448	$self->decay_objects;
		1449	$self->fix_auto_apply;
		1450	$self->update_buttons;
		1451	Coro::cede;
		1452	$self->set_darkness_map;
		1453	$self->difficulty ($self->estimate_difficulty)
		1454	unless $self->difficulty;
		1455	Coro::cede;
		1456	$self->activate;
		1457	}
		1458
		1459	$self->post_load;
		1460
		1461	$self->in_memory (cf::MAP_IN_MEMORY);
		1462	}
		1463
		1464	sub customise_for {
		1465	my ($self, $ob) = @_;
		1466
		1467	return find "~" . $ob->name . "/" . $self->{path}
		1468	if $self->per_player;
		1469
		1470	$self
		1471	}
		1472
		1473	# find and load all maps in the 3x3 area around a map
		1474	sub load_diag {
725	my ($map) = @_;	1475	my ($map) = @_;
726		1476
727	my $path = $map->tmpname;	1477	my @diag; # diagonal neighbours
728	defined $path or return;
729		1478
730	unlink "$path.pst";	1479	for (0 .. 3) {
731	};	1480	my $neigh = $map->tile_path ($_)
		1481	or next;
		1482	$neigh = find $neigh, $map
		1483	or next;
		1484	$neigh->load;
732		1485
733	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1488	}
734		1489
735	#############################################################################	1490	for (@diag) {
736	# load/save perl data associated with player->ob objects	1491	my $neigh = find @$_
737		1492	or next;
738	sub all_objects(@) {	1493	$neigh->load;
739	@_, map all_objects ($_->inv), @_	1494	}
740	}	1495	}
741		1496
742	# TODO: compatibility cruft, remove when no longer needed	1497	sub find_sync {
743	cf::player->attach (	1498	my ($path, $origin) = @_;
744	on_load => sub {
745	my ($pl, $path) = @_;
746		1499
747	for my $o (all_objects $pl->ob) {	1500	cf::sync_job { find $path, $origin }
748	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1501	}
749	$o->set_ob_key_value ("_perl_data");
750		1502
751	%$o = %{ Storable::thaw pack "H*", $value };	1503	sub do_load_sync {
		1504	my ($map) = @_;
		1505
		1506	cf::sync_job { $map->load };
		1507	}
		1508
		1509	our %MAP_PREFETCH;
		1510	our $MAP_PREFETCHER = undef;
		1511
		1512	sub find_async {
		1513	my ($path, $origin) = @_;
		1514
		1515	$path = normalise $path, $origin && $origin->{path};
		1516
		1517	if (my $map = $cf::MAP{$path}) {
		1518	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1519	}
		1520
		1521	undef $MAP_PREFETCH{$path};
		1522	$MAP_PREFETCHER ||= cf::async {
		1523	while (%MAP_PREFETCH) {
		1524	for my $path (keys %MAP_PREFETCH) {
		1525	my $map = find $path
		1526	or next;
		1527	$map->load;
		1528
		1529	delete $MAP_PREFETCH{$path};
752	}	1530	}
753	}	1531	}
		1532	undef $MAP_PREFETCHER;
		1533	};
		1534	$MAP_PREFETCHER->prio (6);
		1535
		1536	()
		1537	}
		1538
		1539	sub save {
		1540	my ($self) = @_;
		1541
		1542	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1543
		1544	$self->{last_save} = $cf::RUNTIME;
		1545
		1546	return unless $self->dirty;
		1547
		1548	my $save = $self->save_path; utf8::encode $save;
		1549	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1550
		1551	$self->{load_path} = $save;
		1552
		1553	return if $self->{deny_save};
		1554
		1555	local $self->{last_access} = $self->last_access;#d#
		1556
		1557	cf::async {
		1558	$_->contr->save for $self->players;
		1559	};
		1560
		1561	if ($uniq) {
		1562	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1563	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1564	} else {
		1565	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754	},	1566	}
755	);	1567	}
756		1568
757	#############################################################################	1569	sub swap_out {
		1570	my ($self) = @_;
758		1571
759	=head2 CORE EXTENSIONS	1572	# save first because save cedes
		1573	$self->save;
760		1574
761	Functions and methods that extend core crossfire objects.	1575	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1576
		1577	return if $self->players;
		1578	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1579	return if $self->{deny_save};
		1580
		1581	$self->clear;
		1582	$self->in_memory (cf::MAP_SWAPPED);
		1583	}
		1584
		1585	sub reset_at {
		1586	my ($self) = @_;
		1587
		1588	# TODO: safety, remove and allow resettable per-player maps
		1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1590	return 1e99 if $self->{deny_reset};
		1591
		1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1594
		1595	$time + $to
		1596	}
		1597
		1598	sub should_reset {
		1599	my ($self) = @_;
		1600
		1601	$self->reset_at <= $cf::RUNTIME
		1602	}
		1603
		1604	sub reset {
		1605	my ($self) = @_;
		1606
		1607	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1608
		1609	return if $self->players;
		1610	return if $self->isa ("ext::map_per_player");#d#
		1611
		1612	warn "resetting map ", $self->path;#d#
		1613
		1614	$self->in_memory (cf::MAP_SWAPPED);
		1615
		1616	# need to save uniques path
		1617	unless ($self->{deny_save}) {
		1618	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1619
		1620	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1621	if $uniq;
		1622	}
		1623
		1624	delete $cf::MAP{$self->path};
		1625
		1626	$self->clear;
		1627
		1628	$_->clear_links_to ($self) for values %cf::MAP;
		1629
		1630	$self->unlink_save;
		1631	$self->destroy;
		1632	}
		1633
		1634	my $nuke_counter = "aaaa";
		1635
		1636	sub nuke {
		1637	my ($self) = @_;
		1638
		1639	delete $cf::MAP{$self->path};
		1640
		1641	$self->unlink_save;
		1642
		1643	bless $self, "cf::map";
		1644	delete $self->{deny_reset};
		1645	$self->{deny_save} = 1;
		1646	$self->reset_timeout (1);
		1647	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1648
		1649	$cf::MAP{$self->path} = $self;
		1650
		1651	$self->reset; # polite request, might not happen
		1652	}
		1653
		1654	=item cf::map::unique_maps
		1655
		1656	Returns an arrayref of paths of all shared maps that have
		1657	instantiated unique items. May block.
		1658
		1659	=cut
		1660
		1661	sub unique_maps() {
		1662	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1663	or return;
		1664
		1665	my @paths;
		1666
		1667	for (@$files) {
		1668	utf8::decode $_;
		1669	next if /\.pst$/;
		1670	next unless /^$PATH_SEP/o;
		1671
		1672	push @paths, cf::map::normalise $_;
		1673	}
		1674
		1675	\@paths
		1676	}
		1677
		1678	package cf;
		1679
		1680	=back
		1681
		1682	=head3 cf::object
		1683
		1684	=cut
		1685
		1686	package cf::object;
762		1687
763	=over 4	1688	=over 4
764		1689
765	=item cf::player::exists $login	1690	=item $ob->inv_recursive
766		1691
767	Returns true when the given account exists.	1692	Returns the inventory of the object _and_ their inventories, recursively.
768		1693
769	=cut	1694	=cut
770		1695
771	sub cf::player::exists($) {	1696	sub inv_recursive_;
772	cf::player::find $_[0]	1697	sub inv_recursive_ {
773	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1698	map { $_, inv_recursive_ $_->inv } @_
774	}	1699	}
		1700
		1701	sub inv_recursive {
		1702	inv_recursive_ inv $_[0]
		1703	}
		1704
		1705	package cf;
		1706
		1707	=back
		1708
		1709	=head3 cf::object::player
		1710
		1711	=over 4
775		1712
776	=item $player_object->reply ($npc, $msg[, $flags])	1713	=item $player_object->reply ($npc, $msg[, $flags])
777		1714
778	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1715	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
779	can be C<undef>. Does the right thing when the player is currently in a	1716	can be C<undef>. Does the right thing when the player is currently in a
…		…
781		1718
782	=cut	1719	=cut
783		1720
784	# rough implementation of a future "reply" method that works	1721	# rough implementation of a future "reply" method that works
785	# with dialog boxes.	1722	# with dialog boxes.
		1723	#TODO: the first argument must go, split into a $npc->reply_to ( method
786	sub cf::object::player::reply($$$;$) {	1724	sub cf::object::player::reply($$$;$) {
787	my ($self, $npc, $msg, $flags) = @_;	1725	my ($self, $npc, $msg, $flags) = @_;
788		1726
789	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1727	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790		1728
…		…
794	$msg = $npc->name . " says: $msg" if $npc;	1732	$msg = $npc->name . " says: $msg" if $npc;
795	$self->message ($msg, $flags);	1733	$self->message ($msg, $flags);
796	}	1734	}
797	}	1735	}
798		1736
799	=item $player->ext_reply ($msgid, $msgtype, %msg)
800
801	Sends an ext reply to the player.
802
803	=cut
804
805	sub cf::player::ext_reply($$$%) {
806	my ($self, $id, %msg) = @_;
807
808	$msg{msgid} = $id;
809
810	$self->send ("ext " . to_json \%msg);
811	}
812
813	=item $player_object->may ("access")	1737	=item $player_object->may ("access")
814		1738
815	Returns wether the given player is authorized to access resource "access"	1739	Returns wether the given player is authorized to access resource "access"
816	(e.g. "command_wizcast").	1740	(e.g. "command_wizcast").
817		1741
…		…
824	(ref $cf::CFG{"may_$access"}	1748	(ref $cf::CFG{"may_$access"}
825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1749	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826	: $cf::CFG{"may_$access"})	1750	: $cf::CFG{"may_$access"})
827	}	1751	}
828		1752
829	=cut	1753	=item $player_object->enter_link
830		1754
831	#############################################################################	1755	Freezes the player and moves him/her to a special map (C<{link}>).
		1756
		1757	The player should be reasonably safe there for short amounts of time. You
		1758	I<MUST> call C<leave_link> as soon as possible, though.
		1759
		1760	Will never block.
		1761
		1762	=item $player_object->leave_link ($map, $x, $y)
		1763
		1764	Moves the player out of the special C<{link}> map onto the specified
		1765	map. If the map is not valid (or omitted), the player will be moved back
		1766	to the location he/she was before the call to C<enter_link>, or, if that
		1767	fails, to the emergency map position.
		1768
		1769	Might block.
		1770
		1771	=cut
		1772
		1773	sub link_map {
		1774	unless ($LINK_MAP) {
		1775	$LINK_MAP = cf::map::find "{link}"
		1776	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1777	$LINK_MAP->load;
		1778	}
		1779
		1780	$LINK_MAP
		1781	}
		1782
		1783	sub cf::object::player::enter_link {
		1784	my ($self) = @_;
		1785
		1786	$self->deactivate_recursive;
		1787
		1788	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1789
		1790	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1791	if $self->map;
		1792
		1793	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1794	}
		1795
		1796	sub cf::object::player::leave_link {
		1797	my ($self, $map, $x, $y) = @_;
		1798
		1799	my $link_pos = delete $self->{_link_pos};
		1800
		1801	unless ($map) {
		1802	# restore original map position
		1803	($map, $x, $y) = @{ $link_pos || [] };
		1804	$map = cf::map::find $map;
		1805
		1806	unless ($map) {
		1807	($map, $x, $y) = @$EMERGENCY_POSITION;
		1808	$map = cf::map::find $map
		1809	or die "FATAL: cannot load emergency map\n";
		1810	}
		1811	}
		1812
		1813	($x, $y) = (-1, -1)
		1814	unless (defined $x) && (defined $y);
		1815
		1816	# use -1 or undef as default coordinates, not 0, 0
		1817	($x, $y) = ($map->enter_x, $map->enter_y)
		1818	if $x <=0 && $y <= 0;
		1819
		1820	$map->load;
		1821	$map->load_diag;
		1822
		1823	return unless $self->contr->active;
		1824	$self->activate_recursive;
		1825
		1826	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1827	$self->enter_map ($map, $x, $y);
		1828	}
		1829
		1830	cf::player->attach (
		1831	on_logout => sub {
		1832	my ($pl) = @_;
		1833
		1834	# abort map switching before logout
		1835	if ($pl->ob->{_link_pos}) {
		1836	cf::sync_job {
		1837	$pl->ob->leave_link
		1838	};
		1839	}
		1840	},
		1841	on_login => sub {
		1842	my ($pl) = @_;
		1843
		1844	# try to abort aborted map switching on player login :)
		1845	# should happen only on crashes
		1846	if ($pl->ob->{_link_pos}) {
		1847	$pl->ob->enter_link;
		1848	(async {
		1849	$pl->ob->reply (undef,
		1850	"There was an internal problem at your last logout, "
		1851	. "the server will try to bring you to your intended destination in a second.",
		1852	cf::NDI_RED);
		1853	# we need this sleep as the login has a concurrent enter_exit running
		1854	# and this sleep increases chances of the player not ending up in scorn
		1855	Coro::Timer::sleep 1;
		1856	$pl->ob->leave_link;
		1857	})->prio (2);
		1858	}
		1859	},
		1860	);
		1861
		1862	=item $player_object->goto ($path, $x, $y)
		1863
		1864	=cut
		1865
		1866	sub cf::object::player::goto {
		1867	my ($self, $path, $x, $y) = @_;
		1868
		1869	$self->enter_link;
		1870
		1871	(async {
		1872	my $map = eval {
		1873	my $map = cf::map::find $path;
		1874	$map = $map->customise_for ($self) if $map;
		1875	$map
		1876	} or
		1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1878
		1879	$self->leave_link ($map, $x, $y);
		1880	})->prio (1);
		1881	}
		1882
		1883	=item $player_object->enter_exit ($exit_object)
		1884
		1885	=cut
		1886
		1887	sub parse_random_map_params {
		1888	my ($spec) = @_;
		1889
		1890	my $rmp = { # defaults
		1891	xsize => (cf::rndm 15, 40),
		1892	ysize => (cf::rndm 15, 40),
		1893	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1894	#layout => string,
		1895	};
		1896
		1897	for (split /\n/, $spec) {
		1898	my ($k, $v) = split /\s+/, $_, 2;
		1899
		1900	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1901	}
		1902
		1903	$rmp
		1904	}
		1905
		1906	sub prepare_random_map {
		1907	my ($exit) = @_;
		1908
		1909	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1910
		1911	# all this does is basically replace the /! path by
		1912	# a new random map path (?random/...) with a seed
		1913	# that depends on the exit object
		1914
		1915	my $rmp = parse_random_map_params $exit->msg;
		1916
		1917	if ($exit->map) {
		1918	$rmp->{region} = $exit->region->name;
		1919	$rmp->{origin_map} = $exit->map->path;
		1920	$rmp->{origin_x} = $exit->x;
		1921	$rmp->{origin_y} = $exit->y;
		1922	}
		1923
		1924	$rmp->{random_seed} ||= $exit->random_seed;
		1925
		1926	my $data = cf::to_json $rmp;
		1927	my $md5 = Digest::MD5::md5_hex $data;
		1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1929
		1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1931	aio_write $fh, 0, (length $data), $data, 0;
		1932	undef $fh;
		1933	aio_rename "$meta~", $meta;
		1934
		1935	$exit->slaying ("?random/$md5");
		1936	$exit->msg (undef);
		1937	}
		1938	}
		1939
		1940	sub cf::object::player::enter_exit {
		1941	my ($self, $exit) = @_;
		1942
		1943	return unless $self->type == cf::PLAYER;
		1944
		1945	if ($exit->slaying eq "/!") {
		1946	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1947	cf::sync_job { prepare_random_map $exit };
		1948	}
		1949
		1950	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1951	my $hp = $exit->stats->hp;
		1952	my $sp = $exit->stats->sp;
		1953
		1954	$self->enter_link;
		1955
		1956	(async {
		1957	$self->deactivate_recursive; # just to be sure
		1958	unless (eval {
		1959	$self->goto ($slaying, $hp, $sp);
		1960
		1961	1;
		1962	}) {
		1963	$self->message ("Something went wrong deep within the crossfire server. "
		1964	. "I'll try to bring you back to the map you were before. "
		1965	. "Please report this to the dungeon master!",
		1966	cf::NDI_UNIQUE | cf::NDI_RED);
		1967
		1968	warn "ERROR in enter_exit: $@";
		1969	$self->leave_link;
		1970	}
		1971	})->prio (1);
		1972	}
		1973
		1974	=head3 cf::client
		1975
		1976	=over 4
		1977
		1978	=item $client->send_drawinfo ($text, $flags)
		1979
		1980	Sends a drawinfo packet to the client. Circumvents output buffering so
		1981	should not be used under normal circumstances.
		1982
		1983	=cut
		1984
		1985	sub cf::client::send_drawinfo {
		1986	my ($self, $text, $flags) = @_;
		1987
		1988	utf8::encode $text;
		1989	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		1990	}
		1991
		1992
		1993	=item $success = $client->query ($flags, "text", \&cb)
		1994
		1995	Queues a query to the client, calling the given callback with
		1996	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1997	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1998
		1999	Queries can fail, so check the return code. Or don't, as queries will become
		2000	reliable at some point in the future.
		2001
		2002	=cut
		2003
		2004	sub cf::client::query {
		2005	my ($self, $flags, $text, $cb) = @_;
		2006
		2007	return unless $self->state == ST_PLAYING
		2008	|| $self->state == ST_SETUP
		2009	|| $self->state == ST_CUSTOM;
		2010
		2011	$self->state (ST_CUSTOM);
		2012
		2013	utf8::encode $text;
		2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2015
		2016	$self->send_packet ($self->{query_queue}[0][0])
		2017	if @{ $self->{query_queue} } == 1;
		2018	}
		2019
		2020	cf::client->attach (
		2021	on_reply => sub {
		2022	my ($ns, $msg) = @_;
		2023
		2024	# this weird shuffling is so that direct followup queries
		2025	# get handled first
		2026	my $queue = delete $ns->{query_queue}
		2027	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2028
		2029	(shift @$queue)->[1]->($msg);
		2030	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2031
		2032	push @{ $ns->{query_queue} }, @$queue;
		2033
		2034	if (@{ $ns->{query_queue} } == @$queue) {
		2035	if (@$queue) {
		2036	$ns->send_packet ($ns->{query_queue}[0][0]);
		2037	} else {
		2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2039	}
		2040	}
		2041	},
		2042	);
		2043
		2044	=item $client->async (\&cb)
		2045
		2046	Create a new coroutine, running the specified callback. The coroutine will
		2047	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2048	or loss of connection).
		2049
		2050	=cut
		2051
		2052	sub cf::client::async {
		2053	my ($self, $cb) = @_;
		2054
		2055	my $coro = &Coro::async ($cb);
		2056
		2057	$coro->on_destroy (sub {
		2058	delete $self->{_coro}{$coro+0};
		2059	});
		2060
		2061	$self->{_coro}{$coro+0} = $coro;
		2062
		2063	$coro
		2064	}
		2065
		2066	cf::client->attach (
		2067	on_destroy => sub {
		2068	my ($ns) = @_;
		2069
		2070	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2071	},
		2072	);
		2073
		2074	=back
		2075
832		2076
833	=head2 SAFE SCRIPTING	2077	=head2 SAFE SCRIPTING
834		2078
835	Functions that provide a safe environment to compile and execute	2079	Functions that provide a safe environment to compile and execute
836	snippets of perl code without them endangering the safety of the server	2080	snippets of perl code without them endangering the safety of the server
…		…
849		2093
850	# here we export the classes and methods available to script code	2094	# here we export the classes and methods available to script code
851		2095
852	=pod	2096	=pod
853		2097
854	The following fucntions and emthods are available within a safe environment:	2098	The following functions and methods are available within a safe environment:
855		2099
856	cf::object contr pay_amount pay_player map	2100	cf::object contr pay_amount pay_player map
857	cf::object::player player	2101	cf::object::player player
858	cf::player peaceful	2102	cf::player peaceful
859	cf::map trigger	2103	cf::map trigger
…		…
952	The parameter C<$family> should best start with the name of the extension	2196	The parameter C<$family> should best start with the name of the extension
953	using it, it should be unique.	2197	using it, it should be unique.
954		2198
955	=over 4	2199	=over 4
956		2200
957	=item $hashref = cf::db_get $family
958
959	Return a hashref for use by the extension C<$family>, which can be
960	modified. After modifications, you have to call C<cf::db_dirty> or
961	C<cf::db_sync>.
962
963	=item $value = cf::db_get $family => $key	2201	=item $value = cf::db_get $family => $key
964		2202
965	Returns a single value from the database	2203	Returns a single value from the database.
966
967	=item cf::db_put $family => $hashref
968
969	Stores the given family hashref into the database. Updates are delayed, if
970	you want the data to be synced to disk immediately, use C<cf::db_sync>.
971		2204
972	=item cf::db_put $family => $key => $value	2205	=item cf::db_put $family => $key => $value
973		2206
974	Stores the given C<$value> in the family hash. Updates are delayed, if you	2207	Stores the given C<$value> in the family.
975	want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977	=item cf::db_dirty
978
979	Marks the database as dirty, to be updated at a later time.
980
981	=item cf::db_sync
982
983	Immediately write the database to disk I<if it is dirty>.
984		2208
985	=cut	2209	=cut
986		2210
987	our $DB;	2211	our $DB;
988		2212
989	{	2213	sub db_init {
		2214	unless ($DB) {
		2215	$DB = BDB::db_create $DB_ENV;
		2216
		2217	cf::sync_job {
		2218	eval {
		2219	$DB->set_flags (BDB::CHKSUM);
		2220
		2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2223	cf::cleanup "db_open(db): $!" if $!;
		2224	};
		2225	cf::cleanup "db_open(db): $@" if $@;
		2226	};
		2227
990	my $path = cf::localdir . "/database.pst";	2228	my $path = cf::localdir . "/database.pst";
		2229	if (stat $path) {
		2230	cf::sync_job {
		2231	my $pst = Storable::retrieve $path;
991		2232
992	sub db_load() {	2233	cf::db_put (board => data => $pst->{board});
993	warn "loading database $path\n";#d# remove later	2234	cf::db_put (guildrules => data => $pst->{guildrules});
994	$DB = stat $path ? Storable::retrieve $path : { };	2235	cf::db_put (rent => balance => $pst->{rent}{balance});
995	}	2236	BDB::db_env_txn_checkpoint $DB_ENV;
996		2237
997	my $pid;	2238	unlink $path;
998
999	sub db_save() {
1000	warn "saving database $path\n";#d# remove later
1001	waitpid $pid, 0 if $pid;
1002	if (0 == ($pid = fork)) {
1003	$DB->{_meta}{version} = 1;
1004	Storable::nstore $DB, "$path~";
1005	rename "$path~", $path;
1006	cf::_exit 0 if defined $pid;
1007	}	2239	};
1008	}	2240	}
1009
1010	my $dirty;
1011
1012	sub db_sync() {
1013	db_save if $dirty;
1014	undef $dirty;
1015	}
1016
1017	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018	db_sync;
1019	});	2241	}
		2242	}
1020		2243
1021	sub db_dirty() {
1022	$dirty = 1;
1023	$idle->start;
1024	}
1025
1026	sub db_get($;$) {	2244	sub db_get($$) {
1027	@_ >= 2	2245	my $key = "$_[0]/$_[1]";
1028	? $DB->{$_[0]}{$_[1]}
1029	: ($DB->{$_[0]} ||= { })
1030	}
1031		2246
		2247	cf::sync_job {
		2248	BDB::db_get $DB, undef, $key, my $data;
		2249
		2250	$! ? ()
		2251	: Compress::LZF::sthaw $data
		2252	}
		2253	}
		2254
1032	sub db_put($$;$) {	2255	sub db_put($$$) {
1033	if (@_ >= 3) {	2256	BDB::dbreq_pri 4;
1034	$DB->{$_[0]}{$_[1]} = $_[2];	2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
		2258	}
		2259
		2260	#############################################################################
		2261	# the server's init and main functions
		2262
		2263	sub load_faces {
		2264	my $path = sprintf "%s/faces", cf::datadir;
		2265
		2266	warn "loading faces from $path\n";
		2267
		2268	my $faces;
		2269	0 < aio_load $path, $faces
		2270	or die "$path: $!";
		2271
		2272	Coro::cede;
		2273	$faces = Storable::thaw $faces;
		2274	Coro::cede;
		2275
		2276	my $meta = delete $faces->{""};
		2277	$meta->{version} == 1
		2278	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2279
		2280	while (my ($face, $info) = each %$faces) {
		2281	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2282	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2283	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2284	Coro::cede;
		2285	}
		2286
		2287	while (my ($face, $info) = each %$faces) {
		2288	next unless $info->{smooth};
		2289	my $idx = cf::face::find $face
		2290	or next;
		2291	if (my $smooth = cf::face::find $info->{smooth}) {
		2292	cf::face::set_smooth $idx, $smooth;
1035	} else {	2293	} else {
1036	$DB->{$_[0]} = $_[1];	2294	warn "smooth face '$info->{smooth}' not found for face '$face'";
1037	}
1038	db_dirty;
1039	}
1040
1041	cf::global->attach (
1042	prio => 10000,
1043	on_cleanup => sub {
1044	db_sync;
1045	},	2295	}
1046	);	2296	Coro::cede;
1047	}	2297	}
1048		2298
1049	#############################################################################	2299	1
1050	# the server's main()	2300	}
		2301
		2302	sub reload_resources {
		2303	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2304	or die "unable to load regions file\n";#d#
		2305	load_faces
		2306	or die "unable to load faces\n";#d#
		2307	}
		2308
		2309	sub init {
		2310	reload_resources;
		2311	}
1051		2312
1052	sub cfg_load {	2313	sub cfg_load {
1053	open my $fh, "<:utf8", cf::confdir . "/config"	2314	open my $fh, "<:utf8", cf::confdir . "/config"
1054	or return;	2315	or return;
1055		2316
1056	local $/;	2317	local $/;
1057	*CFG = YAML::Syck::Load <$fh>;	2318	*CFG = YAML::Syck::Load <$fh>;
		2319
		2320	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2321
		2322	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2323	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2324
		2325	if (exists $CFG{mlockall}) {
		2326	eval {
		2327	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2328	and die "WARNING: m(un)lockall failed: $!\n";
		2329	};
		2330	warn $@ if $@;
		2331	}
1058	}	2332	}
1059		2333
1060	sub main {	2334	sub main {
		2335	# we must not ever block the main coroutine
		2336	local $Coro::idle = sub {
		2337	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2338	(async {
		2339	Event::one_event;
		2340	})->prio (Coro::PRIO_MAX);
		2341	};
		2342
1061	cfg_load;	2343	cfg_load;
1062	db_load;	2344	db_init;
1063	load_extensions;	2345	load_extensions;
		2346
		2347	$TICK_WATCHER->start;
1064	Event::loop;	2348	Event::loop;
1065	}	2349	}
1066		2350
1067	#############################################################################	2351	#############################################################################
1068	# initialisation	2352	# initialisation and cleanup
1069		2353
		2354	# install some emergency cleanup handlers
		2355	BEGIN {
		2356	for my $signal (qw(INT HUP TERM)) {
		2357	Event->signal (
		2358	reentrant => 0,
		2359	data => WF_AUTOCANCEL,
		2360	signal => $signal,
		2361	prio => 0,
		2362	cb => sub {
		2363	cf::cleanup "SIG$signal";
		2364	},
		2365	);
		2366	}
		2367	}
		2368
		2369	sub emergency_save() {
		2370	my $freeze_guard = cf::freeze_mainloop;
		2371
		2372	warn "enter emergency perl save\n";
		2373
		2374	cf::sync_job {
		2375	# use a peculiar iteration method to avoid tripping on perl
		2376	# refcount bugs in for. also avoids problems with players
		2377	# and maps saved/destroyed asynchronously.
		2378	warn "begin emergency player save\n";
		2379	for my $login (keys %cf::PLAYER) {
		2380	my $pl = $cf::PLAYER{$login} or next;
		2381	$pl->valid or next;
		2382	$pl->save;
		2383	}
		2384	warn "end emergency player save\n";
		2385
		2386	warn "begin emergency map save\n";
		2387	for my $path (keys %cf::MAP) {
		2388	my $map = $cf::MAP{$path} or next;
		2389	$map->valid or next;
		2390	$map->save;
		2391	}
		2392	warn "end emergency map save\n";
		2393
		2394	warn "begin emergency database checkpoint\n";
		2395	BDB::db_env_txn_checkpoint $DB_ENV;
		2396	warn "end emergency database checkpoint\n";
		2397	};
		2398
		2399	warn "leave emergency perl save\n";
		2400	}
		2401
		2402	sub post_cleanup {
		2403	my ($make_core) = @_;
		2404
		2405	warn Carp::longmess "post_cleanup backtrace"
		2406	if $make_core;
		2407	}
		2408
1070	sub _perl_reload(&) {	2409	sub reload() {
1071	my ($msg) = @_;	2410	# can/must only be called in main
		2411	if ($Coro::current != $Coro::main) {
		2412	warn "can only reload from main coroutine";
		2413	return;
		2414	}
1072		2415
1073	$msg->("reloading...");	2416	warn "reloading...";
1074		2417
1075	eval {	2418	warn "entering sync_job";
1076	# cancel all watchers	2419
		2420	cf::sync_job {
		2421	cf::write_runtime; # external watchdog should not bark
		2422	cf::emergency_save;
		2423	cf::write_runtime; # external watchdog should not bark
		2424
		2425	warn "syncing database to disk";
		2426	BDB::db_env_txn_checkpoint $DB_ENV;
		2427
		2428	# if anything goes wrong in here, we should simply crash as we already saved
		2429
		2430	warn "cancelling all WF_AUTOCANCEL watchers";
1077	for (Event::all_watchers) {	2431	for (Event::all_watchers) {
1078	$_->cancel if $_->data & WF_AUTOCANCEL;	2432	$_->cancel if $_->data & WF_AUTOCANCEL;
1079	}	2433	}
1080		2434
1081	# unload all extensions	2435	warn "flushing outstanding aio requests";
1082	for (@exts) {	2436	for (;;) {
1083	$msg->("unloading <$_>");	2437	BDB::flush;
1084	unload_extension $_;	2438	IO::AIO::flush;
		2439	Coro::cede;
		2440	last unless IO::AIO::nreqs || BDB::nreqs;
		2441	warn "iterate...";
		2442	}
		2443
		2444	++$RELOAD;
		2445
		2446	warn "cancelling all extension coros";
		2447	$_->cancel for values %EXT_CORO;
		2448	%EXT_CORO = ();
		2449
		2450	warn "removing commands";
		2451	%COMMAND = ();
		2452
		2453	warn "removing ext commands";
		2454	%EXTCMD = ();
		2455
		2456	warn "unloading/nuking all extensions";
		2457	for my $pkg (@EXTS) {
		2458	warn "... unloading $pkg";
		2459
		2460	if (my $cb = $pkg->can ("unload")) {
		2461	eval {
		2462	$cb->($pkg);
		2463	1
		2464	} or warn "$pkg unloaded, but with errors: $@";
1085	}	2465	}
1086		2466
		2467	warn "... nuking $pkg";
		2468	Symbol::delete_package $pkg;
		2469	}
		2470
1087	# unload all modules loaded from $LIBDIR	2471	warn "unloading all perl modules loaded from $LIBDIR";
1088	while (my ($k, $v) = each %INC) {	2472	while (my ($k, $v) = each %INC) {
1089	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2473	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090		2474
1091	$msg->("removing <$k>");	2475	warn "... unloading $k";
1092	delete $INC{$k};	2476	delete $INC{$k};
1093		2477
1094	$k =~ s/\.pm$//;	2478	$k =~ s/\.pm$//;
1095	$k =~ s/\//::/g;	2479	$k =~ s/\//::/g;
1096		2480
…		…
1099	}	2483	}
1100		2484
1101	Symbol::delete_package $k;	2485	Symbol::delete_package $k;
1102	}	2486	}
1103		2487
1104	# sync database to disk
1105	cf::db_sync;
1106
1107	# get rid of safe::, as good as possible	2488	warn "getting rid of safe::, as good as possible";
1108	Symbol::delete_package "safe::$_"	2489	Symbol::delete_package "safe::$_"
1109	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2490	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110		2491
1111	# remove register_script_function callbacks
1112	# TODO
1113
1114	# unload cf.pm "a bit"	2492	warn "unloading cf.pm \"a bit\"";
1115	delete $INC{"cf.pm"};	2493	delete $INC{"cf.pm"};
1116		2494
1117	# don't, removes xs symbols, too,	2495	# don't, removes xs symbols, too,
1118	# and global variables created in xs	2496	# and global variables created in xs
1119	#Symbol::delete_package __PACKAGE__;	2497	#Symbol::delete_package __PACKAGE__;
1120		2498
1121	# reload cf.pm	2499	warn "unload completed, starting to reload now";
		2500
1122	$msg->("reloading cf.pm");	2501	warn "reloading cf.pm";
1123	require cf;	2502	require cf;
		2503	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124		2504
1125	# load config and database again	2505	warn "loading config and database again";
1126	cf::cfg_load;	2506	cf::cfg_load;
1127	cf::db_load;
1128		2507
1129	# load extensions	2508	warn "loading extensions";
1130	$msg->("load extensions");
1131	cf::load_extensions;	2509	cf::load_extensions;
1132		2510
1133	# reattach attachments to objects	2511	warn "reattaching attachments to objects/players";
1134	$msg->("reattach");	2512	_global_reattach; # objects, sockets
1135	_global_reattach;	2513	warn "reattaching attachments to maps";
		2514	reattach $_ for values %MAP;
		2515	warn "reattaching attachments to players";
		2516	reattach $_ for values %PLAYER;
		2517
		2518	warn "loading reloadable resources";
		2519	reload_resources;
		2520
		2521	warn "leaving sync_job";
		2522
		2523	1
		2524	} or do {
		2525	warn $@;
		2526	warn "error while reloading, exiting.";
		2527	exit 1;
1136	};	2528	};
1137	$msg->($@) if $@;
1138		2529
1139	$msg->("reloaded");	2530	warn "reloaded";
1140	};	2531	};
1141		2532
1142	sub perl_reload() {	2533	our $RELOAD_WATCHER; # used only during reload
1143	_perl_reload {
1144	warn $_[0];
1145	print "$_[0]\n";
1146	};
1147	}
1148		2534
1149	register "<global>", __PACKAGE__;
1150
1151	register_command "perl-reload" => sub {	2535	register_command "reload" => sub {
1152	my ($who, $arg) = @_;	2536	my ($who, $arg) = @_;
1153		2537
1154	if ($who->flag (FLAG_WIZ)) {	2538	if ($who->flag (FLAG_WIZ)) {
1155	_perl_reload {	2539	$who->message ("reloading server.");
1156	warn $_[0];	2540
1157	$who->message ($_[0]);	2541	# doing reload synchronously and two reloads happen back-to-back,
		2542	# coro crashes during coro_state_free->destroy here.
		2543
		2544	$RELOAD_WATCHER ||= Event->timer (
		2545	reentrant => 0,
		2546	after => 0,
		2547	data => WF_AUTOCANCEL,
		2548	cb => sub {
		2549	reload;
		2550	undef $RELOAD_WATCHER;
		2551	},
1158	};	2552	);
1159	}	2553	}
1160	};	2554	};
1161		2555
1162	unshift @INC, $LIBDIR;	2556	unshift @INC, $LIBDIR;
1163		2557
		2558	my $bug_warning = 0;
		2559
1164	$TICK_WATCHER = Event->timer (	2560	$TICK_WATCHER = Event->timer (
		2561	reentrant => 0,
		2562	parked => 1,
1165	prio => 0,	2563	prio => 0,
1166	at => $NEXT_TICK || 1,	2564	at => $NEXT_TICK || $TICK,
1167	data => WF_AUTOCANCEL,	2565	data => WF_AUTOCANCEL,
1168	cb => sub {	2566	cb => sub {
		2567	if ($Coro::current != $Coro::main) {
		2568	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2569	unless ++$bug_warning > 10;
		2570	return;
		2571	}
		2572
		2573	$NOW = Event::time;
		2574
1169	cf::server_tick; # one server iteration	2575	cf::server_tick; # one server iteration
1170		2576	$RUNTIME += $TICK;
1171	my $NOW = Event::time;
1172	$NEXT_TICK += $TICK;	2577	$NEXT_TICK += $TICK;
1173		2578
		2579	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2580	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2581	Coro::async_pool {
		2582	write_runtime
		2583	or warn "ERROR: unable to write runtime file: $!";
		2584	};
		2585	}
		2586
		2587	$WAIT_FOR_TICK->broadcast;
		2588	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2589
		2590	# my $AFTER = Event::time;
		2591	# warn $AFTER - $NOW;#d#
		2592
1174	# if we are delayed by four ticks or more, skip them all	2593	# if we are delayed by four ticks or more, skip them all
1175	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2594	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176		2595
1177	$TICK_WATCHER->at ($NEXT_TICK);	2596	$TICK_WATCHER->at ($NEXT_TICK);
1178	$TICK_WATCHER->start;	2597	$TICK_WATCHER->start;
1179	},	2598	},
1180	);	2599	);
1181		2600
		2601	{
		2602	BDB::max_poll_time $TICK * 0.1;
		2603	$BDB_POLL_WATCHER = Event->io (
		2604	reentrant => 0,
		2605	fd => BDB::poll_fileno,
		2606	poll => 'r',
		2607	prio => 0,
		2608	data => WF_AUTOCANCEL,
		2609	cb => \&BDB::poll_cb,
		2610	);
		2611	BDB::min_parallel 8;
		2612
		2613	BDB::set_sync_prepare {
		2614	my $status;
		2615	my $current = $Coro::current;
		2616	(
		2617	sub {
		2618	$status = $!;
		2619	$current->ready; undef $current;
		2620	},
		2621	sub {
		2622	Coro::schedule while defined $current;
		2623	$! = $status;
		2624	},
		2625	)
		2626	};
		2627
		2628	unless ($DB_ENV) {
		2629	$DB_ENV = BDB::db_env_create;
		2630
		2631	cf::sync_job {
		2632	eval {
		2633	BDB::db_env_open
		2634	$DB_ENV,
		2635	$BDB_ENV_DIR,
		2636	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2637	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2638	0666;
		2639
		2640	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2641
		2642	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2643	$DB_ENV->set_lk_detect;
		2644	};
		2645
		2646	cf::cleanup "db_env_open(db): $@" if $@;
		2647	};
		2648	}
		2649	}
		2650
		2651	{
		2652	IO::AIO::min_parallel 8;
		2653
		2654	undef $Coro::AIO::WATCHER;
1182	IO::AIO::max_poll_time $TICK * 0.2;	2655	IO::AIO::max_poll_time $TICK * 0.1;
1183		2656	$AIO_POLL_WATCHER = Event->io (
1184	Event->io (fd => IO::AIO::poll_fileno,	2657	reentrant => 0,
1185	poll => 'r',
1186	prio => 5,
1187	data => WF_AUTOCANCEL,	2658	data => WF_AUTOCANCEL,
		2659	fd => IO::AIO::poll_fileno,
		2660	poll => 'r',
		2661	prio => 6,
1188	cb => \&IO::AIO::poll_cb);	2662	cb => \&IO::AIO::poll_cb,
		2663	);
		2664	}
		2665
		2666	END { cf::emergency_save }
1189		2667
1190	1	2668	1
1191		2669

Diff Legend

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