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.233 by root, Wed Apr 4 02:20:27 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
		376	}
		377
		378	=item cf::datalog type => key => value, ...
		379
		380	Log a datalog packet of the given type with the given key-value pairs.
		381
		382	=cut
		383
		384	sub datalog($@) {
		385	my ($type, %kv) = @_;
		386	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
135	}	387	}
136		388
137	=back	389	=back
138		390
139	=cut	391	=cut
…		…
249	my ($self, $victim) = @_;	501	my ($self, $victim) = @_;
250	...	502	...
251	}	503	}
252	}	504	}
253		505
		506	=item $attachable->valid
		507
		508	Just because you have a perl object does not mean that the corresponding
		509	C-level object still exists. If you try to access an object that has no
		510	valid C counterpart anymore you get an exception at runtime. This method
		511	can be used to test for existence of the C object part without causing an
		512	exception.
		513
254	=cut	514	=cut
255		515
256	# the following variables are defined in .xs and must not be re-created	516	# the following variables are defined in .xs and must not be re-created
257	our @CB_GLOBAL = (); # registry for all global events	517	our @CB_GLOBAL = (); # registry for all global events
		518	our @CB_ATTACHABLE = (); # registry for all attachables
258	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	519	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259	our @CB_PLAYER = ();	520	our @CB_PLAYER = ();
260	our @CB_CLIENT = ();	521	our @CB_CLIENT = ();
261	our @CB_TYPE = (); # registry for type (cf-object class) based events	522	our @CB_TYPE = (); # registry for type (cf-object class) based events
262	our @CB_MAP = ();	523	our @CB_MAP = ();
263		524
264	my %attachment;	525	my %attachment;
		526
		527	sub cf::attachable::thawer_merge {
		528	# simply override everything except _meta
		529	local $_[0]{_meta};
		530	%{$_[0]} = %{$_[1]};
		531	}
265		532
266	sub _attach_cb($$$$) {	533	sub _attach_cb($$$$) {
267	my ($registry, $event, $prio, $cb) = @_;	534	my ($registry, $event, $prio, $cb) = @_;
268		535
269	use sort 'stable';	536	use sort 'stable';
…		…
272		539
273	@{$registry->[$event]} = sort	540	@{$registry->[$event]} = sort
274	{ $a->[0] cmp $b->[0] }	541	{ $a->[0] cmp $b->[0] }
275	@{$registry->[$event] || []}, $cb;	542	@{$registry->[$event] || []}, $cb;
276	}	543	}
		544
		545	# hack
		546	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277		547
278	# attach handles attaching event callbacks	548	# attach handles attaching event callbacks
279	# the only thing the caller has to do is pass the correct	549	# the only thing the caller has to do is pass the correct
280	# registry (== where the callback attaches to).	550	# registry (== where the callback attaches to).
281	sub _attach {	551	sub _attach {
…		…
283		553
284	my $object_type;	554	my $object_type;
285	my $prio = 0;	555	my $prio = 0;
286	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	556	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287		557
		558	#TODO: get rid of this hack
		559	if ($attachable_klass{$klass}) {
		560	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		561	}
		562
288	while (@arg) {	563	while (@arg) {
289	my $type = shift @arg;	564	my $type = shift @arg;
290		565
291	if ($type eq "prio") {	566	if ($type eq "prio") {
292	$prio = shift @arg;	567	$prio = shift @arg;
…		…
367	my ($obj, $name) = @_;	642	my ($obj, $name) = @_;
368		643
369	exists $obj->{_attachment}{$name}	644	exists $obj->{_attachment}{$name}
370	}	645	}
371		646
372	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	647	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373	eval "#line " . __LINE__ . " 'cf.pm'	648	eval "#line " . __LINE__ . " 'cf.pm'
374	sub cf::\L$klass\E::_attach_registry {	649	sub cf::\L$klass\E::_attach_registry {
375	(\\\@CB_$klass, KLASS_$klass)	650	(\\\@CB_$klass, KLASS_$klass)
376	}	651	}
377		652
…		…
413	}	688	}
414		689
415	0	690	0
416	}	691	}
417		692
418	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	693	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419		694
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, ...)	695	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425		696
426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428	Generate a global/object/player/map-specific event with the given arguments.	697	Generate an object-specific event with the given arguments.
429		698
430	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	699	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	700	removed in future versions), and there is no public API to access override
432	results (if you must, access C<@cf::invoke_results> directly).	701	results (if you must, access C<@cf::invoke_results> directly).
433		702
434	=back	703	=back
435		704
436	=cut	705	=cut
437		706
438	#############################################################################	707	#############################################################################
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	708	# object support
460		709
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 {	710	sub reattach {
		711	# basically do the same as instantiate, without calling instantiate
475	my ($obj) = @_;	712	my ($obj) = @_;
		713
		714	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		715
476	my $registry = $obj->registry;	716	my $registry = $obj->registry;
477		717
478	@$registry = ();	718	@$registry = ();
479		719
480	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	720	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
489	warn "object uses attachment '$name' that is not available, postponing.\n";	729	warn "object uses attachment '$name' that is not available, postponing.\n";
490	}	730	}
491	}	731	}
492	}	732	}
493		733
494	sub object_freezer_save {	734	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,	735	prio => -1000000,
		736	on_instantiate => sub {
		737	my ($obj, $data) = @_;
		738
		739	$data = from_json $data;
		740
		741	for (@$data) {
		742	my ($name, $args) = @$_;
		743
		744	$obj->attach ($name, %{$args || {} });
		745	}
		746	},
		747	on_reattach => \&reattach,
554	on_clone => sub {	748	on_clone => sub {
555	my ($src, $dst) = @_;	749	my ($src, $dst) = @_;
556		750
557	@{$dst->registry} = @{$src->registry};	751	@{$dst->registry} = @{$src->registry};
558		752
…		…
561	%{$dst->{_attachment}} = %{$src->{_attachment}}	755	%{$dst->{_attachment}} = %{$src->{_attachment}}
562	if exists $src->{_attachment};	756	if exists $src->{_attachment};
563	},	757	},
564	);	758	);
565		759
		760	sub object_freezer_save {
		761	my ($filename, $rdata, $objs) = @_;
		762
		763	sync_job {
		764	if (length $$rdata) {
		765	warn sprintf "saving %s (%d,%d)\n",
		766	$filename, length $$rdata, scalar @$objs;
		767
		768	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		769	chmod SAVE_MODE, $fh;
		770	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		771	aio_fsync $fh if $cf::USE_FSYNC;
		772	close $fh;
		773
		774	if (@$objs) {
		775	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		776	chmod SAVE_MODE, $fh;
		777	my $data = Storable::nfreeze { version => 1, objs => $objs };
		778	aio_write $fh, 0, (length $data), $data, 0;
		779	aio_fsync $fh if $cf::USE_FSYNC;
		780	close $fh;
		781	aio_rename "$filename.pst~", "$filename.pst";
		782	}
		783	} else {
		784	aio_unlink "$filename.pst";
		785	}
		786
		787	aio_rename "$filename~", $filename;
		788	} else {
		789	warn "FATAL: $filename~: $!\n";
		790	}
		791	} else {
		792	aio_unlink $filename;
		793	aio_unlink "$filename.pst";
		794	}
		795	}
		796	}
		797
		798	sub object_freezer_as_string {
		799	my ($rdata, $objs) = @_;
		800
		801	use Data::Dumper;
		802
		803	$$rdata . Dumper $objs
		804	}
		805
		806	sub object_thawer_load {
		807	my ($filename) = @_;
		808
		809	my ($data, $av);
		810
		811	(aio_load $filename, $data) >= 0
		812	or return;
		813
		814	unless (aio_stat "$filename.pst") {
		815	(aio_load "$filename.pst", $av) >= 0
		816	or return;
		817	$av = eval { (Storable::thaw $av)->{objs} };
		818	}
		819
		820	warn sprintf "loading %s (%d)\n",
		821	$filename, length $data, scalar @{$av || []};#d#
		822	return ($data, $av);
		823	}
		824
