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

Diff Legend

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