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.20 by root, Sun Jul 16 17:29:02 2006 UTC vs.
Revision 1.213 by root, Tue Feb 13 20:01:04 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 Opcode;
		10	use Safe;
		11	use Safe::Hole;
6		12
		13	use Coro 3.5 ();
7	use Event;	14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use BDB ();
		21	use Data::Dumper;
		22	use Digest::MD5;
		23	use Fcntl;
		24	use IO::AIO 2.32 ();
		25	use YAML::Syck ();
		26	use Time::HiRes;
		27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		30
8	$Event::Eval = 1; # no idea why this is required, but it is	31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
9		32
10	use strict;	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
11		34
12	our %COMMAND;	35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		36	$YAML::Syck::ImplicitUnicode = 1;
		37
		38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		39
		40	our %COMMAND = ();
		41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
		44	our %EXTCMD = ();
		45	our %EXT_CORO = (); # coroutines bound to extensions
		46	our %EXT_MAP = (); # pluggable maps
		47
13	our @EVENT;	48	our @EVENT;
14	our %PROP_TYPE;	49	our $LIBDIR = datadir . "/ext";
15	our %PROP_IDX;	50
		51	our $TICK = MAX_TIME * 1e-6;
		52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $WRITE_RUNTIME_WATCHER;
		55	our $NEXT_TICK;
		56	our $NOW;
		57	our $USE_FSYNC = 1; # use fsync to write maps - default off
		58
		59	our $BDB_POLL_WATCHER;
		60	our $DB_ENV;
		61
		62	our %CFG;
		63
		64	our $UPTIME; $UPTIME ||= time;
		65	our $RUNTIME;
		66
		67	our %PLAYER; # all users
		68	our %MAP; # all maps
		69	our $LINK_MAP; # the special {link} map, which is always available
		70	our $RANDOM_MAPS = cf::localdir . "/random";
		71	our $BDB_ENV_DIR = cf::localdir . "/db";
		72
		73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		75
		76	# used to convert map paths into valid unix filenames by replacing / by ∕
		77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		78
		79	binmode STDOUT;
		80	binmode STDERR;
		81
		82	# read virtual server time, if available
		83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		84	open my $fh, "<", cf::localdir . "/runtime"
		85	or die "unable to read runtime file: $!";
		86	$RUNTIME = <$fh> + 0.;
		87	}
		88
		89	mkdir cf::localdir;
		90	mkdir cf::localdir . "/" . cf::playerdir;
		91	mkdir cf::localdir . "/" . cf::tmpdir;
		92	mkdir cf::localdir . "/" . cf::uniquedir;
		93	mkdir $RANDOM_MAPS;
		94	mkdir $BDB_ENV_DIR;
		95
		96	our $EMERGENCY_POSITION;
		97
		98	sub cf::map::normalise;
		99
		100	#############################################################################
		101
		102	=head2 GLOBAL VARIABLES
		103
		104	=over 4
		105
		106	=item $cf::UPTIME
		107
		108	The timestamp of the server start (so not actually an uptime).
		109
		110	=item $cf::RUNTIME
		111
		112	The time this server has run, starts at 0 and is increased by $cf::TICK on
		113	every server tick.
		114
		115	=item $cf::LIBDIR
		116
		117	The perl library directory, where extensions and cf-specific modules can
		118	be found. It will be added to C<@INC> automatically.
		119
		120	=item $cf::NOW
		121
		122	The time of the last (current) server tick.
		123
		124	=item $cf::TICK
		125
		126	The interval between server ticks, in seconds.
		127
		128	=item %cf::CFG
		129
		130	Configuration for the server, loaded from C</etc/crossfire/config>, or
		131	from wherever your confdir points to.
		132
		133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		134
		135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		137	processing has been done. Call C<< ->wait >> on them to maximise the
		138	window of cpu time available, or simply to synchronise to the server tick.
		139
		140	=back
		141
		142	=cut
16		143
17	BEGIN {	144	BEGIN {
18	@EVENT = map lc, @EVENT;
19
20	*CORE::GLOBAL::warn = sub {	145	*CORE::GLOBAL::warn = sub {
21	my $msg = join "", @_;	146	my $msg = join "", @_;
		147	utf8::encode $msg;
		148
22	$msg .= "\n"	149	$msg .= "\n"
23	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
24		151
25	print STDERR "cfperl: $msg";
26	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
27	};	153	};
28	}	154	}
29		155
30	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		160	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
31		162
32	# generate property mutators	163	# we bless all objects into (empty) derived classes to force a method lookup
33	sub prop_gen {	164	# within the Safe compartment.
34	my ($prefix, $class) = @_;	165	for my $pkg (qw(
35		166	cf::global cf::attachable
		167	cf::object cf::object::player
		168	cf::client cf::player
		169	cf::arch cf::living
		170	cf::map cf::party cf::region
		171	)) {
36	no strict 'refs';	172	no strict 'refs';
37		173	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
38	for my $prop (keys %PROP_TYPE) {
39	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
40	my $sub = lc $1;
41
42	my $type = $PROP_TYPE{$prop};
43	my $idx = $PROP_IDX {$prop};
44
45	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
46	$_[0]->get_property ($type, $idx)
47	};
48
49	*{"$class\::set_$sub"} = sub {
50	$_[0]->set_property ($type, $idx, $_[1]);
51	} unless $ignore_set{$prop};
52	}
53	}	174	}
54
55	# auto-generate most of the API
56
57	prop_gen OBJECT_PROP => "cf::object";
58	# CFAPI_OBJECT_ANIMATION?
59	prop_gen PLAYER_PROP => "cf::object::player";
60
61	prop_gen MAP_PROP => "cf::map";
62	prop_gen ARCH_PROP => "cf::arch";
63
64	# guessed hierarchies
65
66	@cf::object::player::ISA = 'cf::object';
67	@cf::object::map::ISA = 'cf::object';
68		175
69	$Event::DIED = sub {	176	$Event::DIED = sub {
70	warn "error in event callback: @_";	177	warn "error in event callback: @_";
71	};	178	};
72		179
73	my %ext_pkg;	180	=head2 UTILITY FUNCTIONS
74	my @exts;
75	my @hook;
76	my %command;
77	my %extcmd;
78		181
79	sub inject_event {	182	=over 4
80	my $extension = shift;	183
		184	=item dumpval $ref
		185
		186	=cut
		187
		188	sub dumpval {
		189	eval {
		190	local $SIG{__DIE__};
		191	my $d;
		192	if (1) {
		193	$d = new Data::Dumper([$_[0]], ["*var"]);
		194	$d->Terse(1);
		195	$d->Indent(2);
		196	$d->Quotekeys(0);
		197	$d->Useqq(1);
		198	#$d->Bless(...);
		199	$d->Seen($_[1]) if @_ > 1;
		200	$d = $d->Dump();
		201	}
		202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		203	$d
		204	} || "[unable to dump $_[0]: '$@']";
		205	}
		206
		207	use JSON::Syck (); # TODO# replace by JSON::PC once working
		208
		209	=item $ref = cf::from_json $json
		210
		211	Converts a JSON string into the corresponding perl data structure.
		212
		213	=cut
		214
		215	sub from_json($) {
		216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
		217	JSON::Syck::Load $_[0]
		218	}
		219
		220	=item $json = cf::to_json $ref
		221
		222	Converts a perl data structure into its JSON representation.
		223
		224	=cut
		225
		226	sub to_json($) {
		227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
		228	JSON::Syck::Dump $_[0]
		229	}
		230
		231	=item cf::lock_wait $string
		232
		233	Wait until the given lock is available. See cf::lock_acquire.
		234
		235	=item my $lock = cf::lock_acquire $string
		236
		237	Wait until the given lock is available and then acquires it and returns
		238	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		239	for example when the coroutine gets canceled), the lock is automatically
		240	returned.
		241
		242	Lock names should begin with a unique identifier (for example, cf::map::find
		243	uses map_find and cf::map::load uses map_load).
		244
		245	=cut
		246
		247	our %LOCK;
		248
		249	sub lock_wait($) {
		250	my ($key) = @_;
		251
		252	# wait for lock, if any
		253	while ($LOCK{$key}) {
		254	push @{ $LOCK{$key} }, $Coro::current;
		255	Coro::schedule;
		256	}
		257	}
		258
		259	sub lock_acquire($) {
		260	my ($key) = @_;
		261
		262	# wait, to be sure we are not locked
		263	lock_wait $key;
		264
		265	$LOCK{$key} = [];
		266
		267	Coro::guard {
		268	# wake up all waiters, to be on the safe side
		269	$_->ready for @{ delete $LOCK{$key} };
		270	}
		271	}
		272
		273	sub freeze_mainloop {
		274	return unless $TICK_WATCHER->is_active;
		275
		276	my $guard = Coro::guard {
		277	$TICK_WATCHER->start;
		278	$WRITE_RUNTIME_WATCHER->start;
		279	};
		280	$WRITE_RUNTIME_WATCHER->stop;
		281	$TICK_WATCHER->stop;
		282	$guard
		283	}
		284
		285	=item cf::async { BLOCK }
		286
		287	Currently the same as Coro::async_pool, meaning you cannot use
		288	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		289	thing you are allowed to do is call C<prio> on it.
		290
		291	=cut
		292
		293	BEGIN { *async = \&Coro::async_pool }
		294
		295	=item cf::sync_job { BLOCK }
		296
		297	The design of crossfire+ requires that the main coro ($Coro::main) is
		298	always able to handle events or runnable, as crossfire+ is only partly
		299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		300
		301	If it must be done, put the blocking parts into C<sync_job>. This will run
		302	the given BLOCK in another coroutine while waiting for the result. The
		303	server will be frozen during this time, so the block should either finish
		304	fast or be very important.
		305
		306	=cut
		307
		308	sub sync_job(&) {
		309	my ($job) = @_;
		310
		311	if ($Coro::current == $Coro::main) {
		312	# this is the main coro, too bad, we have to block
		313	# till the operation succeeds, freezing the server :/
		314
		315	# TODO: use suspend/resume instead
		316	# (but this is cancel-safe)
		317	my $freeze_guard = freeze_mainloop;
		318
		319	my $busy = 1;
		320	my @res;
		321
		322	(async {
		323	@res = eval { $job->() };
		324	warn $@ if $@;
		325	undef $busy;
		326	})->prio (Coro::PRIO_MAX);
		327
		328	while ($busy) {
		329	Coro::cede or Event::one_event;
		330	}
		331
		332	wantarray ? @res : $res[0]
		333	} else {
		334	# we are in another coroutine, how wonderful, everything just works
		335
		336	$job->()
		337	}
		338	}
		339
		340	=item $coro = cf::async_ext { BLOCK }
		341
		342	Like async, but this coro is automatically being canceled when the
		343	extension calling this is being unloaded.
		344
		345	=cut
		346
		347	sub async_ext(&) {
81	my $event_code = shift;	348	my $cb = shift;
82		349
83	my $cb = $hook[$event_code]{$extension}	350	my $coro = &Coro::async ($cb);
		351
		352	$coro->on_destroy (sub {
		353	delete $EXT_CORO{$coro+0};
		354	});
		355	$EXT_CORO{$coro+0} = $coro;
		356
		357	$coro
		358	}
		359
		360	sub write_runtime {
		361	my $runtime = cf::localdir . "/runtime";
		362
		363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
84	or return;	364	or return;
85		365
86	&$cb	366	my $value = $cf::RUNTIME + 90 + 10;
87	}	367	# 10 is the runtime save interval, for a monotonic clock
		368	# 60 allows for the watchdog to kill the server.
