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.19 by root, Sun Jul 16 17:15:39 2006 UTC vs.
Revision 1.228 by root, Mon Mar 26 16:53:33 2007 UTC

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

Diff Legend

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