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.15 by root, Sun Jun 11 15:02:16 2006 UTC vs.
Revision 1.207 by root, Sun Feb 11 22:42:09 2007 UTC

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

Diff Legend

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