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

Diff Legend

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