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

Diff Legend

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