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

Diff Legend

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