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

Diff Legend

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