88		369
89	sub inject_global_event {	370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		371	and return;
		372
		373	# always fsync - this file is important
		374	aio_fsync $fh
		375	and return;
		376
		377	close $fh
		378	or return;
		379
		380	aio_rename "$runtime~", $runtime
		381	and return;
		382
		383	1
		384	}
		385
		386	=back
		387
		388	=cut
		389
		390	#############################################################################
		391
		392	=head2 ATTACHABLE OBJECTS
		393
		394	Many objects in crossfire are so-called attachable objects. That means you can
		395	attach callbacks/event handlers (a collection of which is called an "attachment")
		396	to it. All such attachable objects support the following methods.
		397
		398	In the following description, CLASS can be any of C<global>, C<object>
		399	C<player>, C<client> or C<map> (i.e. the attachable objects in
		400	crossfire+).
		401
		402	=over 4
		403
		404	=item $attachable->attach ($attachment, key => $value...)
		405
		406	=item $attachable->detach ($attachment)
		407
		408	Attach/detach a pre-registered attachment to a specific object and give it
		409	the specified key/value pairs as arguments.
		410
		411	Example, attach a minesweeper attachment to the given object, making it a
		412	10x10 minesweeper game:
		413
		414	$obj->attach (minesweeper => width => 10, height => 10);
		415
		416	=item $bool = $attachable->attached ($name)
		417
		418	Checks wether the named attachment is currently attached to the object.
		419
		420	=item cf::CLASS->attach ...
		421
		422	=item cf::CLASS->detach ...
		423
		424	Define an anonymous attachment and attach it to all objects of the given
		425	CLASS. See the next function for an explanation of its arguments.
		426
		427	You can attach to global events by using the C<cf::global> class.
		428
		429	Example, log all player logins:
		430
		431	cf::player->attach (
		432	on_login => sub {
		433	my ($pl) = @_;
		434	...
		435	},
		436	);
		437
		438	Example, attach to the jeweler skill:
		439
		440	cf::object->attach (
		441	type => cf::SKILL,
		442	subtype => cf::SK_JEWELER,
		443	on_use_skill => sub {
		444	my ($sk, $ob, $part, $dir, $msg) = @_;
		445	...
		446	},
		447	);
		448
		449	=item cf::CLASS::attachment $name, ...
		450
		451	Register an attachment by C<$name> through which attachable objects of the
		452	given CLASS can refer to this attachment.
		453
		454	Some classes such as crossfire maps and objects can specify attachments
		455	that are attached at load/instantiate time, thus the need for a name.
		456
		457	These calls expect any number of the following handler/hook descriptions:
		458
		459	=over 4
		460
		461	=item prio => $number
		462
		463	Set the priority for all following handlers/hooks (unless overwritten
		464	by another C<prio> setting). Lower priority handlers get executed
		465	earlier. The default priority is C<0>, and many built-in handlers are
		466	registered at priority C<-1000>, so lower priorities should not be used
		467	unless you know what you are doing.
		468
		469	=item type => $type
		470
		471	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		472	given type of objects only (the additional parameter C<subtype> can be
		473	used to further limit to the given subtype).
		474
		475	=item on_I<event> => \&cb
		476
		477	Call the given code reference whenever the named event happens (event is
		478	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		479	handlers are recognised generally depends on the type of object these
		480	handlers attach to).
		481
		482	See F<include/eventinc.h> for the full list of events supported, and their
		483	class.
		484
		485	=item package => package::
		486
		487	Look for sub functions of the name C<< on_I<event> >> in the given
		488	package and register them. Only handlers for eevents supported by the
		489	object/class are recognised.
		490
		491	=back
		492
		493	Example, define an attachment called "sockpuppet" that calls the given
		494	event handler when a monster attacks:
		495
		496	cf::object::attachment sockpuppet =>
		497	on_skill_attack => sub {
		498	my ($self, $victim) = @_;
		499	...
		500	}
		501	}
		502
		503	=item $attachable->valid
		504
		505	Just because you have a perl object does not mean that the corresponding
		506	C-level object still exists. If you try to access an object that has no
		507	valid C counterpart anymore you get an exception at runtime. This method
		508	can be used to test for existence of the C object part without causing an
		509	exception.
		510
		511	=cut
		512
		513	# the following variables are defined in .xs and must not be re-created
		514	our @CB_GLOBAL = (); # registry for all global events
		515	our @CB_ATTACHABLE = (); # registry for all attachables
		516	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		517	our @CB_PLAYER = ();
		518	our @CB_CLIENT = ();
		519	our @CB_TYPE = (); # registry for type (cf-object class) based events
		520	our @CB_MAP = ();
		521
		522	my %attachment;
		523
		524	sub cf::attachable::thawer_merge {
		525	# simply override everything except _meta
		526	local $_[0]{_meta};
		527	%{$_[0]} = %{$_[1]};
		528	}
		529
		530	sub _attach_cb($$$$) {
		531	my ($registry, $event, $prio, $cb) = @_;
		532
		533	use sort 'stable';
		534
		535	$cb = [$prio, $cb];
		536
		537	@{$registry->[$event]} = sort
		538	{ $a->[0] cmp $b->[0] }
		539	@{$registry->[$event] || []}, $cb;
		540	}
		541
		542	# hack
		543	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		544
		545	# attach handles attaching event callbacks
		546	# the only thing the caller has to do is pass the correct
		547	# registry (== where the callback attaches to).
		548	sub _attach {
		549	my ($registry, $klass, @arg) = @_;
		550
		551	my $object_type;
		552	my $prio = 0;
		553	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		554
		555	#TODO: get rid of this hack
		556	if ($attachable_klass{$klass}) {
		557	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		558	}
		559
		560	while (@arg) {
		561	my $type = shift @arg;
		562
		563	if ($type eq "prio") {
		564	$prio = shift @arg;
		565
		566	} elsif ($type eq "type") {
		567	$object_type = shift @arg;
		568	$registry = $CB_TYPE[$object_type] ||= [];
		569
		570	} elsif ($type eq "subtype") {
		571	defined $object_type or Carp::croak "subtype specified without type";
		572	my $object_subtype = shift @arg;
		573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		574
		575	} elsif ($type eq "package") {
		576	my $pkg = shift @arg;
		577
		578	while (my ($name, $id) = each %cb_id) {
		579	if (my $cb = $pkg->can ($name)) {
		580	_attach_cb $registry, $id, $prio, $cb;
		581	}
		582	}
		583
		584	} elsif (exists $cb_id{$type}) {
		585	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		586
		587	} elsif (ref $type) {
		588	warn "attaching objects not supported, ignoring.\n";
		589
		590	} else {
		591	shift @arg;
		592	warn "attach argument '$type' not supported, ignoring.\n";
		593	}
		594	}
		595	}
		596
		597	sub _object_attach {
		598	my ($obj, $name, %arg) = @_;
		599
		600	return if exists $obj->{_attachment}{$name};
		601
		602	if (my $attach = $attachment{$name}) {
		603	my $registry = $obj->registry;
		604
		605	for (@$attach) {
		606	my ($klass, @attach) = @$_;
		607	_attach $registry, $klass, @attach;
		608	}
		609
		610	$obj->{$name} = \%arg;
		611	} else {
		612	warn "object uses attachment '$name' that is not available, postponing.\n";
		613	}
		614
		615	$obj->{_attachment}{$name} = undef;
		616	}
		617
		618	sub cf::attachable::attach {
		619	if (ref $_[0]) {
		620	_object_attach @_;
		621	} else {
		622	_attach shift->_attach_registry, @_;
		623	}
		624	};
		625
		626	# all those should be optimised
		627	sub cf::attachable::detach {
		628	my ($obj, $name) = @_;
		629
		630	if (ref $obj) {
		631	delete $obj->{_attachment}{$name};
		632	reattach ($obj);
		633	} else {
		634	Carp::croak "cannot, currently, detach class attachments";
		635	}
		636	};
		637
		638	sub cf::attachable::attached {
		639	my ($obj, $name) = @_;
		640
		641	exists $obj->{_attachment}{$name}
		642	}
		643
		644	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		645	eval "#line " . __LINE__ . " 'cf.pm'
		646	sub cf::\L$klass\E::_attach_registry {
		647	(\\\@CB_$klass, KLASS_$klass)
		648	}
		649
		650	sub cf::\L$klass\E::attachment {
		651	my \$name = shift;
		652
		653	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		654	}
		655	";
		656	die if $@;
		657	}
		658
		659	our $override;
		660	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		661
		662	sub override {
		663	$override = 1;
		664	@invoke_results = ();
		665	}
		666
		667	sub do_invoke {
90	my $event = shift;	668	my $event = shift;
		669	my $callbacks = shift;
91		670
92	my $cb = $hook[$event]	671	@invoke_results = ();
		672
		673	local $override;
		674
		675	for (@$callbacks) {
		676	eval { &{$_->[1]} };
		677
		678	if ($@) {
		679	warn "$@";
		680	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		681	override;
		682	}
		683
		684	return 1 if $override;
		685	}
		686
		687	0
		688	}
		689
		690	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		691
		692	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		693
		694	Generate an object-specific event with the given arguments.
		695
		696	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		697	removed in future versions), and there is no public API to access override
		698	results (if you must, access C<@cf::invoke_results> directly).
		699
		700	=back
		701
		702	=cut
		703
		704	#############################################################################
		705	# object support
		706
		707	sub reattach {
		708	# basically do the same as instantiate, without calling instantiate
		709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		712
		713	my $registry = $obj->registry;
		714
		715	@$registry = ();
		716
		717	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		718
		719	for my $name (keys %{ $obj->{_attachment} || {} }) {
		720	if (my $attach = $attachment{$name}) {
		721	for (@$attach) {
		722	my ($klass, @attach) = @$_;
		723	_attach $registry, $klass, @attach;
		724	}
		725	} else {
		726	warn "object uses attachment '$name' that is not available, postponing.\n";
		727	}
		728	}
		729	}
		730
		731	cf::attachable->attach (
		732	prio => -1000000,
		733	on_instantiate => sub {
		734	my ($obj, $data) = @_;
		735
		736	$data = from_json $data;
		737
		738	for (@$data) {
		739	my ($name, $args) = @$_;
		740
		741	$obj->attach ($name, %{$args || {} });
		742	}
		743	},
		744	on_reattach => \&reattach,
		745	on_clone => sub {
		746	my ($src, $dst) = @_;
		747
		748	@{$dst->registry} = @{$src->registry};
		749
		750	%$dst = %$src;
		751
		752	%{$dst->{_attachment}} = %{$src->{_attachment}}
		753	if exists $src->{_attachment};
		754	},
		755	);
		756
		757	sub object_freezer_save {
		758	my ($filename, $rdata, $objs) = @_;
		759
		760	sync_job {
		761	if (length $$rdata) {
		762	warn sprintf "saving %s (%d,%d)\n",
		763	$filename, length $$rdata, scalar @$objs;
		764
		765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		766	chmod SAVE_MODE, $fh;
		767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		768	aio_fsync $fh if $cf::USE_FSYNC;
		769	close $fh;
		770
		771	if (@$objs) {
		772	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		773	chmod SAVE_MODE, $fh;
		774	my $data = Storable::nfreeze { version => 1, objs => $objs };
		775	aio_write $fh, 0, (length $data), $data, 0;
		776	aio_fsync $fh if $cf::USE_FSYNC;
		777	close $fh;
		778	aio_rename "$filename.pst~", "$filename.pst";
		779	}
		780	} else {
		781	aio_unlink "$filename.pst";
		782	}
		783
		784	aio_rename "$filename~", $filename;
		785	} else {
		786	warn "FATAL: $filename~: $!\n";
		787	}
		788	} else {
		789	aio_unlink $filename;
		790	aio_unlink "$filename.pst";
		791	}
		792
		793	#d##TODO# nuke non .map-files if exist
		794	if ($filename =~ s/\.map$//) {
		795	aio_unlink $filename;
		796	aio_unlink "$filename.pst";
		797	}
		798	}
		799	}
		800
		801	sub object_freezer_as_string {
		802	my ($rdata, $objs) = @_;
		803
		804	use Data::Dumper;
		805
		806	$$rdata . Dumper $objs
		807	}
		808
		809	sub object_thawer_load {
		810	my ($filename) = @_;
		811
		812	my ($data, $av);
		813
		814	#d#TODO remove .map if file does not exist
		815	aio_stat $filename and $filename =~ s/\.map$//;
		816
		817	(aio_load $filename, $data) >= 0
93	or return;	818	or return;
94		819
95	List::Util::max map &$_, values %$cb	820	unless (aio_stat "$filename.pst") {
96	}	821	(aio_load "$filename.pst", $av) >= 0
97		822	or return;
98	sub inject_command {	823	$av = eval { (Storable::thaw $av)->{objs} };
99	my ($name, $obj, $params) = @_;
100
101	for my $cmd (@{ $command{$name} }) {
102	$cmd->[1]->($obj, $params);
103	}	824	}
104		825
105	-1	826	warn sprintf "loading %s (%d)\n",
		827	$filename, length $data, scalar @{$av || []};#d#
		828	return ($data, $av);
106	}	829	}
		830
		831	#############################################################################
		832	# command handling &c
		833
		834	=item cf::register_command $name => \&callback($ob,$args);
		835
		836	Register a callback for execution when the client sends the user command
		837	$name.
		838
		839	=cut