566	#############################################################################	825	#############################################################################
567	# command handling &c	826	# command handling &c
568		827
569	=item cf::register_command $name => \&callback($ob,$args);	828	=item cf::register_command $name => \&callback($ob,$args);
570		829
…		…
592	=cut	851	=cut
593		852
594	sub register_extcmd {	853	sub register_extcmd {
595	my ($name, $cb) = @_;	854	my ($name, $cb) = @_;
596		855
597	my $caller = caller;
598	#warn "registering extcmd '$name' to '$caller'";
599
600	$EXTCMD{$name} = [$cb, $caller];	856	$EXTCMD{$name} = $cb;
601	}	857	}
602		858
603	cf::player->attach (	859	cf::player->attach (
604	on_command => sub {	860	on_command => sub {
605	my ($pl, $name, $params) = @_;	861	my ($pl, $name, $params) = @_;
…		…
618		874
619	my $msg = eval { from_json $buf };	875	my $msg = eval { from_json $buf };
620		876
621	if (ref $msg) {	877	if (ref $msg) {
622	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	878	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623	if (my %reply = $cb->[0]->($pl, $msg)) {	879	if (my %reply = $cb->($pl, $msg)) {
624	$pl->ext_reply ($msg->{msgid}, %reply);	880	$pl->ext_reply ($msg->{msgid}, %reply);
625	}	881	}
626	}	882	}
627	} else {	883	} else {
628	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	884	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
630		886
631	cf::override;	887	cf::override;
632	},	888	},
633	);	889	);
634		890
635	sub register {
636	my ($base, $pkg) = @_;
637
638	#TODO
639	}
640
641	sub load_extension {	891	sub load_extension {
642	my ($path) = @_;	892	my ($path) = @_;
643		893
644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	894	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
645	my $base = $1;	895	my $base = $1;
646	my $pkg = $1;	896	my $pkg = $1;
647	$pkg =~ s/[^[:word:]]/_/g;	897	$pkg =~ s/[^[:word:]]/_/g;
648	$pkg = "ext::$pkg";	898	$pkg = "ext::$pkg";
649		899
650	warn "loading '$path' into '$pkg'\n";	900	warn "... loading '$path' into '$pkg'\n";
651		901
652	open my $fh, "<:utf8", $path	902	open my $fh, "<:utf8", $path
653	or die "$path: $!";	903	or die "$path: $!";
654		904
655	my $source =	905	my $source =
656	"package $pkg; use strict; use utf8;\n"	906	"package $pkg; use strict; use utf8;\n"
657	. "#line 1 \"$path\"\n{\n"	907	. "#line 1 \"$path\"\n{\n"
658	. (do { local $/; <$fh> })	908	. (do { local $/; <$fh> })
659	. "\n};\n1";	909	. "\n};\n1";
660		910
661	eval $source	911	unless (eval $source) {
662	or die $@ ? "$path: $@\n"	912	my $msg = $@ ? "$path: $@\n"
663	: "extension disabled.\n";	913	: "extension disabled.\n";
664		914	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665	push @exts, $pkg;	915	warn $@;
666	$ext_pkg{$base} = $pkg;	916	warn "mandatory extension failed to load, exiting.\n";
667		917	exit 1;
668	# no strict 'refs';	918	}
669	# @{"$pkg\::ISA"} = ext::;	919	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	# }	920	}
684		921
685	# remove commands	922	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	}	923	}
710		924
711	sub load_extensions {	925	sub load_extensions {
712	for my $ext (<$LIBDIR/*.ext>) {	926	for my $ext (<$LIBDIR/*.ext>) {
713	next unless -r $ext;	927	next unless -r $ext;
…		…
717	} or warn "$ext not loaded: $@";	931	} or warn "$ext not loaded: $@";
718	}	932	}
719	}	933	}
720		934
721	#############################################################################	935	#############################################################################
722	# load/save/clean perl data associated with a map
723		936
724	*cf::mapsupport::on_clean = sub {	937	=head2 CORE EXTENSIONS
		938
		939	Functions and methods that extend core crossfire objects.
		940
		941	=cut
		942
		943	package cf::player;
		944
		945	use Coro::AIO;
		946
		947	=head3 cf::player
		948
		949	=over 4
		950
		951	=item cf::player::find $login
		952
		953	Returns the given player object, loading it if necessary (might block).
		954
		955	=cut
		956
		957	sub playerdir($) {
		958	cf::localdir
		959	. "/"
		960	. cf::playerdir
		961	. "/"
		962	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		963	}
		964
		965	sub path($) {
		966	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		967
		968	(playerdir $login) . "/$login.pl"
		969	}
		970
		971	sub find_active($) {
		972	$cf::PLAYER{$_[0]}
		973	and $cf::PLAYER{$_[0]}->active
		974	and $cf::PLAYER{$_[0]}
		975	}
		976
		977	sub exists($) {
		978	my ($login) = @_;
		979
		980	$cf::PLAYER{$login}
		981	or cf::sync_job { !aio_stat path $login }
		982	}
		983
		984	sub find($) {
		985	return $cf::PLAYER{$_[0]} || do {
		986	my $login = $_[0];
		987
		988	my $guard = cf::lock_acquire "user_find:$login";
		989
		990	$cf::PLAYER{$_[0]} || do {
		991	my $pl = load_pl path $login
		992	or return;
		993	$cf::PLAYER{$login} = $pl
		994	}
		995	}
		996	}
		997
		998	sub save($) {
		999	my ($pl) = @_;
		1000
		1001	return if $pl->{deny_save};
		1002
		1003	my $path = path $pl;
		1004	my $guard = cf::lock_acquire "user_save:$path";
		1005
		1006	return if $pl->{deny_save};
		1007
		1008	aio_mkdir playerdir $pl, 0770;
		1009	$pl->{last_save} = $cf::RUNTIME;
		1010
		1011	$pl->save_pl ($path);
		1012	Coro::cede;
		1013	}
		1014
		1015	sub new($) {
		1016	my ($login) = @_;
		1017
		1018	my $self = create;
		1019
		1020	$self->ob->name ($login);
		1021	$self->{deny_save} = 1;
		1022
		1023	$cf::PLAYER{$login} = $self;
		1024
		1025	$self
		1026	}
		1027
		1028	=item $pl->quit_character
		1029
		1030	Nukes the player without looking back. If logged in, the connection will
		1031	be destroyed. May block for a long time.
		1032
		1033	=cut
		1034
		1035	sub quit_character {
		1036	my ($pl) = @_;
		1037
		1038	my $name = $pl->ob->name;
		1039
		1040	$pl->{deny_save} = 1;
		1041	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1042
		1043	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1044	$pl->deactivate;
		1045	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1046	$pl->ns->destroy if $pl->ns;
		1047
		1048	my $path = playerdir $pl;
		1049	my $temp = "$path~$cf::RUNTIME~deleting~";
		1050	aio_rename $path, $temp;
		1051	delete $cf::PLAYER{$pl->ob->name};
		1052	$pl->destroy;
		1053
		1054	my $prefix = qr<^~\Q$name\E/>;
		1055
		1056	# nuke player maps
		1057	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1058
		1059	IO::AIO::aio_rmtree $temp;
		1060	}
		1061
		1062	=item $pl->kick
		1063
		1064	Kicks a player out of the game. This destroys the connection.
		1065
		1066	=cut
		1067
		1068	sub kick {
		1069	my ($pl, $kicker) = @_;
		1070
		1071	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1072	$pl->killer ("kicked");
		1073	$pl->ns->destroy;
		1074	}
		1075
		1076	=item cf::player::list_logins
		1077
		1078	Returns am arrayref of all valid playernames in the system, can take a
		1079	while and may block, so not sync_job-capable, ever.
		1080
		1081	=cut
		1082
		1083	sub list_logins {
		1084	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1085	or return [];
		1086
		1087	my @logins;
		1088
		1089	for my $login (@$dirs) {
		1090	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1091	aio_read $fh, 0, 512, my $buf, 0 or next;
		1092	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1093
		1094	utf8::decode $login;
		1095	push @logins, $login;
		1096	}
		1097
		1098	\@logins
		1099	}
		1100
		1101	=item $player->maps
		1102
		1103	Returns an arrayref of map paths that are private for this
		1104	player. May block.
		1105
		1106	=cut
		1107
		1108	sub maps($) {
		1109	my ($pl) = @_;
		1110
		1111	$pl = ref $pl ? $pl->ob->name : $pl;
		1112
		1113	my $files = aio_readdir playerdir $pl
		1114	or return;
		1115
		1116	my @paths;
		1117
		1118	for (@$files) {
		1119	utf8::decode $_;
		1120	next if /\.(?:pl|pst)$/;
		1121	next unless /^$PATH_SEP/o;
		1122
		1123	push @paths, cf::map::normalise "~$pl/$_";
		1124	}
		1125
		1126	\@paths
		1127	}
		1128
		1129	=item $player->ext_reply ($msgid, %msg)
		1130
		1131	Sends an ext reply to the player.
		1132
		1133	=cut
		1134
		1135	sub ext_reply($$%) {
		1136	my ($self, $id, %msg) = @_;
		1137
		1138	$msg{msgid} = $id;
		1139
		1140	$self->send ("ext " . cf::to_json \%msg);
		1141	}
		1142
		1143	=item $player->ext_event ($type, %msg)
		1144
		1145	Sends an ext event to the client.
		1146
		1147	=cut
		1148
		1149	sub ext_event($$%) {
		1150	my ($self, $type, %msg) = @_;
		1151
		1152	$self->ns->ext_event ($type, %msg);
		1153	}
		1154
		1155	package cf;
		1156
		1157	=back
		1158
		1159
		1160	=head3 cf::map
		1161
		1162	=over 4
		1163
		1164	=cut
		1165
		1166	package cf::map;
		1167
		1168	use Fcntl;
		1169	use Coro::AIO;
		1170
		1171	use overload
		1172	'""' => \&as_string,
		1173	fallback => 1;
		1174
		1175	our $MAX_RESET = 3600;
		1176	our $DEFAULT_RESET = 3000;
		1177
		1178	sub generate_random_map {
		1179	my ($self, $rmp) = @_;
		1180	# mit "rum" bekleckern, nicht
		1181	$self->_create_random_map (
		1182	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1183	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1184	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1185	$rmp->{exit_on_final_map},
		1186	$rmp->{xsize}, $rmp->{ysize},
		1187	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1188	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1189	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1190	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1191	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1192	(cf::region::find $rmp->{region}), $rmp->{custom}
		1193	)
		1194	}
		1195
		1196	=item cf::map->register ($regex, $prio)
		1197
		1198	Register a handler for the map path matching the given regex at the
		1199	givne priority (higher is better, built-in handlers have priority 0, the
		1200	default).
		1201
		1202	=cut
		1203
		1204	sub register {
		1205	my (undef, $regex, $prio) = @_;
		1206	my $pkg = caller;
		1207
		1208	no strict;
		1209	push @{"$pkg\::ISA"}, __PACKAGE__;
		1210
		1211	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1212	}
		1213
		1214	# also paths starting with '/'
		1215	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1216
		1217	sub thawer_merge {
		1218	my ($self, $merge) = @_;
		1219
		1220	# we have to keep some variables in memory intact
		1221	local $self->{path};
		1222	local $self->{load_path};
		1223	local $self->{deny_save};
		1224	local $self->{deny_reset};
		1225
		1226	$self->SUPER::thawer_merge ($merge);
		1227	}
		1228
		1229	sub normalise {
		1230	my ($path, $base) = @_;
		1231
		1232	$path = "$path"; # make sure its a string
		1233
		1234	$path =~ s/\.map$//;
		1235
		1236	# map plan:
		1237	#
		1238	# /! non-realised random map exit (special hack!)
		1239	# {... are special paths that are not being touched
		1240	# ?xxx/... are special absolute paths
		1241	# ?random/... random maps
		1242	# /... normal maps
		1243	# ~user/... per-player map of a specific user
		1244
		1245	$path =~ s/$PATH_SEP/\//go;
		1246
		1247	# treat it as relative path if it starts with
		1248	# something that looks reasonable
		1249	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1250	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1251
		1252	$base =~ s{[^/]+/?$}{};
		1253	$path = "$base/$path";
		1254	}
		1255
		1256	for ($path) {
		1257	redo if s{//}{/};
		1258	redo if s{/\.?/}{/};
		1259	redo if s{/[^/]+/\.\./}{/};
		1260	}
		1261
		1262	$path
		1263	}
		1264
		1265	sub new_from_path {
		1266	my (undef, $path, $base) = @_;
		1267
		1268	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1269
		1270	$path = normalise $path, $base;
		1271
		1272	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1273	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1274	my $self = bless cf::map::new, $pkg;
		1275	$self->{path} = $path; $self->path ($path);
		1276	$self->init; # pass $1 etc.
		1277	return $self;
		1278	}
		1279	}
		1280
		1281	Carp::carp "unable to resolve path '$path' (base '$base').";
		1282	()
		1283	}
		1284
		1285	sub init {
		1286	my ($self) = @_;
		1287
		1288	$self
		1289	}
		1290
		1291	sub as_string {
		1292	my ($self) = @_;
		1293
		1294	"$self->{path}"
		1295	}
		1296
		1297	# the displayed name, this is a one way mapping
		1298	sub visible_name {
		1299	&as_string
		1300	}
		1301
		1302	# the original (read-only) location
		1303	sub load_path {
		1304	my ($self) = @_;
		1305
		1306	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1307	}
		1308
		1309	# the temporary/swap location
		1310	sub save_path {
		1311	my ($self) = @_;
		1312
		1313	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1314	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1315	}
		1316
		1317	# the unique path, undef == no special unique path
		1318	sub uniq_path {
		1319	my ($self) = @_;
		1320
		1321	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1322	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1323	}
		1324
		1325	# and all this just because we cannot iterate over
		1326	# all maps in C++...
		1327	sub change_all_map_light {
		1328	my ($change) = @_;
		1329
		1330	$_->change_map_light ($change)
		1331	for grep $_->outdoor, values %cf::MAP;
		1332	}
		1333
		1334	sub unlink_save {
		1335	my ($self) = @_;
		1336
		1337	utf8::encode (my $save = $self->save_path);
		1338	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1339	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1340	}
		1341
		1342	sub load_header_from($) {
		1343	my ($self, $path) = @_;
		1344
		1345	utf8::encode $path;
		1346	#aio_open $path, O_RDONLY, 0
		1347	# or return;
		1348
		1349	$self->_load_header ($path)
		1350	or return;
		1351
		1352	$self->{load_path} = $path;
		1353
		1354	1
		1355	}
		1356
		1357	sub load_header_orig {
		1358	my ($self) = @_;
		1359
		1360	$self->load_header_from ($self->load_path)
		1361	}
		1362
		1363	sub load_header_temp {
		1364	my ($self) = @_;
		1365
		1366	$self->load_header_from ($self->save_path)
		1367	}
		1368
		1369	sub prepare_temp {
		1370	my ($self) = @_;
		1371
		1372	$self->last_access ((delete $self->{last_access})
		1373	|| $cf::RUNTIME); #d#
		1374	# safety
		1375	$self->{instantiate_time} = $cf::RUNTIME
		1376	if $self->{instantiate_time} > $cf::RUNTIME;
		1377	}
		1378
		1379	sub prepare_orig {
		1380	my ($self) = @_;
		1381
		1382	$self->{load_original} = 1;
		1383	$self->{instantiate_time} = $cf::RUNTIME;
		1384	$self->last_access ($cf::RUNTIME);
		1385	$self->instantiate;
		1386	}
		1387
		1388	sub load_header {
		1389	my ($self) = @_;
		1390
		1391	if ($self->load_header_temp) {
		1392	$self->prepare_temp;
		1393	} else {
		1394	$self->load_header_orig
		1395	or return;
		1396	$self->prepare_orig;
		1397	}
		1398
		1399	1
		1400	}
		1401
		1402	sub find;
		1403	sub find {
		1404	my ($path, $origin) = @_;
		1405
		1406	$path = normalise $path, $origin && $origin->path;
		1407
		1408	cf::lock_wait "map_find:$path";
		1409
		1410	$cf::MAP{$path} || do {
		1411	my $guard = cf::lock_acquire "map_find:$path";
		1412	my $map = new_from_path cf::map $path
		1413	or return;
		1414
		1415	$map->{last_save} = $cf::RUNTIME;
		1416
		1417	$map->load_header
		1418	or return;
		1419
		1420	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1421	# doing this can freeze the server in a sync job, obviously
		1422	#$cf::WAIT_FOR_TICK->wait;
		1423	$map->reset;
		1424	undef $guard;
		1425	return find $path;
		1426	}
		1427
		1428	$cf::MAP{$path} = $map
		1429	}
		1430	}
		1431
		1432	sub pre_load { }
		1433	sub post_load { }
		1434
		1435	sub load {
		1436	my ($self) = @_;
		1437
		1438	local $self->{deny_reset} = 1; # loading can take a long time
		1439
		1440	my $path = $self->{path};
		1441	my $guard = cf::lock_acquire "map_load:$path";
		1442
		1443	return if $self->in_memory != cf::MAP_SWAPPED;
		1444
		1445	$self->in_memory (cf::MAP_LOADING);
		1446
		1447	$self->alloc;
		1448
		1449	$self->pre_load;
		1450
		1451	$self->_load_objects ($self->{load_path}, 1)
		1452	or return;
		1453
		1454	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1455	if delete $self->{load_original};
		1456
		1457	if (my $uniq = $self->uniq_path) {
		1458	utf8::encode $uniq;
		1459	if (aio_open $uniq, O_RDONLY, 0) {
		1460	$self->clear_unique_items;
		1461	$self->_load_objects ($uniq, 0);
		1462	}
		1463	}
		1464
		1465	Coro::cede;
		1466
		1467	# now do the right thing for maps
		1468	$self->link_multipart_objects;
		1469
		1470	unless ($self->{deny_activate}) {
		1471	$self->decay_objects;
		1472	$self->fix_auto_apply;
		1473	$self->update_buttons;
		1474	Coro::cede;
		1475	$self->set_darkness_map;
		1476	$self->difficulty ($self->estimate_difficulty)
		1477	unless $self->difficulty;
		1478	Coro::cede;
		1479	$self->activate;
		1480	}
		1481
		1482	$self->post_load;
		1483
		1484	$self->in_memory (cf::MAP_IN_MEMORY);
		1485	}
		1486
		1487	sub customise_for {
		1488	my ($self, $ob) = @_;
		1489
		1490	return find "~" . $ob->name . "/" . $self->{path}
		1491	if $self->per_player;
		1492
		1493	$self
		1494	}
		1495
		1496	# find and load all maps in the 3x3 area around a map
		1497	sub load_diag {
725	my ($map) = @_;	1498	my ($map) = @_;
726		1499
727	my $path = $map->tmpname;	1500	my @diag; # diagonal neighbours
728	defined $path or return;
729		1501
730	unlink "$path.pst";	1502	for (0 .. 3) {
731	};	1503	my $neigh = $map->tile_path ($_)
		1504	or next;
		1505	$neigh = find $neigh, $map
		1506	or next;
		1507	$neigh->load;
732		1508
733	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1509	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1510	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1511	}
734		1512
735	#############################################################################	1513	for (@diag) {
736	# load/save perl data associated with player->ob objects	1514	my $neigh = find @$_
737		1515	or next;
738	sub all_objects(@) {	1516	$neigh->load;
739	@_, map all_objects ($_->inv), @_	1517	}
740	}	1518	}
741		1519
742	# TODO: compatibility cruft, remove when no longer needed	1520	sub find_sync {
743	cf::player->attach (	1521	my ($path, $origin) = @_;
744	on_load => sub {
745	my ($pl, $path) = @_;
746		1522
747	for my $o (all_objects $pl->ob) {	1523	cf::sync_job { find $path, $origin }
748	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1524	}
749	$o->set_ob_key_value ("_perl_data");
750		1525
751	%$o = %{ Storable::thaw pack "H*", $value };	1526	sub do_load_sync {
		1527	my ($map) = @_;
		1528
		1529	cf::sync_job { $map->load };
		1530	}
		1531
		1532	our %MAP_PREFETCH;
		1533	our $MAP_PREFETCHER = undef;
		1534
		1535	sub find_async {
		1536	my ($path, $origin) = @_;
		1537
		1538	$path = normalise $path, $origin && $origin->{path};
		1539
		1540	if (my $map = $cf::MAP{$path}) {
		1541	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1542	}
		1543
		1544	undef $MAP_PREFETCH{$path};
		1545	$MAP_PREFETCHER ||= cf::async {
		1546	while (%MAP_PREFETCH) {
		1547	for my $path (keys %MAP_PREFETCH) {
		1548	my $map = find $path
		1549	or next;
		1550	$map->load;
		1551
		1552	delete $MAP_PREFETCH{$path};
752	}	1553	}
753	}	1554	}
		1555	undef $MAP_PREFETCHER;
		1556	};
		1557	$MAP_PREFETCHER->prio (6);
		1558
		1559	()
		1560	}
		1561
		1562	sub save {
		1563	my ($self) = @_;
		1564
		1565	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1566
		1567	$self->{last_save} = $cf::RUNTIME;
		1568
		1569	return unless $self->dirty;
		1570
		1571	my $save = $self->save_path; utf8::encode $save;
		1572	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1573
		1574	$self->{load_path} = $save;
		1575
		1576	return if $self->{deny_save};
		1577
		1578	local $self->{last_access} = $self->last_access;#d#
		1579
		1580	cf::async {
		1581	$_->contr->save for $self->players;
		1582	};
		1583
		1584	if ($uniq) {
		1585	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1586	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1587	} else {
		1588	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754	},	1589	}
755	);	1590	}
756		1591
757	#############################################################################	1592	sub swap_out {
		1593	my ($self) = @_;
758		1594
759	=head2 CORE EXTENSIONS	1595	# save first because save cedes
		1596	$self->save;
760		1597
761	Functions and methods that extend core crossfire objects.	1598	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1599
		1600	return if $self->players;
		1601	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1602	return if $self->{deny_save};
		1603
		1604	$self->clear;
		1605	$self->in_memory (cf::MAP_SWAPPED);
		1606	}
		1607
		1608	sub reset_at {
		1609	my ($self) = @_;
		1610
		1611	# TODO: safety, remove and allow resettable per-player maps
		1612	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1613	return 1e99 if $self->{deny_reset};
		1614
		1615	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1616	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1617
		1618	$time + $to
		1619	}
		1620
		1621	sub should_reset {
		1622	my ($self) = @_;
		1623
		1624	$self->reset_at <= $cf::RUNTIME
		1625	}
		1626
		1627	sub reset {
		1628	my ($self) = @_;
		1629
		1630	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1631
		1632	return if $self->players;
		1633	return if $self->isa ("ext::map_per_player");#d#
		1634
		1635	warn "resetting map ", $self->path;#d#
		1636
		1637	$self->in_memory (cf::MAP_SWAPPED);
		1638
		1639	# need to save uniques path
		1640	unless ($self->{deny_save}) {
		1641	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1642
		1643	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1644	if $uniq;
		1645	}
		1646
		1647	delete $cf::MAP{$self->path};
		1648
		1649	$self->clear;
		1650
		1651	$_->clear_links_to ($self) for values %cf::MAP;
		1652
		1653	$self->unlink_save;
		1654	$self->destroy;
		1655	}
		1656
		1657	my $nuke_counter = "aaaa";
		1658
		1659	sub nuke {
		1660	my ($self) = @_;
		1661
		1662	delete $cf::MAP{$self->path};
		1663
		1664	$self->unlink_save;
		1665
		1666	bless $self, "cf::map";
		1667	delete $self->{deny_reset};
		1668	$self->{deny_save} = 1;
		1669	$self->reset_timeout (1);
		1670	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1671
		1672	$cf::MAP{$self->path} = $self;
		1673
		1674	$self->reset; # polite request, might not happen
		1675	}
		1676
		1677	=item cf::map::unique_maps
		1678
		1679	Returns an arrayref of paths of all shared maps that have
		1680	instantiated unique items. May block.
		1681
		1682	=cut
		1683
		1684	sub unique_maps() {
		1685	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1686	or return;
		1687
		1688	my @paths;
		1689
		1690	for (@$files) {
		1691	utf8::decode $_;
		1692	next if /\.pst$/;
		1693	next unless /^$PATH_SEP/o;
		1694
		1695	push @paths, cf::map::normalise $_;
		1696	}
		1697
		1698	\@paths
		1699	}
		1700
		1701	package cf;
		1702
		1703	=back
		1704
		1705	=head3 cf::object
		1706
		1707	=cut
		1708
		1709	package cf::object;
762		1710
763	=over 4	1711	=over 4
764		1712
765	=item cf::player::exists $login	1713	=item $ob->inv_recursive
766		1714
767	Returns true when the given account exists.	1715	Returns the inventory of the object _and_ their inventories, recursively.
768		1716
769	=cut	1717	=cut
770		1718
771	sub cf::player::exists($) {	1719	sub inv_recursive_;
772	cf::player::find $_[0]	1720	sub inv_recursive_ {
773	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1721	map { $_, inv_recursive_ $_->inv } @_
774	}	1722	}
		1723
		1724	sub inv_recursive {
		1725	inv_recursive_ inv $_[0]
		1726	}
		1727
		1728	package cf;
		1729
		1730	=back
		1731
		1732	=head3 cf::object::player
		1733
		1734	=over 4
775		1735
776	=item $player_object->reply ($npc, $msg[, $flags])	1736	=item $player_object->reply ($npc, $msg[, $flags])
777		1737
778	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1738	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	1739	can be C<undef>. Does the right thing when the player is currently in a
…		…
781		1741
782	=cut	1742	=cut
783		1743
784	# rough implementation of a future "reply" method that works	1744	# rough implementation of a future "reply" method that works
785	# with dialog boxes.	1745	# with dialog boxes.
		1746	#TODO: the first argument must go, split into a $npc->reply_to ( method
786	sub cf::object::player::reply($$$;$) {	1747	sub cf::object::player::reply($$$;$) {
787	my ($self, $npc, $msg, $flags) = @_;	1748	my ($self, $npc, $msg, $flags) = @_;
788		1749
789	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1750	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790		1751
…		…
794	$msg = $npc->name . " says: $msg" if $npc;	1755	$msg = $npc->name . " says: $msg" if $npc;
795	$self->message ($msg, $flags);	1756	$self->message ($msg, $flags);
796	}	1757	}
797	}	1758	}
798		1759
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")	1760	=item $player_object->may ("access")
814		1761
815	Returns wether the given player is authorized to access resource "access"	1762	Returns wether the given player is authorized to access resource "access"
816	(e.g. "command_wizcast").	1763	(e.g. "command_wizcast").
817		1764
…		…
824	(ref $cf::CFG{"may_$access"}	1771	(ref $cf::CFG{"may_$access"}
825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1772	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826	: $cf::CFG{"may_$access"})	1773	: $cf::CFG{"may_$access"})
827	}	1774	}
828		1775
829	=cut	1776	=item $player_object->enter_link
830		1777
831	#############################################################################	1778	Freezes the player and moves him/her to a special map (C<{link}>).
		1779
		1780	The player should be reasonably safe there for short amounts of time. You
		1781	I<MUST> call C<leave_link> as soon as possible, though.
		1782
		1783	Will never block.
		1784
		1785	=item $player_object->leave_link ($map, $x, $y)
		1786
		1787	Moves the player out of the special C<{link}> map onto the specified
		1788	map. If the map is not valid (or omitted), the player will be moved back
		1789	to the location he/she was before the call to C<enter_link>, or, if that
		1790	fails, to the emergency map position.
		1791
		1792	Might block.
		1793
		1794	=cut
		1795
		1796	sub link_map {
		1797	unless ($LINK_MAP) {
		1798	$LINK_MAP = cf::map::find "{link}"
		1799	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1800	$LINK_MAP->load;
		1801	}
		1802
		1803	$LINK_MAP
		1804	}
		1805
		1806	sub cf::object::player::enter_link {
		1807	my ($self) = @_;
		1808
		1809	$self->deactivate_recursive;
		1810
		1811	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1812
		1813	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1814	if $self->map;
		1815
		1816	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1817	}
		1818
		1819	sub cf::object::player::leave_link {
		1820	my ($self, $map, $x, $y) = @_;
		1821
		1822	my $link_pos = delete $self->{_link_pos};
		1823
		1824	unless ($map) {
		1825	# restore original map position
		1826	($map, $x, $y) = @{ $link_pos || [] };
		1827	$map = cf::map::find $map;
		1828
		1829	unless ($map) {
		1830	($map, $x, $y) = @$EMERGENCY_POSITION;
		1831	$map = cf::map::find $map
		1832	or die "FATAL: cannot load emergency map\n";
		1833	}
		1834	}
		1835
		1836	($x, $y) = (-1, -1)
		1837	unless (defined $x) && (defined $y);
		1838
		1839	# use -1 or undef as default coordinates, not 0, 0
		1840	($x, $y) = ($map->enter_x, $map->enter_y)
		1841	if $x <=0 && $y <= 0;
		1842
		1843	$map->load;
		1844	$map->load_diag;
		1845
		1846	return unless $self->contr->active;
		1847	$self->activate_recursive;
		1848
		1849	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1850	$self->enter_map ($map, $x, $y);
		1851	}
		1852
		1853	cf::player->attach (
		1854	on_logout => sub {
		1855	my ($pl) = @_;
		1856
		1857	# abort map switching before logout
		1858	if ($pl->ob->{_link_pos}) {
		1859	cf::sync_job {
		1860	$pl->ob->leave_link
		1861	};
		1862	}
		1863	},
		1864	on_login => sub {
		1865	my ($pl) = @_;
		1866
		1867	# try to abort aborted map switching on player login :)
		1868	# should happen only on crashes
		1869	if ($pl->ob->{_link_pos}) {
		1870	$pl->ob->enter_link;
		1871	(async {
		1872	$pl->ob->reply (undef,
		1873	"There was an internal problem at your last logout, "
		1874	. "the server will try to bring you to your intended destination in a second.",
		1875	cf::NDI_RED);
		1876	# we need this sleep as the login has a concurrent enter_exit running
		1877	# and this sleep increases chances of the player not ending up in scorn
		1878	Coro::Timer::sleep 1;
		1879	$pl->ob->leave_link;
		1880	})->prio (2);
		1881	}
		1882	},
		1883	);
		1884
		1885	=item $player_object->goto ($path, $x, $y)
		1886
		1887	=cut
		1888
		1889	sub cf::object::player::goto {
		1890	my ($self, $path, $x, $y) = @_;
		1891
		1892	$self->enter_link;
		1893
		1894	(async {
		1895	my $map = eval {
		1896	my $map = cf::map::find $path;
		1897	$map = $map->customise_for ($self) if $map;
		1898	$map
		1899	} or
		1900	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1901
		1902	$self->leave_link ($map, $x, $y);
		1903	})->prio (1);
		1904	}
		1905
		1906	=item $player_object->enter_exit ($exit_object)
		1907
		1908	=cut
		1909
		1910	sub parse_random_map_params {
		1911	my ($spec) = @_;
		1912
		1913	my $rmp = { # defaults
		1914	xsize => (cf::rndm 15, 40),
		1915	ysize => (cf::rndm 15, 40),
		1916	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1917	#layout => string,
		1918	};
		1919
		1920	for (split /\n/, $spec) {
		1921	my ($k, $v) = split /\s+/, $_, 2;
		1922
		1923	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1924	}
		1925
		1926	$rmp
		1927	}
		1928
		1929	sub prepare_random_map {
		1930	my ($exit) = @_;
		1931
		1932	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1933
		1934	# all this does is basically replace the /! path by
		1935	# a new random map path (?random/...) with a seed
		1936	# that depends on the exit object
		1937
		1938	my $rmp = parse_random_map_params $exit->msg;
		1939
		1940	if ($exit->map) {
		1941	$rmp->{region} = $exit->region->name;
		1942	$rmp->{origin_map} = $exit->map->path;
		1943	$rmp->{origin_x} = $exit->x;
		1944	$rmp->{origin_y} = $exit->y;
		1945	}
		1946
		1947	$rmp->{random_seed} ||= $exit->random_seed;
		1948
		1949	my $data = cf::to_json $rmp;
		1950	my $md5 = Digest::MD5::md5_hex $data;
		1951	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1952
		1953	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1954	aio_write $fh, 0, (length $data), $data, 0;
		1955	undef $fh;
		1956	aio_rename "$meta~", $meta;
		1957
		1958	$exit->slaying ("?random/$md5");
		1959	$exit->msg (undef);
		1960	}
		1961	}
		1962
		1963	sub cf::object::player::enter_exit {
		1964	my ($self, $exit) = @_;
		1965
		1966	return unless $self->type == cf::PLAYER;
		1967
		1968	if ($exit->slaying eq "/!") {
		1969	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1970	# the problem is that $exit might not survive long enough
		1971	# so it needs to be done right now, right here
		1972	cf::sync_job { prepare_random_map $exit };
		1973	}
		1974
		1975	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1976	my $hp = $exit->stats->hp;
		1977	my $sp = $exit->stats->sp;
		1978
		1979	$self->enter_link;
		1980
		1981	(async {
		1982	$self->deactivate_recursive; # just to be sure
		1983	unless (eval {
		1984	$self->goto ($slaying, $hp, $sp);
		1985
		1986	1;
		1987	}) {
		1988	$self->message ("Something went wrong deep within the crossfire server. "
		1989	. "I'll try to bring you back to the map you were before. "
		1990	. "Please report this to the dungeon master!",
		1991	cf::NDI_UNIQUE | cf::NDI_RED);
		1992
		1993	warn "ERROR in enter_exit: $@";
		1994	$self->leave_link;
		1995	}
		1996	})->prio (1);
		1997	}
		1998
		1999	=head3 cf::client
		2000
		2001	=over 4
		2002
		2003	=item $client->send_drawinfo ($text, $flags)
		2004
		2005	Sends a drawinfo packet to the client. Circumvents output buffering so
		2006	should not be used under normal circumstances.
		2007
		2008	=cut
		2009
		2010	sub cf::client::send_drawinfo {
		2011	my ($self, $text, $flags) = @_;
		2012
		2013	utf8::encode $text;
		2014	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2015	}
		2016
		2017	=item $client->ext_event ($type, %msg)
		2018
		2019	Sends an exti event to the client.
		2020
		2021	=cut
		2022
		2023	sub cf::client::ext_event($$%) {
		2024	my ($self, $type, %msg) = @_;
		2025
		2026	$msg{msgtype} = "event_$type";
		2027	$self->send_packet ("ext " . cf::to_json \%msg);
		2028	}
		2029
		2030	=item $success = $client->query ($flags, "text", \&cb)
		2031
		2032	Queues a query to the client, calling the given callback with
		2033	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2034	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2035
		2036	Queries can fail, so check the return code. Or don't, as queries will become
		2037	reliable at some point in the future.
		2038
		2039	=cut
		2040
		2041	sub cf::client::query {
		2042	my ($self, $flags, $text, $cb) = @_;
		2043
		2044	return unless $self->state == ST_PLAYING
		2045	|| $self->state == ST_SETUP
		2046	|| $self->state == ST_CUSTOM;
		2047
		2048	$self->state (ST_CUSTOM);
		2049
		2050	utf8::encode $text;
		2051	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2052
		2053	$self->send_packet ($self->{query_queue}[0][0])
		2054	if @{ $self->{query_queue} } == 1;
		2055	}
		2056
		2057	cf::client->attach (
		2058	on_reply => sub {
		2059	my ($ns, $msg) = @_;
		2060
		2061	# this weird shuffling is so that direct followup queries
		2062	# get handled first
		2063	my $queue = delete $ns->{query_queue}
		2064	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2065
		2066	(shift @$queue)->[1]->($msg);
		2067	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2068
		2069	push @{ $ns->{query_queue} }, @$queue;
		2070
		2071	if (@{ $ns->{query_queue} } == @$queue) {
		2072	if (@$queue) {
		2073	$ns->send_packet ($ns->{query_queue}[0][0]);
		2074	} else {
		2075	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2076	}
		2077	}
		2078	},
		2079	);
		2080
		2081	=item $client->async (\&cb)
		2082
		2083	Create a new coroutine, running the specified callback. The coroutine will
		2084	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2085	or loss of connection).
		2086
		2087	=cut
		2088
		2089	sub cf::client::async {
		2090	my ($self, $cb) = @_;
		2091
		2092	my $coro = &Coro::async ($cb);
		2093
		2094	$coro->on_destroy (sub {
		2095	delete $self->{_coro}{$coro+0};
		2096	});
		2097
		2098	$self->{_coro}{$coro+0} = $coro;
		2099
		2100	$coro
		2101	}
		2102
		2103	cf::client->attach (
		2104	on_destroy => sub {
		2105	my ($ns) = @_;
		2106
		2107	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2108	},
		2109	);
		2110
		2111	=back
		2112
832		2113
833	=head2 SAFE SCRIPTING	2114	=head2 SAFE SCRIPTING
834		2115
835	Functions that provide a safe environment to compile and execute	2116	Functions that provide a safe environment to compile and execute
836	snippets of perl code without them endangering the safety of the server	2117	snippets of perl code without them endangering the safety of the server
…		…
849		2130
850	# here we export the classes and methods available to script code	2131	# here we export the classes and methods available to script code
851		2132
852	=pod	2133	=pod
853		2134
854	The following fucntions and emthods are available within a safe environment:	2135	The following functions and methods are available within a safe environment:
855		2136
856	cf::object contr pay_amount pay_player map	2137	cf::object contr pay_amount pay_player map
857	cf::object::player player	2138	cf::object::player player
858	cf::player peaceful	2139	cf::player peaceful
859	cf::map trigger	2140	cf::map trigger
…		…
952	The parameter C<$family> should best start with the name of the extension	2233	The parameter C<$family> should best start with the name of the extension
953	using it, it should be unique.	2234	using it, it should be unique.
954		2235
955	=over 4	2236	=over 4
956		2237
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	2238	=item $value = cf::db_get $family => $key
964		2239
965	Returns a single value from the database	2240	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		2241
972	=item cf::db_put $family => $key => $value	2242	=item cf::db_put $family => $key => $value
973		2243
974	Stores the given C<$value> in the family hash. Updates are delayed, if you	2244	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		2245
985	=cut	2246	=cut
986		2247
987	our $DB;	2248	our $DB;
988		2249
989	{	2250	sub db_init {
		2251	unless ($DB) {
		2252	$DB = BDB::db_create $DB_ENV;
		2253
		2254	cf::sync_job {
		2255	eval {
		2256	$DB->set_flags (BDB::CHKSUM);
		2257
		2258	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2259	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2260	cf::cleanup "db_open(db): $!" if $!;
		2261	};
		2262	cf::cleanup "db_open(db): $@" if $@;
		2263	};
		2264
990	my $path = cf::localdir . "/database.pst";	2265	my $path = cf::localdir . "/database.pst";
		2266	if (stat $path) {
		2267	cf::sync_job {
		2268	my $pst = Storable::retrieve $path;
991		2269
992	sub db_load() {	2270	cf::db_put (board => data => $pst->{board});
993	warn "loading database $path\n";#d# remove later	2271	cf::db_put (guildrules => data => $pst->{guildrules});
994	$DB = stat $path ? Storable::retrieve $path : { };	2272	cf::db_put (rent => balance => $pst->{rent}{balance});
995	}	2273	BDB::db_env_txn_checkpoint $DB_ENV;
996		2274
997	my $pid;	2275	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	}	2276	};
1008	}	2277	}
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	});	2278	}
		2279	}
1020		2280
1021	sub db_dirty() {
1022	$dirty = 1;
1023	$idle->start;
1024	}
1025
1026	sub db_get($;$) {	2281	sub db_get($$) {
1027	@_ >= 2	2282	my $key = "$_[0]/$_[1]";
1028	? $DB->{$_[0]}{$_[1]}
1029	: ($DB->{$_[0]} ||= { })
1030	}
1031		2283
		2284	cf::sync_job {
		2285	BDB::db_get $DB, undef, $key, my $data;
		2286
		2287	$! ? ()
		2288	: Compress::LZF::sthaw $data
		2289	}
		2290	}
		2291
1032	sub db_put($$;$) {	2292	sub db_put($$$) {
1033	if (@_ >= 3) {	2293	BDB::dbreq_pri 4;
1034	$DB->{$_[0]}{$_[1]} = $_[2];	2294	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
		2295	}
		2296
		2297	#############################################################################
		2298	# the server's init and main functions
		2299
		2300	sub load_facedata {
		2301	my $path = sprintf "%s/facedata", cf::datadir;
		2302
		2303	warn "loading facedata from $path\n";
		2304
		2305	my $faces;
		2306	0 < aio_load $path, $faces
		2307	or die "$path: $!";
		2308
		2309	Coro::cede;
		2310	$faces = Storable::thaw $faces;
		2311	Coro::cede;
		2312
		2313	my $meta = delete $faces->{""};
		2314	$meta->{version} == 1
		2315	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2316
		2317	while (my ($face, $info) = each %$faces) {
		2318	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2319	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2320	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2321	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2322	Coro::cede;
		2323	}
		2324
		2325	while (my ($face, $info) = each %$faces) {
		2326	next unless $info->{smooth};
		2327	my $idx = cf::face::find $face
		2328	or next;
		2329	if (my $smooth = cf::face::find $info->{smooth}) {
		2330	cf::face::set_smooth $idx, $smooth;
1035	} else {	2331	} else {
1036	$DB->{$_[0]} = $_[1];	2332	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	},	2333	}
1046	);	2334	Coro::cede;
1047	}	2335	}
1048		2336
1049	#############################################################################	2337	1
1050	# the server's main()	2338	}
		2339
		2340	sub reload_resources {
		2341	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2342	or die "unable to load regions file\n";#d#
		2343	load_facedata
		2344	or die "unable to load facedata\n";#d#
		2345	}
		2346
		2347	sub init {
		2348	reload_resources;
		2349	}
1051		2350
1052	sub cfg_load {	2351	sub cfg_load {
1053	open my $fh, "<:utf8", cf::confdir . "/config"	2352	open my $fh, "<:utf8", cf::confdir . "/config"
1054	or return;	2353	or return;
1055		2354
1056	local $/;	2355	local $/;
1057	*CFG = YAML::Syck::Load <$fh>;	2356	*CFG = YAML::Syck::Load <$fh>;
		2357
		2358	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2359
		2360	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2361	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2362
		2363	if (exists $CFG{mlockall}) {
		2364	eval {
		2365	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2366	and die "WARNING: m(un)lockall failed: $!\n";
		2367	};
		2368	warn $@ if $@;
		2369	}
1058	}	2370	}
1059		2371
1060	sub main {	2372	sub main {
		2373	# we must not ever block the main coroutine
		2374	local $Coro::idle = sub {
		2375	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2376	(async {
		2377	Event::one_event;
		2378	})->prio (Coro::PRIO_MAX);
		2379	};
		2380
1061	cfg_load;	2381	cfg_load;
1062	db_load;	2382	db_init;
1063	load_extensions;	2383	load_extensions;
		2384
		2385	$TICK_WATCHER->start;
1064	Event::loop;	2386	Event::loop;
1065	}	2387	}
1066		2388
1067	#############################################################################	2389	#############################################################################
1068	# initialisation	2390	# initialisation and cleanup
1069		2391
		2392	# install some emergency cleanup handlers
		2393	BEGIN {
		2394	for my $signal (qw(INT HUP TERM)) {
		2395	Event->signal (
		2396	reentrant => 0,
		2397	data => WF_AUTOCANCEL,
		2398	signal => $signal,
		2399	prio => 0,
		2400	cb => sub {
		2401	cf::cleanup "SIG$signal";
		2402	},
		2403	);
		2404	}
		2405	}
		2406
		2407	sub emergency_save() {
		2408	my $freeze_guard = cf::freeze_mainloop;
		2409
		2410	warn "enter emergency perl save\n";
		2411
		2412	cf::sync_job {
		2413	# use a peculiar iteration method to avoid tripping on perl
		2414	# refcount bugs in for. also avoids problems with players
		2415	# and maps saved/destroyed asynchronously.
		2416	warn "begin emergency player save\n";
		2417	for my $login (keys %cf::PLAYER) {
		2418	my $pl = $cf::PLAYER{$login} or next;
		2419	$pl->valid or next;
		2420	$pl->save;
		2421	}
		2422	warn "end emergency player save\n";
		2423
		2424	warn "begin emergency map save\n";
		2425	for my $path (keys %cf::MAP) {
		2426	my $map = $cf::MAP{$path} or next;
		2427	$map->valid or next;
		2428	$map->save;
		2429	}
		2430	warn "end emergency map save\n";
		2431
		2432	warn "begin emergency database checkpoint\n";
		2433	BDB::db_env_txn_checkpoint $DB_ENV;
		2434	warn "end emergency database checkpoint\n";
		2435	};
		2436
		2437	warn "leave emergency perl save\n";
		2438	}
		2439
		2440	sub post_cleanup {
		2441	my ($make_core) = @_;
		2442
		2443	warn Carp::longmess "post_cleanup backtrace"
		2444	if $make_core;
		2445	}
		2446
1070	sub _perl_reload(&) {	2447	sub reload() {
1071	my ($msg) = @_;	2448	# can/must only be called in main
		2449	if ($Coro::current != $Coro::main) {
		2450	warn "can only reload from main coroutine";
		2451	return;
		2452	}
1072		2453
1073	$msg->("reloading...");	2454	warn "reloading...";
1074		2455
1075	eval {	2456	warn "entering sync_job";
1076	# cancel all watchers	2457
		2458	cf::sync_job {
		2459	cf::write_runtime; # external watchdog should not bark
		2460	cf::emergency_save;
		2461	cf::write_runtime; # external watchdog should not bark
		2462
		2463	warn "syncing database to disk";
		2464	BDB::db_env_txn_checkpoint $DB_ENV;
		2465
		2466	# if anything goes wrong in here, we should simply crash as we already saved
		2467
		2468	warn "cancelling all WF_AUTOCANCEL watchers";
1077	for (Event::all_watchers) {	2469	for (Event::all_watchers) {
1078	$_->cancel if $_->data & WF_AUTOCANCEL;	2470	$_->cancel if $_->data & WF_AUTOCANCEL;
1079	}	2471	}
1080		2472
1081	# unload all extensions	2473	warn "flushing outstanding aio requests";
1082	for (@exts) {	2474	for (;;) {
1083	$msg->("unloading <$_>");	2475	BDB::flush;
1084	unload_extension $_;	2476	IO::AIO::flush;
		2477	Coro::cede;
		2478	last unless IO::AIO::nreqs || BDB::nreqs;
		2479	warn "iterate...";
		2480	}
		2481
		2482	++$RELOAD;
		2483
		2484	warn "cancelling all extension coros";
		2485	$_->cancel for values %EXT_CORO;
		2486	%EXT_CORO = ();
		2487
		2488	warn "removing commands";
		2489	%COMMAND = ();
		2490
		2491	warn "removing ext commands";
		2492	%EXTCMD = ();
		2493
		2494	warn "unloading/nuking all extensions";
		2495	for my $pkg (@EXTS) {
		2496	warn "... unloading $pkg";
		2497
		2498	if (my $cb = $pkg->can ("unload")) {
		2499	eval {
		2500	$cb->($pkg);
		2501	1
		2502	} or warn "$pkg unloaded, but with errors: $@";
1085	}	2503	}
1086		2504
		2505	warn "... nuking $pkg";
		2506	Symbol::delete_package $pkg;
		2507	}
		2508
1087	# unload all modules loaded from $LIBDIR	2509	warn "unloading all perl modules loaded from $LIBDIR";
1088	while (my ($k, $v) = each %INC) {	2510	while (my ($k, $v) = each %INC) {
1089	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2511	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090		2512
1091	$msg->("removing <$k>");	2513	warn "... unloading $k";
1092	delete $INC{$k};	2514	delete $INC{$k};
1093		2515
1094	$k =~ s/\.pm$//;	2516	$k =~ s/\.pm$//;
1095	$k =~ s/\//::/g;	2517	$k =~ s/\//::/g;
1096		2518
…		…
1099	}	2521	}
1100		2522
1101	Symbol::delete_package $k;	2523	Symbol::delete_package $k;
1102	}	2524	}
1103		2525
1104	# sync database to disk
1105	cf::db_sync;
1106
1107	# get rid of safe::, as good as possible	2526	warn "getting rid of safe::, as good as possible";
1108	Symbol::delete_package "safe::$_"	2527	Symbol::delete_package "safe::$_"
1109	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2528	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110		2529
1111	# remove register_script_function callbacks
1112	# TODO
1113
1114	# unload cf.pm "a bit"	2530	warn "unloading cf.pm \"a bit\"";
1115	delete $INC{"cf.pm"};	2531	delete $INC{"cf.pm"};
1116		2532
1117	# don't, removes xs symbols, too,	2533	# don't, removes xs symbols, too,
1118	# and global variables created in xs	2534	# and global variables created in xs
1119	#Symbol::delete_package __PACKAGE__;	2535	#Symbol::delete_package __PACKAGE__;
1120		2536
1121	# reload cf.pm	2537	warn "unload completed, starting to reload now";
		2538
1122	$msg->("reloading cf.pm");	2539	warn "reloading cf.pm";
1123	require cf;	2540	require cf;
		2541	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124		2542
1125	# load config and database again	2543	warn "loading config and database again";
1126	cf::cfg_load;	2544	cf::cfg_load;
1127	cf::db_load;
1128		2545
1129	# load extensions	2546	warn "loading extensions";
1130	$msg->("load extensions");
1131	cf::load_extensions;	2547	cf::load_extensions;
1132		2548
1133	# reattach attachments to objects	2549	warn "reattaching attachments to objects/players";
1134	$msg->("reattach");	2550	_global_reattach; # objects, sockets
1135	_global_reattach;	2551	warn "reattaching attachments to maps";
		2552	reattach $_ for values %MAP;
		2553	warn "reattaching attachments to players";
		2554	reattach $_ for values %PLAYER;
		2555
		2556	warn "loading reloadable resources";
		2557	reload_resources;
		2558
		2559	warn "leaving sync_job";
		2560
		2561	1
		2562	} or do {
		2563	warn $@;
		2564	warn "error while reloading, exiting.";
		2565	exit 1;
1136	};	2566	};
1137	$msg->($@) if $@;
1138		2567
1139	$msg->("reloaded");	2568	warn "reloaded";
1140	};	2569	};
1141		2570
1142	sub perl_reload() {	2571	our $RELOAD_WATCHER; # used only during reload
1143	_perl_reload {
1144	warn $_[0];
1145	print "$_[0]\n";
1146	};
1147	}
1148		2572
1149	register "<global>", __PACKAGE__;
1150
1151	register_command "perl-reload" => sub {	2573	register_command "reload" => sub {
1152	my ($who, $arg) = @_;	2574	my ($who, $arg) = @_;
1153		2575
1154	if ($who->flag (FLAG_WIZ)) {	2576	if ($who->flag (FLAG_WIZ)) {
1155	_perl_reload {	2577	$who->message ("reloading server.");
1156	warn $_[0];	2578
1157	$who->message ($_[0]);	2579	# doing reload synchronously and two reloads happen back-to-back,
		2580	# coro crashes during coro_state_free->destroy here.
		2581
		2582	$RELOAD_WATCHER ||= Event->timer (
		2583	reentrant => 0,
		2584	after => 0,
		2585	data => WF_AUTOCANCEL,
		2586	cb => sub {
		2587	reload;
		2588	undef $RELOAD_WATCHER;
		2589	},
1158	};	2590	);
1159	}	2591	}
1160	};	2592	};
1161		2593
1162	unshift @INC, $LIBDIR;	2594	unshift @INC, $LIBDIR;
1163		2595
		2596	my $bug_warning = 0;
		2597
1164	$TICK_WATCHER = Event->timer (	2598	$TICK_WATCHER = Event->timer (
		2599	reentrant => 0,
		2600	parked => 1,
1165	prio => 0,	2601	prio => 0,
1166	at => $NEXT_TICK || 1,	2602	at => $NEXT_TICK || $TICK,
1167	data => WF_AUTOCANCEL,	2603	data => WF_AUTOCANCEL,
1168	cb => sub {	2604	cb => sub {
		2605	if ($Coro::current != $Coro::main) {
		2606	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2607	unless ++$bug_warning > 10;
		2608	return;
		2609	}
		2610
		2611	$NOW = Event::time;
		2612
1169	cf::server_tick; # one server iteration	2613	cf::server_tick; # one server iteration
1170		2614	$RUNTIME += $TICK;
1171	my $NOW = Event::time;
1172	$NEXT_TICK += $TICK;	2615	$NEXT_TICK += $TICK;
1173		2616
		2617	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2618	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2619	Coro::async_pool {
		2620	write_runtime
		2621	or warn "ERROR: unable to write runtime file: $!";
		2622	};
		2623	}
		2624
		2625	$WAIT_FOR_TICK->broadcast;
		2626	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2627
		2628	# my $AFTER = Event::time;
		2629	# warn $AFTER - $NOW;#d#
		2630
1174	# if we are delayed by four ticks or more, skip them all	2631	# if we are delayed by four ticks or more, skip them all
1175	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2632	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176		2633
1177	$TICK_WATCHER->at ($NEXT_TICK);	2634	$TICK_WATCHER->at ($NEXT_TICK);
1178	$TICK_WATCHER->start;	2635	$TICK_WATCHER->start;
1179	},	2636	},
1180	);	2637	);
1181		2638
		2639	{
		2640	BDB::max_poll_time $TICK * 0.1;
		2641	$BDB_POLL_WATCHER = Event->io (
		2642	reentrant => 0,
		2643	fd => BDB::poll_fileno,
		2644	poll => 'r',
		2645	prio => 0,
		2646	data => WF_AUTOCANCEL,
		2647	cb => \&BDB::poll_cb,
		2648	);
		2649	BDB::min_parallel 8;
		2650
		2651	BDB::set_sync_prepare {
		2652	my $status;
		2653	my $current = $Coro::current;
		2654	(
		2655	sub {
		2656	$status = $!;
		2657	$current->ready; undef $current;
		2658	},
		2659	sub {
		2660	Coro::schedule while defined $current;
		2661	$! = $status;
		2662	},
		2663	)
		2664	};
		2665
		2666	unless ($DB_ENV) {
		2667	$DB_ENV = BDB::db_env_create;
		2668
		2669	cf::sync_job {
		2670	eval {
		2671	BDB::db_env_open
		2672	$DB_ENV,
		2673	$BDB_ENV_DIR,
		2674	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2675	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2676	0666;
		2677
		2678	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2679
		2680	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2681	$DB_ENV->set_lk_detect;
		2682	};
		2683
		2684	cf::cleanup "db_env_open(db): $@" if $@;
		2685	};
		2686	}
		2687	}
		2688
		2689	{
		2690	IO::AIO::min_parallel 8;
		2691
		2692	undef $Coro::AIO::WATCHER;
1182	IO::AIO::max_poll_time $TICK * 0.2;	2693	IO::AIO::max_poll_time $TICK * 0.1;
1183		2694	$AIO_POLL_WATCHER = Event->io (
1184	Event->io (fd => IO::AIO::poll_fileno,	2695	reentrant => 0,
1185	poll => 'r',
1186	prio => 5,
1187	data => WF_AUTOCANCEL,	2696	data => WF_AUTOCANCEL,
		2697	fd => IO::AIO::poll_fileno,
		2698	poll => 'r',
		2699	prio => 6,
1188	cb => \&IO::AIO::poll_cb);	2700	cb => \&IO::AIO::poll_cb,
		2701	);
		2702	}
		2703
		2704	END { cf::emergency_save }
1189		2705
1190	1	2706	1
1191		2707

Diff Legend

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