107		840
108	sub register_command {	841	sub register_command {
109	my ($name, $time, $cb) = @_;	842	my ($name, $cb) = @_;
110		843
111	my $caller = caller;	844	my $caller = caller;
112	#warn "registering command '$name/$time' to '$caller'";	845	#warn "registering command '$name/$time' to '$caller'";
113		846
114	push @{ $command{$name} }, [$time, $cb, $caller];	847	push @{ $COMMAND{$name} }, [$caller, $cb];
115	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
116	}	848	}
		849
		850	=item cf::register_extcmd $name => \&callback($pl,$packet);
		851
		852	Register a callbackf ro execution when the client sends an extcmd packet.
		853
		854	If the callback returns something, it is sent back as if reply was being
		855	called.
		856
		857	=cut
117		858
118	sub register_extcmd {	859	sub register_extcmd {
119	my ($name, $cb) = @_;	860	my ($name, $cb) = @_;
120		861
121	my $caller = caller;	862	$EXTCMD{$name} = $cb;
122	#warn "registering extcmd '$name' to '$caller'";
123
124	$extcmd{$name} = [$cb, $caller];
125	}	863	}
126		864
127	sub register {	865	cf::player->attach (
128	my ($base, $pkg) = @_;	866	on_command => sub {
		867	my ($pl, $name, $params) = @_;
129		868
130	for my $idx (0 .. $#EVENT) {	869	my $cb = $COMMAND{$name}
131	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {	870	or return;
132	#warn "registering $EVENT[$idx] hook to '$pkg'\n";	871
133	$hook[$idx]{$base} = $ref;	872	for my $cmd (@$cb) {
		873	$cmd->[1]->($pl->ob, $params);
134	}	874	}
		875
		876	cf::override;
135	}	877	},
136	}	878	on_extcmd => sub {
		879	my ($pl, $buf) = @_;
		880
		881	my $msg = eval { from_json $buf };
		882
		883	if (ref $msg) {
		884	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		885	if (my %reply = $cb->($pl, $msg)) {
		886	$pl->ext_reply ($msg->{msgid}, %reply);
		887	}
		888	}
		889	} else {
		890	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		891	}
		892
		893	cf::override;
		894	},
		895	);
137		896
138	sub load_extension {	897	sub load_extension {
139	my ($path) = @_;	898	my ($path) = @_;
140		899
141	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
142	my $base = $1;	901	my $base = $1;
143	my $pkg = $1;	902	my $pkg = $1;
144	$pkg =~ s/[^[:word:]]/_/g;	903	$pkg =~ s/[^[:word:]]/_/g;
145	$pkg = "cf::ext::$pkg";	904	$pkg = "ext::$pkg";
146		905
147	warn "loading '$path' into '$pkg'\n";	906	warn "... loading '$path' into '$pkg'\n";
148		907
149	open my $fh, "<:utf8", $path	908	open my $fh, "<:utf8", $path
150	or die "$path: $!";	909	or die "$path: $!";
151		910
152	my $source =	911	my $source =
153	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8;\n"
154	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
155	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
156	. "\n};\n1";	915	. "\n};\n1";
157		916
158	eval $source	917	unless (eval $source) {
159	or die "$path: $@";	918	my $msg = $@ ? "$path: $@\n"
		919	: "extension disabled.\n";
		920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
		921	warn $@;
		922	warn "mandatory extension failed to load, exiting.\n";
		923	exit 1;
		924	}
		925	die $@;
		926	}
160		927
161	push @exts, $pkg;	928	push @EXTS, $pkg;
162	$ext_pkg{$base} = $pkg;
163
164	# no strict 'refs';
165	# @{"$pkg\::ISA"} = cf::ext::;
166
167	register $base, $pkg;
168	}
169
170	sub unload_extension {
171	my ($pkg) = @_;
172
173	warn "removing extension $pkg\n";
174
175	# remove hooks
176	for my $idx (0 .. $#EVENT) {
177	delete $hook[$idx]{$pkg};
178	}
179
180	# remove commands
181	for my $name (keys %command) {
182	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
183
184	if (@cb) {
185	$command{$name} = \@cb;
186	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
187	} else {
188	delete $command{$name};
189	delete $COMMAND{"$name\000"};
190	}
191	}
192
193	# remove extcmds
194	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
195	delete $extcmd{$name};
196	}
197
198	Symbol::delete_package $pkg;
199	}	929	}
200		930
201	sub load_extensions {	931	sub load_extensions {
202	my $LIBDIR = maps_directory "perl";
203
204	for my $ext (<$LIBDIR/*.ext>) {	932	for my $ext (<$LIBDIR/*.ext>) {
205	next unless -r $ext;	933	next unless -r $ext;
206	eval {	934	eval {
207	load_extension $ext;	935	load_extension $ext;
208	1	936	1
209	} or warn "$ext not loaded: $@";	937	} or warn "$ext not loaded: $@";
210	}	938	}
211	}	939	}
212		940
213	register_command "perl-reload", 0, sub {	941	#############################################################################
		942
		943	=head2 CORE EXTENSIONS
		944
		945	Functions and methods that extend core crossfire objects.
		946
		947	=cut
		948
		949	package cf::player;
		950
		951	use Coro::AIO;
		952
		953	=head3 cf::player
		954
		955	=over 4
		956
		957	=item cf::player::find $login
		958
		959	Returns the given player object, loading it if necessary (might block).
		960
		961	=cut
		962
		963	sub playerdir($) {
		964	cf::localdir
		965	. "/"
		966	. cf::playerdir
		967	. "/"
		968	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		969	}
		970
		971	sub path($) {
		972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		973
		974	(playerdir $login) . "/$login.pl"
		975	}
		976
		977	sub find_active($) {
		978	$cf::PLAYER{$_[0]}
		979	and $cf::PLAYER{$_[0]}->active
		980	and $cf::PLAYER{$_[0]}
		981	}
		982
		983	sub exists($) {
		984	my ($login) = @_;
		985
		986	$cf::PLAYER{$login}
		987	or cf::sync_job { !aio_stat path $login }
		988	}
		989
		990	sub find($) {
		991	return $cf::PLAYER{$_[0]} || do {
		992	my $login = $_[0];
		993
		994	my $guard = cf::lock_acquire "user_find:$login";
		995
		996	$cf::PLAYER{$_[0]} || do {
		997	my $pl = load_pl path $login
		998	or return;
		999	$cf::PLAYER{$login} = $pl
		1000	}
		1001	}
		1002	}
		1003
		1004	sub save($) {
		1005	my ($pl) = @_;
		1006
		1007	return if $pl->{deny_save};
		1008
		1009	my $path = path $pl;
		1010	my $guard = cf::lock_acquire "user_save:$path";
		1011
		1012	return if $pl->{deny_save};
		1013
		1014	aio_mkdir playerdir $pl, 0770;
		1015	$pl->{last_save} = $cf::RUNTIME;
		1016
		1017	$pl->save_pl ($path);
		1018	Coro::cede;
		1019	}
		1020
		1021	sub new($) {
		1022	my ($login) = @_;
		1023
		1024	my $self = create;
		1025
		1026	$self->ob->name ($login);
		1027	$self->{deny_save} = 1;
		1028
		1029	$cf::PLAYER{$login} = $self;
		1030
		1031	$self
		1032	}
		1033
		1034	=item $pl->quit_character
		1035
		1036	Nukes the player without looking back. If logged in, the connection will
		1037	be destroyed. May block for a long time.
		1038
		1039	=cut
		1040
		1041	sub quit_character {
		1042	my ($pl) = @_;
		1043
		1044	$pl->{deny_save} = 1;
		1045	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1046
		1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1048	$pl->deactivate;
		1049	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1050	$pl->ns->destroy if $pl->ns;
		1051
		1052	my $path = playerdir $pl;
		1053	my $temp = "$path~$cf::RUNTIME~deleting~";
		1054	aio_rename $path, $temp;
		1055	delete $cf::PLAYER{$pl->ob->name};
		1056	$pl->destroy;
		1057	IO::AIO::aio_rmtree $temp;
		1058	}
		1059
		1060	=item cf::player::list_logins
		1061
		1062	Returns am arrayref of all valid playernames in the system, can take a
		1063	while and may block, so not sync_job-capable, ever.
		1064
		1065	=cut
		1066
		1067	sub list_logins {
		1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1069	or return [];
		1070
		1071	my @logins;
		1072
		1073	for my $login (@$dirs) {
		1074	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1075	aio_read $fh, 0, 512, my $buf, 0 or next;
		1076	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1077
		1078	utf8::decode $login;
		1079	push @logins, $login;
		1080	}
		1081
		1082	\@logins
		1083	}
		1084
		1085	=item $player->maps
		1086
		1087	Returns an arrayref of map paths that are private for this
		1088	player. May block.
		1089
		1090	=cut
		1091
		1092	sub maps($) {
		1093	my ($pl) = @_;
		1094
		1095	$pl = ref $pl ? $pl->ob->name : $pl;
		1096
		1097	my $files = aio_readdir playerdir $pl
		1098	or return;
		1099
		1100	my @paths;
		1101
		1102	for (@$files) {
		1103	utf8::decode $_;
		1104	next if /\.(?:pl|pst)$/;
		1105	next unless /^$PATH_SEP/o;
		1106
		1107	push @paths, cf::map::normalise "~$pl/$_";
		1108	}
		1109
		1110	\@paths
		1111	}
		1112
		1113	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1114
		1115	Sends an ext reply to the player.
		1116
		1117	=cut
		1118
		1119	sub ext_reply($$$%) {
		1120	my ($self, $id, %msg) = @_;
		1121
		1122	$msg{msgid} = $id;
		1123
		1124	$self->send ("ext " . cf::to_json \%msg);
		1125	}
		1126
		1127	package cf;
		1128
		1129	=back
		1130
		1131
		1132	=head3 cf::map
		1133
		1134	=over 4
		1135
		1136	=cut
		1137
		1138	package cf::map;
		1139
		1140	use Fcntl;
		1141	use Coro::AIO;
		1142
		1143	use overload
		1144	'""' => \&as_string,
		1145	fallback => 1;
		1146
		1147	our $MAX_RESET = 3600;
		1148	our $DEFAULT_RESET = 3000;
		1149
		1150	sub generate_random_map {
		1151	my ($self, $rmp) = @_;
		1152	# mit "rum" bekleckern, nicht
		1153	$self->_create_random_map (
		1154	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1155	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1156	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1157	$rmp->{exit_on_final_map},
		1158	$rmp->{xsize}, $rmp->{ysize},
		1159	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1160	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1161	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1162	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1163	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1164	(cf::region::find $rmp->{region}), $rmp->{custom}
		1165	)
		1166	}
		1167
		1168	=item cf::map->register ($regex, $prio)
		1169
		1170	Register a handler for the map path matching the given regex at the
		1171	givne priority (higher is better, built-in handlers have priority 0, the
		1172	default).
		1173
		1174	=cut
		1175
		1176	sub register {
		1177	my (undef, $regex, $prio) = @_;
		1178	my $pkg = caller;
		1179
		1180	no strict;
		1181	push @{"$pkg\::ISA"}, __PACKAGE__;
		1182
		1183	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1184	}
		1185
		1186	# also paths starting with '/'
		1187	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1188
		1189	sub thawer_merge {
		1190	my ($self, $merge) = @_;
		1191
		1192	# we have to keep some variables in memory intact
		1193	local $self->{path};
		1194	local $self->{load_path};
		1195	local $self->{deny_save};
		1196	local $self->{deny_reset};
		1197
		1198	$self->SUPER::thawer_merge ($merge);
		1199	}
		1200
		1201	sub normalise {
214	my ($who, $arg) = @_;	1202	my ($path, $base) = @_;
215		1203
216	if ($who->flag (FLAG_WIZ)) {	1204	$path = "$path"; # make sure its a string
217	$who->message ("reloading...");
218		1205
219	warn "reloading...\n";	1206	$path =~ s/\.map$//;
		1207
		1208	# map plan:
		1209	#
		1210	# /! non-realised random map exit (special hack!)
		1211	# {... are special paths that are not being touched
		1212	# ?xxx/... are special absolute paths
		1213	# ?random/... random maps
		1214	# /... normal maps
		1215	# ~user/... per-player map of a specific user
		1216
		1217	$path =~ s/$PATH_SEP/\//go;
		1218
		1219	# treat it as relative path if it starts with
		1220	# something that looks reasonable
		1221	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1222	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1223
		1224	$base =~ s{[^/]+/?$}{};
		1225	$path = "$base/$path";
		1226	}
		1227
		1228	for ($path) {
		1229	redo if s{//}{/};
		1230	redo if s{/\.?/}{/};
		1231	redo if s{/[^/]+/\.\./}{/};
		1232	}
		1233
		1234	$path
		1235	}
		1236
		1237	sub new_from_path {
		1238	my (undef, $path, $base) = @_;
		1239
		1240	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1241
		1242	$path = normalise $path, $base;
		1243
		1244	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1245	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1246	my $self = bless cf::map::new, $pkg;
		1247	$self->{path} = $path; $self->path ($path);
		1248	$self->init; # pass $1 etc.
		1249	return $self;
		1250	}
		1251	}
		1252
		1253	Carp::carp "unable to resolve path '$path' (base '$base').";
		1254	()
		1255	}
		1256
		1257	sub init {
		1258	my ($self) = @_;
		1259
		1260	$self
		1261	}
		1262
		1263	sub as_string {
		1264	my ($self) = @_;
		1265
		1266	"$self->{path}"
		1267	}
		1268
		1269	# the displayed name, this is a one way mapping
		1270	sub visible_name {
		1271	&as_string
		1272	}
		1273
		1274	# the original (read-only) location
		1275	sub load_path {
		1276	my ($self) = @_;
		1277
		1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1279	}
		1280
		1281	# the temporary/swap location
		1282	sub save_path {
		1283	my ($self) = @_;
		1284
		1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1287	}
		1288
		1289	# the unique path, undef == no special unique path
		1290	sub uniq_path {
		1291	my ($self) = @_;
		1292
		1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1295	}
		1296
		1297	# and all this just because we cannot iterate over
		1298	# all maps in C++...
		1299	sub change_all_map_light {
		1300	my ($change) = @_;
		1301
		1302	$_->change_map_light ($change)
		1303	for grep $_->outdoor, values %cf::MAP;
		1304	}
		1305
		1306	sub unlink_save {
		1307	my ($self) = @_;
		1308
		1309	utf8::encode (my $save = $self->save_path);
		1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1311	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1312
		1313	#d#TODO remove .map and also nuke
		1314	$save =~ s/\.map// or return;#d#
		1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
		1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
		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 {
		1475	my ($map) = @_;
		1476
		1477	my @diag; # diagonal neighbours
		1478
		1479	for (0 .. 3) {
		1480	my $neigh = $map->tile_path ($_)
		1481	or next;
		1482	$neigh = find $neigh, $map
		1483	or next;
		1484	$neigh->load;
		1485
		1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1488	}
		1489
		1490	for (@diag) {
		1491	my $neigh = find @$_
		1492	or next;
		1493	$neigh->load;
		1494	}
		1495	}
		1496
		1497	sub find_sync {
		1498	my ($path, $origin) = @_;
		1499
		1500	cf::sync_job { find $path, $origin }
		1501	}
		1502
		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};
		1530	}
		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);
		1566	}
		1567	}
		1568
		1569	sub swap_out {
		1570	my ($self) = @_;
		1571
		1572	# save first because save cedes
		1573	$self->save;
		1574
		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;
		1687
		1688	=over 4
		1689
		1690	=item $ob->inv_recursive
		1691
		1692	Returns the inventory of the object _and_ their inventories, recursively.
		1693
		1694	=cut
		1695
		1696	sub inv_recursive_;
		1697	sub inv_recursive_ {
		1698	map { $_, inv_recursive_ $_->inv } @_
		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
		1712
		1713	=item $player_object->reply ($npc, $msg[, $flags])
		1714
		1715	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
		1716	can be C<undef>. Does the right thing when the player is currently in a
		1717	dialogue with the given NPC character.
		1718
		1719	=cut
		1720
		1721	# rough implementation of a future "reply" method that works
		1722	# with dialog boxes.
		1723	#TODO: the first argument must go, split into a $npc->reply_to ( method
		1724	sub cf::object::player::reply($$$;$) {
		1725	my ($self, $npc, $msg, $flags) = @_;
		1726
		1727	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
		1728
		1729	if ($self->{record_replies}) {
		1730	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		1731	} else {
		1732	$msg = $npc->name . " says: $msg" if $npc;
		1733	$self->message ($msg, $flags);
		1734	}
		1735	}
		1736
		1737	=item $player_object->may ("access")
		1738
		1739	Returns wether the given player is authorized to access resource "access"
		1740	(e.g. "command_wizcast").
		1741
		1742	=cut
		1743
		1744	sub cf::object::player::may {
		1745	my ($self, $access) = @_;
		1746
		1747	$self->flag (cf::FLAG_WIZ) ||
		1748	(ref $cf::CFG{"may_$access"}
		1749	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1750	: $cf::CFG{"may_$access"})
		1751	}
		1752
		1753	=item $player_object->enter_link
		1754
		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	$self->enter_map ($map, $x, $y);
		1826	}
		1827
		1828	cf::player->attach (
		1829	on_logout => sub {
		1830	my ($pl) = @_;
		1831
		1832	# abort map switching before logout
		1833	if ($pl->ob->{_link_pos}) {
		1834	cf::sync_job {
		1835	$pl->ob->leave_link
		1836	};
		1837	}
		1838	},
		1839	on_login => sub {
		1840	my ($pl) = @_;
		1841
		1842	# try to abort aborted map switching on player login :)
		1843	# should happen only on crashes
		1844	if ($pl->ob->{_link_pos}) {
		1845	$pl->ob->enter_link;
		1846	(async {
		1847	# we need this sleep as the login has a concurrent enter_exit running
		1848	# and this sleep increases chances of the player not ending up in scorn
		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	Coro::Timer::sleep 1;
		1854	$pl->ob->leave_link;
		1855	})->prio (2);
		1856	}
		1857	},
		1858	);
		1859
		1860	=item $player_object->goto ($path, $x, $y)
		1861
		1862	=cut
		1863
		1864	sub cf::object::player::goto {
		1865	my ($self, $path, $x, $y) = @_;
		1866
		1867	$self->enter_link;
		1868
		1869	(async {
		1870	my $map = eval {
		1871	my $map = cf::map::find $path;
		1872	$map = $map->customise_for ($self) if $map;
		1873	$map
		1874	} or
		1875	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1876
		1877	$self->leave_link ($map, $x, $y);
		1878	})->prio (1);
		1879	}
		1880
		1881	=item $player_object->enter_exit ($exit_object)
		1882
		1883	=cut
		1884
		1885	sub parse_random_map_params {
		1886	my ($spec) = @_;
		1887
		1888	my $rmp = { # defaults
		1889	xsize => (cf::rndm 15, 40),
		1890	ysize => (cf::rndm 15, 40),
		1891	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1892	#layout => string,
		1893	};
		1894
		1895	for (split /\n/, $spec) {
		1896	my ($k, $v) = split /\s+/, $_, 2;
		1897
		1898	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1899	}
		1900
		1901	$rmp
		1902	}
		1903
		1904	sub prepare_random_map {
		1905	my ($exit) = @_;
		1906
		1907	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1908
		1909	# all this does is basically replace the /! path by
		1910	# a new random map path (?random/...) with a seed
		1911	# that depends on the exit object
		1912
		1913	my $rmp = parse_random_map_params $exit->msg;
		1914
		1915	if ($exit->map) {
		1916	$rmp->{region} = $exit->region->name;
		1917	$rmp->{origin_map} = $exit->map->path;
		1918	$rmp->{origin_x} = $exit->x;
		1919	$rmp->{origin_y} = $exit->y;
		1920	}
		1921
		1922	$rmp->{random_seed} ||= $exit->random_seed;
		1923
		1924	my $data = cf::to_json $rmp;
		1925	my $md5 = Digest::MD5::md5_hex $data;
		1926	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1927
		1928	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1929	aio_write $fh, 0, (length $data), $data, 0;
		1930	undef $fh;
		1931	aio_rename "$meta~", $meta;
		1932
		1933	$exit->slaying ("?random/$md5");
		1934	$exit->msg (undef);
		1935	}
		1936	}
		1937
		1938	sub cf::object::player::enter_exit {
		1939	my ($self, $exit) = @_;
		1940
		1941	return unless $self->type == cf::PLAYER;
		1942
		1943	if ($exit->slaying eq "/!") {
		1944	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1945	cf::sync_job { prepare_random_map $exit };
		1946	}
		1947
		1948	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1949	my $hp = $exit->stats->hp;
		1950	my $sp = $exit->stats->sp;
		1951
		1952	$self->enter_link;
		1953
		1954	(async {
		1955	$self->deactivate_recursive; # just to be sure
		1956	unless (eval {
		1957	$self->goto ($slaying, $hp, $sp);
		1958
		1959	1;
		1960	}) {
		1961	$self->message ("Something went wrong deep within the crossfire server. "
		1962	. "I'll try to bring you back to the map you were before. "
		1963	. "Please report this to the dungeon master!",
		1964	cf::NDI_UNIQUE | cf::NDI_RED);
		1965
		1966	warn "ERROR in enter_exit: $@";
		1967	$self->leave_link;
		1968	}
		1969	})->prio (1);
		1970	}
		1971
		1972	=head3 cf::client
		1973
		1974	=over 4
		1975
		1976	=item $client->send_drawinfo ($text, $flags)
		1977
		1978	Sends a drawinfo packet to the client. Circumvents output buffering so
		1979	should not be used under normal circumstances.
		1980
		1981	=cut
		1982
		1983	sub cf::client::send_drawinfo {
		1984	my ($self, $text, $flags) = @_;
		1985
		1986	utf8::encode $text;
		1987	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1988	}
		1989
		1990
		1991	=item $success = $client->query ($flags, "text", \&cb)
		1992
		1993	Queues a query to the client, calling the given callback with
		1994	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1995	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1996
		1997	Queries can fail, so check the return code. Or don't, as queries will become
		1998	reliable at some point in the future.
		1999
		2000	=cut
		2001
		2002	sub cf::client::query {
		2003	my ($self, $flags, $text, $cb) = @_;
		2004
		2005	return unless $self->state == ST_PLAYING
		2006	|| $self->state == ST_SETUP
		2007	|| $self->state == ST_CUSTOM;
		2008
		2009	$self->state (ST_CUSTOM);
		2010
		2011	utf8::encode $text;
		2012	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2013
		2014	$self->send_packet ($self->{query_queue}[0][0])
		2015	if @{ $self->{query_queue} } == 1;
		2016	}
		2017
		2018	cf::client->attach (
		2019	on_reply => sub {
		2020	my ($ns, $msg) = @_;
		2021
		2022	# this weird shuffling is so that direct followup queries
		2023	# get handled first
		2024	my $queue = delete $ns->{query_queue}
		2025	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2026
		2027	(shift @$queue)->[1]->($msg);
		2028	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2029
		2030	push @{ $ns->{query_queue} }, @$queue;
		2031
		2032	if (@{ $ns->{query_queue} } == @$queue) {
		2033	if (@$queue) {
		2034	$ns->send_packet ($ns->{query_queue}[0][0]);
		2035	} else {
		2036	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2037	}
		2038	}
		2039	},
		2040	);
		2041
		2042	=item $client->async (\&cb)
		2043
		2044	Create a new coroutine, running the specified callback. The coroutine will
		2045	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2046	or loss of connection).
		2047
		2048	=cut
		2049
		2050	sub cf::client::async {
		2051	my ($self, $cb) = @_;
		2052
		2053	my $coro = &Coro::async ($cb);
		2054
		2055	$coro->on_destroy (sub {
		2056	delete $self->{_coro}{$coro+0};
		2057	});
		2058
		2059	$self->{_coro}{$coro+0} = $coro;
		2060
		2061	$coro
		2062	}
		2063
		2064	cf::client->attach (
		2065	on_destroy => sub {
		2066	my ($ns) = @_;
		2067
		2068	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2069	},
		2070	);
		2071
		2072	=back
		2073
		2074
		2075	=head2 SAFE SCRIPTING
		2076
		2077	Functions that provide a safe environment to compile and execute
		2078	snippets of perl code without them endangering the safety of the server
		2079	itself. Looping constructs, I/O operators and other built-in functionality
		2080	is not available in the safe scripting environment, and the number of
		2081	functions and methods that can be called is greatly reduced.
		2082
		2083	=cut
		2084
		2085	our $safe = new Safe "safe";
		2086	our $safe_hole = new Safe::Hole;
		2087
		2088	$SIG{FPE} = 'IGNORE';
		2089
		2090	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
		2091
		2092	# here we export the classes and methods available to script code
		2093
		2094	=pod
		2095
		2096	The following fucntions and emthods are available within a safe environment:
		2097
		2098	cf::object contr pay_amount pay_player map
		2099	cf::object::player player
		2100	cf::player peaceful
		2101	cf::map trigger
		2102
		2103	=cut
		2104
		2105	for (
		2106	["cf::object" => qw(contr pay_amount pay_player map)],
		2107	["cf::object::player" => qw(player)],
		2108	["cf::player" => qw(peaceful)],
		2109	["cf::map" => qw(trigger)],
		2110	) {
		2111	no strict 'refs';
		2112	my ($pkg, @funs) = @$_;
		2113	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
		2114	for @funs;
		2115	}
		2116
		2117	=over 4
		2118
		2119	=item @retval = safe_eval $code, [var => value, ...]
		2120
		2121	Compiled and executes the given perl code snippet. additional var/value
		2122	pairs result in temporary local (my) scalar variables of the given name
		2123	that are available in the code snippet. Example:
		2124
		2125	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2126
		2127	=cut
		2128
		2129	sub safe_eval($;@) {
		2130	my ($code, %vars) = @_;
		2131
		2132	my $qcode = $code;
		2133	$qcode =~ s/"/‟/g; # not allowed in #line filenames
		2134	$qcode =~ s/\n/\\n/g;
		2135
		2136	local $_;
		2137	local @safe::cf::_safe_eval_args = values %vars;
		2138
		2139	my $eval =
		2140	"do {\n"
		2141	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
		2142	. "#line 0 \"{$qcode}\"\n"
		2143	. $code
		2144	. "\n}"
		2145	;
		2146
		2147	sub_generation_inc;
		2148	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
		2149	sub_generation_inc;
		2150
		2151	if ($@) {
		2152	warn "$@";
		2153	warn "while executing safe code '$code'\n";
		2154	warn "with arguments " . (join " ", %vars) . "\n";
		2155	}
		2156
		2157	wantarray ? @res : $res[0]
		2158	}
		2159
		2160	=item cf::register_script_function $function => $cb
		2161
		2162	Register a function that can be called from within map/npc scripts. The
		2163	function should be reasonably secure and should be put into a package name
		2164	like the extension.
		2165
		2166	Example: register a function that gets called whenever a map script calls
		2167	C<rent::overview>, as used by the C<rent> extension.
		2168
		2169	cf::register_script_function "rent::overview" => sub {
		2170	...
		2171	};
		2172
		2173	=cut
		2174
		2175	sub register_script_function {
		2176	my ($fun, $cb) = @_;
		2177
		2178	no strict 'refs';
		2179	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		2180	}
		2181
		2182	=back
		2183
		2184	=cut
		2185
		2186	#############################################################################
		2187
		2188	=head2 EXTENSION DATABASE SUPPORT
		2189
		2190	Crossfire maintains a very simple database for extension use. It can
		2191	currently store anything that can be serialised using Storable, which
		2192	excludes objects.
		2193
		2194	The parameter C<$family> should best start with the name of the extension
		2195	using it, it should be unique.
		2196
		2197	=over 4
		2198
		2199	=item $value = cf::db_get $family => $key
		2200
		2201	Returns a single value from the database.
		2202
		2203	=item cf::db_put $family => $key => $value
		2204
		2205	Stores the given C<$value> in the family.
		2206
		2207	=cut
		2208
		2209	our $DB;
		2210
		2211	sub db_init {
		2212	unless ($DB) {
		2213	$DB = BDB::db_create $DB_ENV;
		2214
		2215	cf::sync_job {
		2216	eval {
		2217	$DB->set_flags (BDB::CHKSUM);
		2218
		2219	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2220	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2221	cf::cleanup "db_open(db): $!" if $!;
		2222	};
		2223	cf::cleanup "db_open(db): $@" if $@;
		2224	};
		2225
		2226	my $path = cf::localdir . "/database.pst";
		2227	if (stat $path) {
		2228	cf::sync_job {
		2229	my $pst = Storable::retrieve $path;
		2230
		2231	cf::db_put (board => data => $pst->{board});
		2232	cf::db_put (guildrules => data => $pst->{guildrules});
		2233	cf::db_put (rent => balance => $pst->{rent}{balance});
		2234	BDB::db_env_txn_checkpoint $DB_ENV;
		2235
		2236	unlink $path;
		2237	};
		2238	}
		2239	}
		2240	}
		2241
		2242	sub db_get($$) {
		2243	my $key = "$_[0]/$_[1]";
		2244
		2245	cf::sync_job {
		2246	BDB::db_get $DB, undef, $key, my $data;
		2247
		2248	$! ? ()
		2249	: Compress::LZF::sthaw $data
		2250	}
		2251	}
		2252
		2253	sub db_put($$$) {
		2254	BDB::dbreq_pri 4;
		2255	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
		2256	}
		2257
		2258	#############################################################################
		2259	# the server's init and main functions
		2260
		2261	sub load_resources {
		2262	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2263	or die "unable to load regions file\n";#d#
		2264	}
		2265
		2266	sub cfg_load {
		2267	open my $fh, "<:utf8", cf::confdir . "/config"
		2268	or return;
		2269
		2270	local $/;
		2271	*CFG = YAML::Syck::Load <$fh>;
		2272
		2273	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2274
		2275	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2276	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2277
		2278	if (exists $CFG{mlockall}) {
220	eval {	2279	eval {
221	$_->cancel for Event::all_watchers;	2280	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
222		2281	and die "WARNING: m(un)lockall failed: $!\n";
223	unload_extension $_ for @exts;
224	delete $INC{"cf.pm"};
225
226	# don't, removes xs symbols, too
227	#Symbol::delete_package $pkg;
228
229	require cf;
230	};	2282	};
231	warn $@ if $@;	2283	warn $@ if $@;
232	$who->message ($@) if $@;	2284	}
233	warn "reloaded\n";	2285	}
234		2286
235	$who->message ("reloaded");	2287	sub init {
236	} else {	2288	load_resources;
237	$who->message ("Intruder Alert!");	2289	}
		2290
		2291	sub main {
		2292	# we must not ever block the main coroutine
		2293	local $Coro::idle = sub {
		2294	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2295	(async {
		2296	Event::one_event;
		2297	})->prio (Coro::PRIO_MAX);
238	}	2298	};
		2299
		2300	cfg_load;
		2301	db_init;
		2302	load_extensions;
		2303
		2304	$TICK_WATCHER->start;
		2305	$WRITE_RUNTIME_WATCHER->start;
		2306	Event::loop;
		2307	}
		2308
		2309	#############################################################################
		2310	# initialisation and cleanup
		2311
		2312	# install some emergency cleanup handlers
		2313	BEGIN {
		2314	for my $signal (qw(INT HUP TERM)) {
		2315	Event->signal (
		2316	reentrant => 0,
		2317	data => WF_AUTOCANCEL,
		2318	signal => $signal,
		2319	prio => 0,
		2320	cb => sub {
		2321	cf::cleanup "SIG$signal";
		2322	},
		2323	);
		2324	}
		2325	}
		2326
		2327	sub emergency_save() {
		2328	my $freeze_guard = cf::freeze_mainloop;
		2329
		2330	warn "enter emergency perl save\n";
		2331
		2332	cf::sync_job {
		2333	# use a peculiar iteration method to avoid tripping on perl
		2334	# refcount bugs in for. also avoids problems with players
		2335	# and maps saved/destroyed asynchronously.
		2336	warn "begin emergency player save\n";
		2337	for my $login (keys %cf::PLAYER) {
		2338	my $pl = $cf::PLAYER{$login} or next;
		2339	$pl->valid or next;
		2340	$pl->save;
		2341	}
		2342	warn "end emergency player save\n";
		2343
		2344	warn "begin emergency map save\n";
		2345	for my $path (keys %cf::MAP) {
		2346	my $map = $cf::MAP{$path} or next;
		2347	$map->valid or next;
		2348	$map->save;
		2349	}
		2350	warn "end emergency map save\n";
		2351
		2352	warn "begin emergency database checkpoint\n";
		2353	BDB::db_env_txn_checkpoint $DB_ENV;
		2354	warn "end emergency database checkpoint\n";
		2355	};
		2356
		2357	warn "leave emergency perl save\n";
		2358	}
		2359
		2360	sub post_cleanup {
		2361	my ($make_core) = @_;
		2362
		2363	warn Carp::longmess "post_cleanup backtrace"
		2364	if $make_core;
		2365	}
		2366
		2367	sub reload() {
		2368	# can/must only be called in main
		2369	if ($Coro::current != $Coro::main) {
		2370	warn "can only reload from main coroutine";
		2371	return;
		2372	}
		2373
		2374	warn "reloading...";
		2375
		2376	warn "entering sync_job";
		2377
		2378	cf::sync_job {
		2379	cf::write_runtime;
		2380	cf::emergency_save;
		2381	cf::write_runtime;
		2382
		2383	warn "syncing database to disk";
		2384	BDB::db_env_txn_checkpoint $DB_ENV;
		2385
		2386	# if anything goes wrong in here, we should simply crash as we already saved
		2387
		2388	warn "cancelling all WF_AUTOCANCEL watchers";
		2389	for (Event::all_watchers) {
		2390	$_->cancel if $_->data & WF_AUTOCANCEL;
		2391	}
		2392
		2393	warn "flushing outstanding aio requests";
		2394	for (;;) {
		2395	BDB::flush;
		2396	IO::AIO::flush;
		2397	Coro::cede;
		2398	last unless IO::AIO::nreqs || BDB::nreqs;
		2399	warn "iterate...";
		2400	}
		2401
		2402	warn "cancelling all extension coros";
		2403	$_->cancel for values %EXT_CORO;
		2404	%EXT_CORO = ();
		2405
		2406	warn "removing commands";
		2407	%COMMAND = ();
		2408
		2409	warn "removing ext commands";
		2410	%EXTCMD = ();
		2411
		2412	warn "unloading/nuking all extensions";
		2413	for my $pkg (@EXTS) {
		2414	warn "... unloading $pkg";
		2415
		2416	if (my $cb = $pkg->can ("unload")) {
		2417	eval {
		2418	$cb->($pkg);
		2419	1
		2420	} or warn "$pkg unloaded, but with errors: $@";
		2421	}
		2422
		2423	warn "... nuking $pkg";
		2424	Symbol::delete_package $pkg;
		2425	}
		2426
		2427	warn "unloading all perl modules loaded from $LIBDIR";
		2428	while (my ($k, $v) = each %INC) {
		2429	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2430
		2431	warn "... unloading $k";
		2432	delete $INC{$k};
		2433
		2434	$k =~ s/\.pm$//;
		2435	$k =~ s/\//::/g;
		2436
		2437	if (my $cb = $k->can ("unload_module")) {
		2438	$cb->();
		2439	}
		2440
		2441	Symbol::delete_package $k;
		2442	}
		2443
		2444	warn "getting rid of safe::, as good as possible";
		2445	Symbol::delete_package "safe::$_"
		2446	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2447
		2448	warn "unloading cf.pm \"a bit\"";
		2449	delete $INC{"cf.pm"};
		2450
		2451	# don't, removes xs symbols, too,
		2452	# and global variables created in xs
		2453	#Symbol::delete_package __PACKAGE__;
		2454
		2455	warn "unload completed, starting to reload now";
		2456
		2457	warn "reloading cf.pm";
		2458	require cf;
		2459	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2460
		2461	warn "loading config and database again";
		2462	cf::cfg_load;
		2463
		2464	warn "loading extensions";
		2465	cf::load_extensions;
		2466
		2467	warn "reattaching attachments to objects/players";
		2468	_global_reattach;
		2469	warn "reattaching attachments to maps";
		2470	reattach $_ for values %MAP;
		2471
		2472	warn "loading reloadable resources";
		2473	load_resources;
		2474
		2475	warn "leaving sync_job";
		2476
		2477	1
		2478	} or do {
		2479	warn $@;
		2480	warn "error while reloading, exiting.";
		2481	exit 1;
		2482	};
		2483
		2484	warn "reloaded";
239	};	2485	};
240		2486
241	#############################################################################	2487	our $RELOAD_WATCHER; # used only during reload
242	# extcmd framework, basically convert ext <id> <pkg> arg1 args
243	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
244		2488
245	sub on_extcmd {	2489	register_command "reload" => sub {
246	my ($pl, $buf) = @_;	2490	my ($who, $arg) = @_;
247		2491
248	my ($type) = $buf =~ s/^(\S+) // ? $1 : "";	2492	if ($who->flag (FLAG_WIZ)) {
		2493	$who->message ("reloading server.");
249		2494
250	$extcmd{$type}[0]->($pl, $buf)	2495	# doing reload synchronously and two reloads happen back-to-back,
251	if $extcmd{$type};	2496	# coro crashes during coro_state_free->destroy here.
252	}
253		2497
254	#############################################################################	2498	$RELOAD_WATCHER ||= Event->timer (
255	# load/save/clean perl data associated with a map	2499	reentrant => 0,
256		2500	after => 0,
257	*on_mapclean = sub {	2501	data => WF_AUTOCANCEL,
258	my ($map) = @_;	2502	cb => sub {
259		2503	reload;
260	my $path = $map->tmpname;	2504	undef $RELOAD_WATCHER;
261	defined $path or return;	2505	},
262		2506	);
263	unlink "$path.cfperl";	2507	}
264	};	2508	};
265		2509
266	*on_mapin =	2510	unshift @INC, $LIBDIR;
267	*on_mapload = sub {
268	my ($map) = @_;
269		2511
270	my $path = $map->tmpname;	2512	my $bug_warning = 0;
271	$path = $map->path unless defined $path;
272		2513
273	open my $fh, "<:raw", "$path.cfperl"	2514	$TICK_WATCHER = Event->timer (
274	or return; # no perl data	2515	reentrant => 0,
		2516	parked => 1,
		2517	prio => 0,
		2518	at => $NEXT_TICK || $TICK,
		2519	data => WF_AUTOCANCEL,
		2520	cb => sub {
		2521	if ($Coro::current != $Coro::main) {
		2522	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2523	unless ++$bug_warning > 10;
		2524	return;
		2525	}
275		2526
276	my $data = Storable::thaw do { local $/; <$fh> };	2527	$NOW = Event::time;
277		2528
278	$data->{version} <= 1	2529	cf::server_tick; # one server iteration
279	or return; # too new	2530	$RUNTIME += $TICK;
		2531	$NEXT_TICK += $TICK;
280		2532
281	$map->_set_obs ($data->{obs});	2533	$WAIT_FOR_TICK->broadcast;
282	};	2534	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
283		2535
284	*on_mapout = sub {	2536	# my $AFTER = Event::time;
285	my ($map) = @_;	2537	# warn $AFTER - $NOW;#d#
286		2538
287	my $path = $map->tmpname;	2539	# if we are delayed by four ticks or more, skip them all
288	$path = $map->path unless defined $path;	2540	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
289		2541
290	my $obs = $map->_get_obs;	2542	$TICK_WATCHER->at ($NEXT_TICK);
		2543	$TICK_WATCHER->start;
		2544	},
		2545	);
291		2546
292	if (defined $obs) {	2547	{
293	open my $fh, ">:raw", "$path.cfperl"	2548	BDB::max_poll_time $TICK * 0.1;
294	or die "$path.cfperl: $!";	2549	$BDB_POLL_WATCHER = Event->io (
		2550	reentrant => 0,
		2551	fd => BDB::poll_fileno,
		2552	poll => 'r',
		2553	prio => 0,
		2554	data => WF_AUTOCANCEL,
		2555	cb => \&BDB::poll_cb,
		2556	);
		2557	BDB::min_parallel 8;
295		2558
296	stat $path;	2559	BDB::set_sync_prepare {
		2560	my $status;
		2561	my $current = $Coro::current;
		2562	(
		2563	sub {
		2564	$status = $!;
		2565	$current->ready; undef $current;
		2566	},
		2567	sub {
		2568	Coro::schedule while defined $current;
		2569	$! = $status;
		2570	},
		2571	)
		2572	};
297		2573
298	print $fh Storable::nfreeze {	2574	unless ($DB_ENV) {
299	size => (stat _)[7],	2575	$DB_ENV = BDB::db_env_create;
300	time => (stat _)[9],	2576
301	version => 1,	2577	cf::sync_job {
302	obs => $obs,	2578	eval {
		2579	BDB::db_env_open
		2580	$DB_ENV,
		2581	$BDB_ENV_DIR,
		2582	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2583	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2584	0666;
		2585
		2586	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2587
		2588	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2589	$DB_ENV->set_lk_detect;
		2590	};
		2591
		2592	cf::cleanup "db_env_open(db): $@" if $@;
303	};	2593	};
304
305	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
306	} else {
307	unlink "$path.cfperl";
308	}	2594	}
309	};	2595	}
310		2596
311	#############################################################################	2597	{
312	# load/save perl data associated with player->ob objects	2598	IO::AIO::min_parallel 8;
313		2599
314	*on_player_load = sub {	2600	undef $Coro::AIO::WATCHER;
315	my ($ob, $path) = @_;	2601	IO::AIO::max_poll_time $TICK * 0.1;
		2602	$AIO_POLL_WATCHER = Event->io (
		2603	reentrant => 0,
		2604	fd => IO::AIO::poll_fileno,
		2605	poll => 'r',
		2606	prio => 6,
		2607	data => WF_AUTOCANCEL,
		2608	cb => \&IO::AIO::poll_cb,
		2609	);
		2610	}
316		2611
317	if (open my $fh, "<:raw", "$path.cfperl") {	2612	$WRITE_RUNTIME_WATCHER = Event->timer (
		2613	reentrant => 0,
		2614	data => WF_AUTOCANCEL,
		2615	parked => 1,
		2616	after => 1,
		2617	interval => 10,
		2618	prio => 6, # keep it lowest so it acts like a watchdog
		2619	cb => sub {
		2620	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
318		2621
319	#d##TODO#remove	2622	Coro::async_pool {
320		2623	write_runtime
321	my $data = Storable::thaw do { local $/; <$fh> };	2624	or warn "ERROR: unable to write runtime file: $!";
322
323	$data->{version} <= 1
324	or return; # too new
325
326	%$ob = %{$data->{ob}};
327	return;
328	}
329
330	for my $o ($ob, $ob->inv) {
331	if (my $value = $o->get_ob_key_value ("_perl_data")) {
332	$o->set_ob_key_value ("_perl_data");
333
334	%$o = %{ Storable::thaw pack "H*", $value };
335	}	2625	};
336	}	2626	},
337	};	2627	);
338		2628
339	*on_player_save = sub {	2629	END { cf::emergency_save }
340	my ($ob, $path) = @_;
341
342	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
343	for grep %$_, $ob, $ob->inv;
344
345	unlink "$path.cfperl";#d##TODO#remove
346	};
347
348	register "<global>", __PACKAGE__;
349
350	unshift @INC, maps_directory "perl";
351
352	load_extensions;
353		2630
354	1	2631	1
355		2632

Diff Legend

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