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.38 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.293 by root, Tue Jul 3 05:14:15 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 @PLUGIN_EVENT;
19	our %PROP_TYPE;
20	our %PROP_IDX;
21	our $LIBDIR = maps_directory "perl";
22		61
23	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(!)
24	our $TICK_WATCHER;	75	our $TICK_WATCHER;
		76	our $AIO_POLL_WATCHER;
		77	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
25	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
26		174
27	BEGIN {	175	BEGIN {
28	@PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30	*CORE::GLOBAL::warn = sub {	176	*CORE::GLOBAL::warn = sub {
31	my $msg = join "", @_;	177	my $msg = join "", @_;
		178
32	$msg .= "\n"	179	$msg .= "\n"
33	unless $msg =~ /\n$/;	180	unless $msg =~ /\n$/;
34		181
35	print STDERR "cfperl: $msg";	182	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		183
		184	utf8::encode $msg;
36	LOG llevError, "cfperl: $msg";	185	LOG llevError, $msg;
37	};	186	};
38	}	187	}
39		188
40	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)
41		196
42	# generate property mutators	197	# we bless all objects into (empty) derived classes to force a method lookup
43	sub prop_gen {	198	# within the Safe compartment.
44	my ($prefix, $class) = @_;	199	for my $pkg (qw(
45		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	)) {
46	no strict 'refs';	206	no strict 'refs';
47
48	for my $prop (keys %PROP_TYPE) {
49	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
50	my $sub = lc $1;
51
52	my $type = $PROP_TYPE{$prop};
53	my $idx = $PROP_IDX {$prop};
54
55	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
56	$_[0]->get_property ($type, $idx)
57	};
58
59	*{"$class\::set_$sub"} = sub {
60	$_[0]->set_property ($type, $idx, $_[1]);
61	} unless $ignore_set{$prop};
62	}
63	}
64
65	# auto-generate most of the API
66
67	prop_gen OBJECT_PROP => "cf::object";
68	# CFAPI_OBJECT_ANIMATION?
69	prop_gen PLAYER_PROP => "cf::object::player";
70
71	prop_gen MAP_PROP => "cf::map";
72	prop_gen ARCH_PROP => "cf::arch";
73
74	# guessed hierarchies
75
76	@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
77	@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78
79	# we bless all objects into derived classes to force a method lookup
80	# within the Safe compartment.
81	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
82	no strict 'refs';
83	@{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	207	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	208	}
85		209
86	$Event::DIED = sub {	210	$Event::DIED = sub {
87	warn "error in event callback: @_";	211	warn "error in event callback: @_";
88	};	212	};
89		213
90	my %ext_pkg;	214	#############################################################################
91	my @exts;
92	my @hook;
93	my %command;
94	my %extcmd;
95		215
96	sub inject_event {	216	=head2 UTILITY FUNCTIONS
97	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->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 {
98	my $event_code = shift;	860	my $event = shift;
		861	my $callbacks = shift;
99		862
100	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
101	or return;	1001	or return;
102		1002
103	&$cb	1003	unless (aio_stat "$filename.pst") {
104	}	1004	(aio_load "$filename.pst", $av) >= 0
105
106	sub inject_global_event {
107	my $event = shift;
108
109	my $cb = $hook[$event]
110	or return;	1005	or return;
111		1006	$av = eval { (Storable::thaw $av)->{objs} };
112	List::Util::max map &$_, values %$cb
113	}
114
115	sub inject_command {
116	my ($name, $obj, $params) = @_;
117
118	for my $cmd (@{ $command{$name} }) {
119	$cmd->[1]->($obj, $params);
120	}	1007	}
121		1008
122	-1	1009	warn sprintf "loading %s (%d)\n",
		1010	$filename, length $data, scalar @{$av || []};
		1011	return ($data, $av);
123	}	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
124		1029
125	sub register_command {	1030	sub register_command {
126	my ($name, $time, $cb) = @_;	1031	my ($name, $cb) = @_;
127		1032
128	my $caller = caller;	1033	my $caller = caller;
129	#warn "registering command '$name/$time' to '$caller'";	1034	#warn "registering command '$name/$time' to '$caller'";
130		1035
131	push @{ $command{$name} }, [$time, $cb, $caller];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
132	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
133	}	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
134		1062
135	sub register_extcmd {	1063	sub register_extcmd {
136	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
137		1065
138	my $caller = caller;	1066	$EXTCMD{$name} = $cb;
139	#warn "registering extcmd '$name' to '$caller'";
140
141	$extcmd{$name} = [$cb, $caller];
142	}	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 { $pl->ns->{json_coder}->decode ($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<([^\>]*)>}
		1406	{
		1407	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1408	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1409	"")
		1410	[$self->{hintmode}]
		1411	}ge;
		1412
		1413	# create single paragraphs (very hackish)
		1414	s/(?<=\S)\n(?=\w)/ /g;
		1415
		1416	# compress some whitespace
		1417	1 while s/\s*\n\s*\n\s*/\n/;
		1418
		1419	s/^\s+//;
		1420	s/\s+$//;
		1421
		1422	$_
		1423	}
		1424
		1425	sub hintmode {
		1426	$_[0]{hintmode} = $_[1] if @_ > 1;
		1427	$_[0]{hintmode}
		1428	}
		1429
		1430	=item $player->ext_reply ($msgid, %msg)
		1431
		1432	Sends an ext reply to the player.
		1433
		1434	=cut
		1435
		1436	sub ext_reply($$%) {
		1437	my ($self, $id, %msg) = @_;
		1438
		1439	$msg{msgid} = $id;
		1440	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
		1441	}
		1442
		1443	=item $player->ext_event ($type, %msg)
		1444
		1445	Sends an ext event to the client.
		1446
		1447	=cut
		1448
		1449	sub ext_event($$%) {
		1450	my ($self, $type, %msg) = @_;
		1451
		1452	$self->ns->ext_event ($type, %msg);
		1453	}
		1454
		1455	=head3 cf::region
		1456
		1457	=over 4
		1458
		1459	=cut
		1460
		1461	package cf::region;
		1462
		1463	=item cf::region::find_by_path $path
		1464
		1465	Tries to decuce the likely region for a map knowing only its path.
		1466
		1467	=cut
		1468
		1469	sub find_by_path($) {
		1470	my ($path) = @_;
		1471
		1472	my ($match, $specificity);
		1473
		1474	for my $region (list) {
		1475	if ($region->match && $path =~ $region->match) {
		1476	($match, $specificity) = ($region, $region->specificity)
		1477	if $region->specificity > $specificity;
		1478	}
		1479	}
		1480
		1481	$match
		1482	}
		1483
		1484	=back
		1485
		1486	=head3 cf::map
		1487
		1488	=over 4
		1489
		1490	=cut
		1491
		1492	package cf::map;
		1493
		1494	use Fcntl;
		1495	use Coro::AIO;
		1496
		1497	use overload
		1498	'""' => \&as_string,
		1499	fallback => 1;
		1500
		1501	our $MAX_RESET = 3600;
		1502	our $DEFAULT_RESET = 3000;
		1503
		1504	sub generate_random_map {
		1505	my ($self, $rmp) = @_;
		1506	# mit "rum" bekleckern, nicht
		1507	$self->_create_random_map (
		1508	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1509	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1510	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1511	$rmp->{exit_on_final_map},
		1512	$rmp->{xsize}, $rmp->{ysize},
		1513	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1514	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1515	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1516	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1517	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1518	(cf::region::find $rmp->{region}), $rmp->{custom}
		1519	)
		1520	}
		1521
		1522	=item cf::map->register ($regex, $prio)
		1523
		1524	Register a handler for the map path matching the given regex at the
		1525	givne priority (higher is better, built-in handlers have priority 0, the
		1526	default).
		1527
		1528	=cut
143		1529
144	sub register {	1530	sub register {
		1531	my (undef, $regex, $prio) = @_;
		1532	my $pkg = caller;
		1533
		1534	no strict;
		1535	push @{"$pkg\::ISA"}, __PACKAGE__;
		1536
		1537	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1538	}
		1539
		1540	# also paths starting with '/'
		1541	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1542
		1543	sub thawer_merge {
145	my ($base, $pkg) = @_;	1544	my ($self, $merge) = @_;
146		1545
147	for my $idx (0 .. $#PLUGIN_EVENT) {	1546	# we have to keep some variables in memory intact
148	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {	1547	local $self->{path};
149	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";	1548	local $self->{load_path};
150	$hook[$idx]{$base} = $ref;
151	}
152	}
153	}
154		1549
155	sub load_extension {	1550	$self->SUPER::thawer_merge ($merge);
		1551	}
		1552
		1553	sub normalise {
156	my ($path) = @_;	1554	my ($path, $base) = @_;
157		1555
158	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1556	$path = "$path"; # make sure its a string
159	my $base = $1;
160	my $pkg = $1;
161	$pkg =~ s/[^[:word:]]/_/g;
162	$pkg = "cf::ext::$pkg";
163		1557
164	warn "loading '$path' into '$pkg'\n";	1558	$path =~ s/\.map$//;
165		1559
166	open my $fh, "<:utf8", $path	1560	# map plan:
167	or die "$path: $!";	1561	#
		1562	# /! non-realised random map exit (special hack!)
		1563	# {... are special paths that are not being touched
		1564	# ?xxx/... are special absolute paths
		1565	# ?random/... random maps
		1566	# /... normal maps
		1567	# ~user/... per-player map of a specific user
168		1568
169	my $source =	1569	$path =~ s/$PATH_SEP/\//go;
170	"package $pkg; use strict; use utf8;\n"
171	. "#line 1 \"$path\"\n{\n"
172	. (do { local $/; <$fh> })
173	. "\n};\n1";
174		1570
175	eval $source	1571	# treat it as relative path if it starts with
176	or die "$path: $@";	1572	# something that looks reasonable
		1573	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1574	$base or Carp::carp "normalise called with relative path and no base: '$path'";
177		1575
178	push @exts, $pkg;	1576	$base =~ s{[^/]+/?$}{};
179	$ext_pkg{$base} = $pkg;	1577	$path = "$base/$path";
		1578	}
180		1579
181	# no strict 'refs';	1580	for ($path) {
182	# @{"$pkg\::ISA"} = ext::;	1581	redo if s{//}{/};
		1582	redo if s{/\.?/}{/};
		1583	redo if s{/[^/]+/\.\./}{/};
		1584	}
183		1585
184	register $base, $pkg;	1586	$path
185	}	1587	}
186		1588
187	sub unload_extension {	1589	sub new_from_path {
		1590	my (undef, $path, $base) = @_;
		1591
		1592	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1593
		1594	$path = normalise $path, $base;
		1595
		1596	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1597	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1598	my $self = bless cf::map::new, $pkg;
		1599	$self->{path} = $path; $self->path ($path);
		1600	$self->init; # pass $1 etc.
		1601	return $self;
		1602	}
		1603	}
		1604
		1605	Carp::carp "unable to resolve path '$path' (base '$base').";
		1606	()
		1607	}
		1608
		1609	sub init {
		1610	my ($self) = @_;
		1611
		1612	$self
		1613	}
		1614
		1615	sub as_string {
		1616	my ($self) = @_;
		1617
		1618	"$self->{path}"
		1619	}
		1620
		1621	# the displayed name, this is a one way mapping
		1622	sub visible_name {
		1623	&as_string
		1624	}
		1625
		1626	# the original (read-only) location
		1627	sub load_path {
		1628	my ($self) = @_;
		1629
		1630	"$MAPDIR/$self->{path}.map"
		1631	}
		1632
		1633	# the temporary/swap location
		1634	sub save_path {
		1635	my ($self) = @_;
		1636
		1637	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1638	"$TMPDIR/$path.map"
		1639	}
		1640
		1641	# the unique path, undef == no special unique path
		1642	sub uniq_path {
		1643	my ($self) = @_;
		1644
		1645	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1646	"$UNIQUEDIR/$path"
		1647	}
		1648
		1649	# and all this just because we cannot iterate over
		1650	# all maps in C++...
		1651	sub change_all_map_light {
188	my ($pkg) = @_;	1652	my ($change) = @_;
189		1653
190	warn "removing extension $pkg\n";	1654	$_->change_map_light ($change)
		1655	for grep $_->outdoor, values %cf::MAP;
		1656	}
191		1657
192	# remove hooks	1658	sub decay_objects {
193	for my $idx (0 .. $#PLUGIN_EVENT) {	1659	my ($self) = @_;
194	delete $hook[$idx]{$pkg};	1660
		1661	return if $self->{deny_reset};
		1662
		1663	$self->do_decay_objects;
		1664	}
		1665
		1666	sub unlink_save {
		1667	my ($self) = @_;
		1668
		1669	utf8::encode (my $save = $self->save_path);
		1670	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1671	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1672	}
		1673
		1674	sub load_header_from($) {
		1675	my ($self, $path) = @_;
		1676
		1677	utf8::encode $path;
		1678	#aio_open $path, O_RDONLY, 0
		1679	# or return;
		1680
		1681	$self->_load_header ($path)
		1682	or return;
		1683
		1684	$self->{load_path} = $path;
		1685
195	}	1686	1
		1687	}
196		1688
197	# remove commands	1689	sub load_header_orig {
198	for my $name (keys %command) {	1690	my ($self) = @_;
199	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
200		1691
201	if (@cb) {	1692	$self->load_header_from ($self->load_path)
202	$command{$name} = \@cb;	1693	}
203	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;	1694
		1695	sub load_header_temp {
		1696	my ($self) = @_;
		1697
		1698	$self->load_header_from ($self->save_path)
		1699	}
		1700
		1701	sub prepare_temp {
		1702	my ($self) = @_;
		1703
		1704	$self->last_access ((delete $self->{last_access})
		1705	|| $cf::RUNTIME); #d#
		1706	# safety
		1707	$self->{instantiate_time} = $cf::RUNTIME
		1708	if $self->{instantiate_time} > $cf::RUNTIME;
		1709	}
		1710
		1711	sub prepare_orig {
		1712	my ($self) = @_;
		1713
		1714	$self->{load_original} = 1;
		1715	$self->{instantiate_time} = $cf::RUNTIME;
		1716	$self->last_access ($cf::RUNTIME);
		1717	$self->instantiate;
		1718	}
		1719
		1720	sub load_header {
		1721	my ($self) = @_;
		1722
		1723	if ($self->load_header_temp) {
		1724	$self->prepare_temp;
204	} else {	1725	} else {
205	delete $command{$name};	1726	$self->load_header_orig
206	delete $COMMAND{"$name\000"};	1727	or return;
207	}	1728	$self->prepare_orig;
		1729	}
		1730
		1731	$self->{deny_reset} = 1
		1732	if $self->no_reset;
		1733
		1734	$self->default_region (cf::region::find_by_path $self->{path})
		1735	unless $self->default_region;
		1736
208	}	1737	1
209
210	# remove extcmds
211	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
212	delete $extcmd{$name};
213	}
214
215	if (my $cb = $pkg->can ("on_unload")) {
216	eval {
217	$cb->($pkg);
218	1
219	} or warn "$pkg unloaded, but with errors: $@";
220	}
221
222	Symbol::delete_package $pkg;
223	}	1738	}
224		1739
225	sub load_extensions {	1740	sub find;
226	my $LIBDIR = maps_directory "perl";	1741	sub find {
		1742	my ($path, $origin) = @_;
227		1743
228	for my $ext (<$LIBDIR/*.ext>) {	1744	$path = normalise $path, $origin && $origin->path;
229	next unless -r $ext;
230	eval {
231	load_extension $ext;
232	1
233	} or warn "$ext not loaded: $@";
234	}
235	}
236		1745
237	sub _perl_reload(&) {	1746	cf::lock_wait "map_find:$path";
		1747
		1748	$cf::MAP{$path} || do {
		1749	my $guard = cf::lock_acquire "map_find:$path";
		1750	my $map = new_from_path cf::map $path
		1751	or return;
		1752
		1753	$map->{last_save} = $cf::RUNTIME;
		1754
		1755	$map->load_header
		1756	or return;
		1757
		1758	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1759	# doing this can freeze the server in a sync job, obviously
		1760	#$cf::WAIT_FOR_TICK->wait;
		1761	$map->reset;
		1762	undef $guard;
		1763	return find $path;
		1764	}
		1765
		1766	$cf::MAP{$path} = $map
		1767	}
		1768	}
		1769
		1770	sub pre_load { }
		1771	sub post_load { }
		1772
		1773	sub load {
238	my ($msg) = @_;	1774	my ($self) = @_;
239		1775
240	$msg->("reloading...");	1776	local $self->{deny_reset} = 1; # loading can take a long time
241		1777
242	eval {	1778	my $path = $self->{path};
243	# 1. cancel all watchers
244	$_->cancel for Event::all_watchers;
245		1779
246	# 2. unload all extensions	1780	{
247	for (@exts) {	1781	my $guard = cf::lock_acquire "map_load:$path";
248	$msg->("unloading <$_>");
249	unload_extension $_;
250	}
251		1782
252	# 3. unload all modules loaded from $LIBDIR	1783	return if $self->in_memory != cf::MAP_SWAPPED;
253	while (my ($k, $v) = each %INC) {
254	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
255		1784
256	$msg->("removing <$k>");	1785	$self->in_memory (cf::MAP_LOADING);
257	delete $INC{$k};
258		1786
259	$k =~ s/\.pm$//;	1787	$self->alloc;
260	$k =~ s/\//::/g;
261		1788
262	if (my $cb = $k->can ("unload_module")) {	1789	$self->pre_load;
263	$cb->();	1790	Coro::cede;
		1791
		1792	$self->_load_objects ($self->{load_path}, 1)
		1793	or return;
		1794
		1795	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1796	if delete $self->{load_original};
		1797
		1798	if (my $uniq = $self->uniq_path) {
		1799	utf8::encode $uniq;
		1800	if (aio_open $uniq, O_RDONLY, 0) {
		1801	$self->clear_unique_items;
		1802	$self->_load_objects ($uniq, 0);
264	}	1803	}
265
266	Symbol::delete_package $k;
267	}
268
269	# 4. get rid of ext::, as good as possible
270	Symbol::delete_package "ext::$_"
271	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
272
273	# 5. remove register_script_function callbacks
274	# TODO
275		1804	}
276	# 6. unload cf.pm "a bit"
277	delete $INC{"cf.pm"};
278		1805
279	# don't, removes xs symbols, too	1806	Coro::cede;
280	#Symbol::delete_package __PACKAGE__;	1807	# now do the right thing for maps
		1808	$self->link_multipart_objects;
		1809	$self->difficulty ($self->estimate_difficulty)
		1810	unless $self->difficulty;
		1811	Coro::cede;
281		1812
282	# 7. reload cf.pm	1813	unless ($self->{deny_activate}) {
283	$msg->("reloading cf.pm");	1814	$self->decay_objects;
284	require cf;	1815	$self->fix_auto_apply;
		1816	$self->update_buttons;
		1817	Coro::cede;
		1818	$self->set_darkness_map;
		1819	Coro::cede;
		1820	$self->activate;
		1821	}
		1822
		1823	$self->in_memory (cf::MAP_IN_MEMORY);
		1824	}
		1825
		1826	$self->post_load;
		1827	}
		1828
		1829	sub customise_for {
		1830	my ($self, $ob) = @_;
		1831
		1832	return find "~" . $ob->name . "/" . $self->{path}
		1833	if $self->per_player;
		1834
		1835	# return find "?party/" . $ob->name . "/" . $self->{path}
		1836	# if $self->per_party;
		1837
		1838	$self
		1839	}
		1840
		1841	# find and load all maps in the 3x3 area around a map
		1842	sub load_diag {
		1843	my ($map) = @_;
		1844
		1845	my @diag; # diagonal neighbours
		1846
		1847	for (0 .. 3) {
		1848	my $neigh = $map->tile_path ($_)
		1849	or next;
		1850	$neigh = find $neigh, $map
		1851	or next;
		1852	$neigh->load;
		1853
		1854	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1855	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1856	}
		1857
		1858	for (@diag) {
		1859	my $neigh = find @$_
		1860	or next;
		1861	$neigh->load;
		1862	}
		1863	}
		1864
		1865	sub find_sync {
		1866	my ($path, $origin) = @_;
		1867
		1868	cf::sync_job { find $path, $origin }
		1869	}
		1870
		1871	sub do_load_sync {
		1872	my ($map) = @_;
		1873
		1874	cf::sync_job { $map->load };
		1875	}
		1876
		1877	our %MAP_PREFETCH;
		1878	our $MAP_PREFETCHER = undef;
		1879
		1880	sub find_async {
		1881	my ($path, $origin) = @_;
		1882
		1883	$path = normalise $path, $origin && $origin->{path};
		1884
		1885	if (my $map = $cf::MAP{$path}) {
		1886	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1887	}
		1888
		1889	undef $MAP_PREFETCH{$path};
		1890	$MAP_PREFETCHER ||= cf::async {
		1891	while (%MAP_PREFETCH) {
		1892	for my $path (keys %MAP_PREFETCH) {
		1893	my $map = find $path
		1894	or next;
		1895	$map->load;
		1896
		1897	delete $MAP_PREFETCH{$path};
		1898	}
		1899	}
		1900	undef $MAP_PREFETCHER;
285	};	1901	};
286	$msg->($@) if $@;	1902	$MAP_PREFETCHER->prio (6);
287		1903
288	$msg->("reloaded");	1904	()
289	};	1905	}
290		1906
291	sub perl_reload() {	1907	sub save {
292	_perl_reload {	1908	my ($self) = @_;
293	warn $_[0];	1909
294	print "$_[0]\n";	1910	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1911
		1912	$self->{last_save} = $cf::RUNTIME;
		1913
		1914	return unless $self->dirty;
		1915
		1916	my $save = $self->save_path; utf8::encode $save;
		1917	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1918
		1919	$self->{load_path} = $save;
		1920
		1921	return if $self->{deny_save};
		1922
		1923	local $self->{last_access} = $self->last_access;#d#
		1924
		1925	cf::async {
		1926	$_->contr->save for $self->players;
295	};	1927	};
296	}
297		1928
298	register_command "perl-reload", 0, sub {	1929	if ($uniq) {
299	my ($who, $arg) = @_;	1930	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
300		1931	$self->_save_objects ($uniq, cf::IO_UNIQUES);
301	if ($who->flag (FLAG_WIZ)) {
302	_perl_reload {
303	warn $_[0];
304	$who->message ($_[0]);
305	};
306	}
307	};
308
309	#############################################################################
310	# utility functions
311
312	use JSON::Syck (); # TODO# replace by JSON::PC once working
313
314	sub from_json($) {
315	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
316	JSON::Syck::Load $_[0]
317	}
318
319	sub to_json($) {
320	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
321	JSON::Syck::Dump $_[0]
322	}
323
324	#############################################################################
325	# extcmd framework, basically convert ext <msg>
326	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
327
328	sub on_extcmd {
329	my ($pl, $buf) = @_;
330
331	my $msg = eval { from_json $buf };
332
333	if (ref $msg) {
334	if (my $cb = $extcmd{$msg->{msgtype}}) {
335	if (my %reply = $cb->[0]->($pl, $msg)) {
336	$pl->ext_reply ($msg->{msgid}, %reply);
337	}
338	}
339	} else {	1932	} else {
340	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1933	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
341	}
342
343	1	1934	}
344	}	1935	}
345		1936
346	#############################################################################	1937	sub swap_out {
347	# load/save/clean perl data associated with a map
348
349	*on_mapclean = sub {
350	my ($map) = @_;	1938	my ($self) = @_;
351		1939
352	my $path = $map->tmpname;	1940	# save first because save cedes
353	defined $path or return;	1941	$self->save;
354		1942
355	unlink "$path.cfperl";	1943	my $lock = cf::lock_acquire "map_data:" . $self->path;
356	};
357		1944
358	*on_mapin =	1945	return if $self->players;
359	*on_mapload = sub {	1946	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1947	return if $self->{deny_save};
		1948
		1949	$self->clear;
		1950	$self->in_memory (cf::MAP_SWAPPED);
		1951	}
		1952
		1953	sub reset_at {
360	my ($map) = @_;	1954	my ($self) = @_;
361		1955
362	my $path = $map->tmpname;	1956	# TODO: safety, remove and allow resettable per-player maps
363	$path = $map->path unless defined $path;	1957	return 1e99 if $self->{deny_reset};
364		1958
365	open my $fh, "<:raw", "$path.cfperl"	1959	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
366	or return; # no perl data	1960	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
367		1961
368	my $data = Storable::thaw do { local $/; <$fh> };	1962	$time + $to
		1963	}
369		1964
370	$data->{version} <= 1	1965	sub should_reset {
371	or return; # too new
372
373	$map->_set_obs ($data->{obs});
374	};
375
376	*on_mapout = sub {
377	my ($map) = @_;	1966	my ($self) = @_;
378		1967
379	my $path = $map->tmpname;	1968	$self->reset_at <= $cf::RUNTIME
380	$path = $map->path unless defined $path;	1969	}
381		1970
382	my $obs = $map->_get_obs;	1971	sub reset {
		1972	my ($self) = @_;
383		1973
384	if (defined $obs) {	1974	my $lock = cf::lock_acquire "map_data:$self->{path}";
385	open my $fh, ">:raw", "$path.cfperl"
386	or die "$path.cfperl: $!";
387		1975
388	stat $path;	1976	return if $self->players;
389		1977
390	print $fh Storable::nfreeze {	1978	warn "resetting map ", $self->path;
391	size => (stat _)[7],
392	time => (stat _)[9],
393	version => 1,
394	obs => $obs,
395	};
396		1979
397	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*	1980	$self->in_memory (cf::MAP_SWAPPED);
398	} else {	1981
399	unlink "$path.cfperl";	1982	# need to save uniques path
		1983	unless ($self->{deny_save}) {
		1984	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1985
		1986	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1987	if $uniq;
		1988	}
		1989
		1990	delete $cf::MAP{$self->path};
		1991
		1992	$self->clear;
		1993
		1994	$_->clear_links_to ($self) for values %cf::MAP;
		1995
		1996	$self->unlink_save;
		1997	$self->destroy;
		1998	}
		1999
		2000	my $nuke_counter = "aaaa";
		2001
		2002	sub nuke {
		2003	my ($self) = @_;
		2004
		2005	delete $cf::MAP{$self->path};
		2006
		2007	$self->unlink_save;
		2008
		2009	bless $self, "cf::map";
		2010	delete $self->{deny_reset};
		2011	$self->{deny_save} = 1;
		2012	$self->reset_timeout (1);
		2013	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2014
		2015	$cf::MAP{$self->path} = $self;
		2016
		2017	$self->reset; # polite request, might not happen
		2018	}
		2019
		2020	=item $maps = cf::map::tmp_maps
		2021
		2022	Returns an arrayref with all map paths of currently instantiated and saved
		2023	maps. May block.
		2024
		2025	=cut
		2026
		2027	sub tmp_maps() {
400	}	2028	[
401	};	2029	map {
402		2030	utf8::decode $_;
403	#############################################################################	2031	/\.map$/
404	# load/save perl data associated with player->ob objects	2032	? normalise $_
405		2033	: ()
406	sub all_objects(@) {	2034	} @{ aio_readdir $TMPDIR or [] }
407	@_, map all_objects ($_->inv), @_
408	}
409
410	*on_player_load = sub {
411	my ($ob, $path) = @_;
412
413	for my $o (all_objects $ob) {
414	if (my $value = $o->get_ob_key_value ("_perl_data")) {
415	$o->set_ob_key_value ("_perl_data");
416
417	%$o = %{ Storable::thaw pack "H*", $value };
418	}
419	}	2035	]
420	};
421
422	*on_player_save = sub {
423	my ($ob, $path) = @_;
424
425	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
426	for grep %$_, all_objects $ob;
427	};
428
429	#############################################################################
430	# core extensions - in perl
431
432	=item cf::player::exists $login
433
434	Returns true when the given account exists.
435
436	=cut
437
438	sub cf::player::exists($) {
439	cf::player::find $_[0]
440	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
441	}	2036	}
442		2037
		2038	=item $maps = cf::map::random_maps
		2039
		2040	Returns an arrayref with all map paths of currently instantiated and saved
		2041	random maps. May block.
		2042
		2043	=cut
		2044
		2045	sub random_maps() {
		2046	[
		2047	map {
		2048	utf8::decode $_;
		2049	/\.map$/
		2050	? normalise "?random/$_"
		2051	: ()
		2052	} @{ aio_readdir $RANDOMDIR or [] }
		2053	]
		2054	}
		2055
		2056	=item cf::map::unique_maps
		2057
		2058	Returns an arrayref of paths of all shared maps that have
		2059	instantiated unique items. May block.
		2060
		2061	=cut
		2062
		2063	sub unique_maps() {
		2064	[
		2065	map {
		2066	utf8::decode $_;
		2067	/\.map$/
		2068	? normalise $_
		2069	: ()
		2070	} @{ aio_readdir $UNIQUEDIR or [] }
		2071	]
		2072	}
		2073
		2074	package cf;
		2075
		2076	=back
		2077
		2078	=head3 cf::object
		2079
		2080	=cut
		2081
		2082	package cf::object;
		2083
		2084	=over 4
		2085
		2086	=item $ob->inv_recursive
		2087
		2088	Returns the inventory of the object _and_ their inventories, recursively.
		2089
		2090	=cut
		2091
		2092	sub inv_recursive_;
		2093	sub inv_recursive_ {
		2094	map { $_, inv_recursive_ $_->inv } @_
		2095	}
		2096
		2097	sub inv_recursive {
		2098	inv_recursive_ inv $_[0]
		2099	}
		2100
		2101	package cf;
		2102
		2103	=back
		2104
		2105	=head3 cf::object::player
		2106
		2107	=over 4
		2108
443	=item $player->reply ($npc, $msg[, $flags])	2109	=item $player_object->reply ($npc, $msg[, $flags])
444		2110
445	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2111	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
446	can be C<undef>. Does the right thing when the player is currently in a	2112	can be C<undef>. Does the right thing when the player is currently in a
447	dialogue with the given NPC character.	2113	dialogue with the given NPC character.
448		2114
449	=cut	2115	=cut
450		2116
451	# rough implementation of a future "reply" method that works	2117	# rough implementation of a future "reply" method that works
452	# with dialog boxes.	2118	# with dialog boxes.
		2119	#TODO: the first argument must go, split into a $npc->reply_to ( method
453	sub cf::object::player::reply($$$;$) {	2120	sub cf::object::player::reply($$$;$) {
454	my ($self, $npc, $msg, $flags) = @_;	2121	my ($self, $npc, $msg, $flags) = @_;
455		2122
456	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2123	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
457		2124
458	if ($self->{record_replies}) {	2125	if ($self->{record_replies}) {
459	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2126	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2127
460	} else {	2128	} else {
		2129	my $pl = $self->contr;
		2130
		2131	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2132	my $diag = $pl->{npc_dialog};
		2133	$diag->{pl}->ext_reply (
		2134	$diag->{id},
		2135	msgtype => "reply",
		2136	msg => $diag->{pl}->expand_cfpod ($msg),
		2137	add_topics => []
		2138	);
		2139
		2140	} else {
461	$msg = $npc->name . " says: $msg" if $npc;	2141	$msg = $npc->name . " says: $msg" if $npc;
462	$self->message ($msg, $flags);	2142	$self->message ($msg, $flags);
		2143	}
		2144	}
		2145	}
		2146
		2147	=item $player_object->may ("access")
		2148
		2149	Returns wether the given player is authorized to access resource "access"
		2150	(e.g. "command_wizcast").
		2151
		2152	=cut
		2153
		2154	sub cf::object::player::may {
		2155	my ($self, $access) = @_;
		2156
		2157	$self->flag (cf::FLAG_WIZ) ||
		2158	(ref $cf::CFG{"may_$access"}
		2159	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		2160	: $cf::CFG{"may_$access"})
		2161	}
		2162
		2163	=item $player_object->enter_link
		2164
		2165	Freezes the player and moves him/her to a special map (C<{link}>).
		2166
		2167	The player should be reasonably safe there for short amounts of time. You
		2168	I<MUST> call C<leave_link> as soon as possible, though.
		2169
		2170	Will never block.
		2171
		2172	=item $player_object->leave_link ($map, $x, $y)
		2173
		2174	Moves the player out of the special C<{link}> map onto the specified
		2175	map. If the map is not valid (or omitted), the player will be moved back
		2176	to the location he/she was before the call to C<enter_link>, or, if that
		2177	fails, to the emergency map position.
		2178
		2179	Might block.
		2180
		2181	=cut
		2182
		2183	sub link_map {
		2184	unless ($LINK_MAP) {
		2185	$LINK_MAP = cf::map::find "{link}"
		2186	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2187	$LINK_MAP->load;
		2188	}
		2189
		2190	$LINK_MAP
		2191	}
		2192
		2193	sub cf::object::player::enter_link {
		2194	my ($self) = @_;
		2195
		2196	$self->deactivate_recursive;
		2197
		2198	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2199
		2200	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2201	if $self->map && $self->map->{path} ne "{link}";
		2202
		2203	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2204	}
		2205
		2206	sub cf::object::player::leave_link {
		2207	my ($self, $map, $x, $y) = @_;
		2208
		2209	return unless $self->contr->active;
		2210
		2211	my $link_pos = delete $self->{_link_pos};
		2212
		2213	unless ($map) {
		2214	# restore original map position
		2215	($map, $x, $y) = @{ $link_pos || [] };
		2216	$map = cf::map::find $map;
		2217
		2218	unless ($map) {
		2219	($map, $x, $y) = @$EMERGENCY_POSITION;
		2220	$map = cf::map::find $map
		2221	or die "FATAL: cannot load emergency map\n";
		2222	}
		2223	}
		2224
		2225	($x, $y) = (-1, -1)
		2226	unless (defined $x) && (defined $y);
		2227
		2228	# use -1 or undef as default coordinates, not 0, 0
		2229	($x, $y) = ($map->enter_x, $map->enter_y)
		2230	if $x <=0 && $y <= 0;
		2231
		2232	$map->load;
		2233	$map->load_diag;
		2234
		2235	return unless $self->contr->active;
		2236	$self->activate_recursive;
		2237
		2238	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2239	$self->enter_map ($map, $x, $y);
		2240	}
		2241
		2242	=item $player_object->goto ($path, $x, $y[, $check->($map)])
		2243
		2244	Moves the player to the given map-path and coordinates by first freezing
		2245	her, loading and preparing them map, calling the provided $check callback
		2246	that has to return the map if sucecssful, and then unfreezes the player on
		2247	the new (success) or old (failed) map position.
		2248
		2249	=cut
		2250
		2251	our $GOTOGEN;
		2252
		2253	sub cf::object::player::goto {
		2254	my ($self, $path, $x, $y, $check) = @_;
		2255
		2256	# do generation counting so two concurrent goto's will be executed in-order
		2257	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2258
		2259	$self->enter_link;
		2260
		2261	(async {
		2262	my $map = eval {
		2263	my $map = cf::map::find $path;
		2264
		2265	if ($map) {
		2266	$map = $map->customise_for ($self);
		2267	$map = $check->($map) if $check && $map;
		2268	} else {
		2269	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2270	}
		2271
		2272	$map
		2273	};
		2274
		2275	if ($@) {
		2276	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2277	LOG llevError | logBacktrace, Carp::longmess $@;
		2278	}
		2279
		2280	if ($gen == $self->{_goto_generation}) {
		2281	delete $self->{_goto_generation};
		2282	$self->leave_link ($map, $x, $y);
		2283	}
		2284	})->prio (1);
		2285	}
		2286
		2287	=item $player_object->enter_exit ($exit_object)
		2288
		2289	=cut
		2290
		2291	sub parse_random_map_params {
		2292	my ($spec) = @_;
		2293
		2294	my $rmp = { # defaults
		2295	xsize => (cf::rndm 15, 40),
		2296	ysize => (cf::rndm 15, 40),
		2297	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2298	#layout => string,
463	}	2299	};
464	}
465		2300
466	=item $player->ext_reply ($msgid, $msgtype, %msg)	2301	for (split /\n/, $spec) {
		2302	my ($k, $v) = split /\s+/, $_, 2;
467		2303
		2304	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2305	}
		2306
		2307	$rmp
		2308	}
		2309
		2310	sub prepare_random_map {
		2311	my ($exit) = @_;
		2312
		2313	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2314
		2315	# all this does is basically replace the /! path by
		2316	# a new random map path (?random/...) with a seed
		2317	# that depends on the exit object
		2318
		2319	my $rmp = parse_random_map_params $exit->msg;
		2320
		2321	if ($exit->map) {
		2322	$rmp->{region} = $exit->region->name;
		2323	$rmp->{origin_map} = $exit->map->path;
		2324	$rmp->{origin_x} = $exit->x;
		2325	$rmp->{origin_y} = $exit->y;
		2326	}
		2327
		2328	$rmp->{random_seed} ||= $exit->random_seed;
		2329
		2330	my $data = cf::to_json $rmp;
		2331	my $md5 = Digest::MD5::md5_hex $data;
		2332	my $meta = "$RANDOMDIR/$md5.meta";
		2333
		2334	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2335	aio_write $fh, 0, (length $data), $data, 0;
		2336	undef $fh;
		2337	aio_rename "$meta~", $meta;
		2338
		2339	$exit->slaying ("?random/$md5");
		2340	$exit->msg (undef);
		2341	}
		2342	}
		2343
		2344	sub cf::object::player::enter_exit {
		2345	my ($self, $exit) = @_;
		2346
		2347	return unless $self->type == cf::PLAYER;
		2348
		2349	if ($exit->slaying eq "/!") {
		2350	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2351	# the problem is that $exit might not survive long enough
		2352	# so it needs to be done right now, right here
		2353	cf::sync_job { prepare_random_map $exit };
		2354	}
		2355
		2356	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2357	my $hp = $exit->stats->hp;
		2358	my $sp = $exit->stats->sp;
		2359
		2360	$self->enter_link;
		2361
		2362	(async {
		2363	$self->deactivate_recursive; # just to be sure
		2364	unless (eval {
		2365	$self->goto ($slaying, $hp, $sp);
		2366
		2367	1;
		2368	}) {
		2369	$self->message ("Something went wrong deep within the crossfire server. "
		2370	. "I'll try to bring you back to the map you were before. "
		2371	. "Please report this to the dungeon master!",
		2372	cf::NDI_UNIQUE | cf::NDI_RED);
		2373
		2374	warn "ERROR in enter_exit: $@";
		2375	$self->leave_link;
		2376	}
		2377	})->prio (1);
		2378	}
		2379
		2380	=head3 cf::client
		2381
		2382	=over 4
		2383
		2384	=item $client->send_drawinfo ($text, $flags)
		2385
		2386	Sends a drawinfo packet to the client. Circumvents output buffering so
		2387	should not be used under normal circumstances.
		2388
		2389	=cut
		2390
		2391	sub cf::client::send_drawinfo {
		2392	my ($self, $text, $flags) = @_;
		2393
		2394	utf8::encode $text;
		2395	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2396	}
		2397
		2398	=item $client->send_msg ($color, $type, $msg, [extra...])
		2399
		2400	Send a drawinfo or msg packet to the client, formatting the msg for the
		2401	client if neccessary. C<$type> should be a string identifying the type of
		2402	the message, with C<log> being the default. If C<$color> is negative, suppress
		2403	the message unless the client supports the msg packet.
		2404
		2405	=cut
		2406
		2407	sub cf::client::send_msg {
		2408	my ($self, $color, $type, $msg, @extra) = @_;
		2409
		2410	$msg = $self->pl->expand_cfpod ($msg);
		2411
		2412	if ($self->can_msg) {
		2413	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2414	} else {
		2415	# replace some tags by gcfclient-compatible ones
		2416	for ($msg) {
		2417	1 while
		2418	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2419	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2420	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2421	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2422	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2423	}
		2424
		2425	if ($color >= 0) {
		2426	if (0 && $msg =~ /\[/) {
		2427	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2428	} else {
		2429	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2430	$self->send_packet ("drawinfo $color $msg")
		2431	}
		2432	}
		2433	}
		2434	}
		2435
		2436	=item $client->ext_event ($type, %msg)
		2437
468	Sends an ext reply to the player.	2438	Sends an ext event to the client.
469		2439
470	=cut	2440	=cut
471		2441
472	sub cf::player::ext_reply($$$%) {	2442	sub cf::client::ext_event($$%) {
473	my ($self, $id, %msg) = @_;	2443	my ($self, $type, %msg) = @_;
474		2444
475	$msg{msgid} = $id;	2445	$msg{msgtype} = "event_$type";
476		2446	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
477	$self->send ("ext " . to_json \%msg);
478	}	2447	}
479		2448
480	#############################################################################	2449	=item $success = $client->query ($flags, "text", \&cb)
481	# map scripting support
482		2450
		2451	Queues a query to the client, calling the given callback with
		2452	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2453	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2454
		2455	Queries can fail, so check the return code. Or don't, as queries will
		2456	become reliable at some point in the future.
		2457
		2458	=cut
		2459
		2460	sub cf::client::query {
		2461	my ($self, $flags, $text, $cb) = @_;
		2462
		2463	return unless $self->state == ST_PLAYING
		2464	|| $self->state == ST_SETUP
		2465	|| $self->state == ST_CUSTOM;
		2466
		2467	$self->state (ST_CUSTOM);
		2468
		2469	utf8::encode $text;
		2470	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2471
		2472	$self->send_packet ($self->{query_queue}[0][0])
		2473	if @{ $self->{query_queue} } == 1;
		2474
		2475	1
		2476	}
		2477
		2478	cf::client->attach (
		2479	on_connect => sub {
		2480	my ($ns) = @_;
		2481
		2482	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2483	},
		2484	on_reply => sub {
		2485	my ($ns, $msg) = @_;
		2486
		2487	# this weird shuffling is so that direct followup queries
		2488	# get handled first
		2489	my $queue = delete $ns->{query_queue}
		2490	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2491
		2492	(shift @$queue)->[1]->($msg);
		2493	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2494
		2495	push @{ $ns->{query_queue} }, @$queue;
		2496
		2497	if (@{ $ns->{query_queue} } == @$queue) {
		2498	if (@$queue) {
		2499	$ns->send_packet ($ns->{query_queue}[0][0]);
		2500	} else {
		2501	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2502	}
		2503	}
		2504	},
		2505	on_exticmd => sub {
		2506	my ($ns, $buf) = @_;
		2507
		2508	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2509
		2510	if (ref $msg) {
		2511	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2512	if (my %reply = $cb->($ns, $msg)) {
		2513	$reply{msgid} = $msg->{msgid};
		2514	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2515	}
		2516	}
		2517	} else {
		2518	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2519	}
		2520
		2521	cf::override;
		2522	},
		2523	);
		2524
		2525	=item $client->async (\&cb)
		2526
		2527	Create a new coroutine, running the specified callback. The coroutine will
		2528	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2529	or loss of connection).
		2530
		2531	=cut
		2532
		2533	sub cf::client::async {
		2534	my ($self, $cb) = @_;
		2535
		2536	my $coro = &Coro::async ($cb);
		2537
		2538	$coro->on_destroy (sub {
		2539	delete $self->{_coro}{$coro+0};
		2540	});
		2541
		2542	$self->{_coro}{$coro+0} = $coro;
		2543
		2544	$coro
		2545	}
		2546
		2547	cf::client->attach (
		2548	on_destroy => sub {
		2549	my ($ns) = @_;
		2550
		2551	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2552	},
		2553	);
		2554
		2555	=back
		2556
		2557
		2558	=head2 SAFE SCRIPTING
		2559
		2560	Functions that provide a safe environment to compile and execute
		2561	snippets of perl code without them endangering the safety of the server
		2562	itself. Looping constructs, I/O operators and other built-in functionality
		2563	is not available in the safe scripting environment, and the number of
		2564	functions and methods that can be called is greatly reduced.
		2565
		2566	=cut
		2567
483	our $safe = new Safe "ext";	2568	our $safe = new Safe "safe";
484	our $safe_hole = new Safe::Hole;	2569	our $safe_hole = new Safe::Hole;
485		2570
486	$SIG{FPE} = 'IGNORE';	2571	$SIG{FPE} = 'IGNORE';
487		2572
488	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2573	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
489		2574
490	# here we export the classes and methods available to script code	2575	# here we export the classes and methods available to script code
491		2576
		2577	=pod
		2578
		2579	The following functions and methods are available within a safe environment:
		2580
		2581	cf::object contr pay_amount pay_player map
		2582	cf::object::player player
		2583	cf::player peaceful
		2584	cf::map trigger
		2585
		2586	=cut
		2587
492	for (	2588	for (
493	["cf::object" => qw(contr pay_amount pay_player)],	2589	["cf::object" => qw(contr pay_amount pay_player map)],
494	["cf::object::player" => qw(player)],	2590	["cf::object::player" => qw(player)],
495	["cf::player" => qw(peaceful)],	2591	["cf::player" => qw(peaceful)],
		2592	["cf::map" => qw(trigger)],
496	) {	2593	) {
497	no strict 'refs';	2594	no strict 'refs';
498	my ($pkg, @funs) = @$_;	2595	my ($pkg, @funs) = @$_;
499	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2596	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
500	for @funs;	2597	for @funs;
501	}	2598	}
		2599
		2600	=over 4
		2601
		2602	=item @retval = safe_eval $code, [var => value, ...]
		2603
		2604	Compiled and executes the given perl code snippet. additional var/value
		2605	pairs result in temporary local (my) scalar variables of the given name
		2606	that are available in the code snippet. Example:
		2607
		2608	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2609
		2610	=cut
502		2611
503	sub safe_eval($;@) {	2612	sub safe_eval($;@) {
504	my ($code, %vars) = @_;	2613	my ($code, %vars) = @_;
505		2614
506	my $qcode = $code;	2615	my $qcode = $code;
507	$qcode =~ s/"/‟/g; # not allowed in #line filenames	2616	$qcode =~ s/"/‟/g; # not allowed in #line filenames
508	$qcode =~ s/\n/\\n/g;	2617	$qcode =~ s/\n/\\n/g;
509		2618
510	local $_;	2619	local $_;
511	local @ext::cf::_safe_eval_args = values %vars;	2620	local @safe::cf::_safe_eval_args = values %vars;
512		2621
513	$code =	2622	my $eval =
514	"do {\n"	2623	"do {\n"
515	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	2624	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
516	. "#line 0 \"{$qcode}\"\n"	2625	. "#line 0 \"{$qcode}\"\n"
517	. $code	2626	. $code
518	. "\n}"	2627	. "\n}"
519	;	2628	;
520		2629
521	sub_generation_inc;	2630	sub_generation_inc;
522	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	2631	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
523	sub_generation_inc;	2632	sub_generation_inc;
524		2633
		2634	if ($@) {
		2635	warn "$@";
		2636	warn "while executing safe code '$code'\n";
		2637	warn "with arguments " . (join " ", %vars) . "\n";
		2638	}
		2639
525	wantarray ? @res : $res[0]	2640	wantarray ? @res : $res[0]
526	}	2641	}
		2642
		2643	=item cf::register_script_function $function => $cb
		2644
		2645	Register a function that can be called from within map/npc scripts. The
		2646	function should be reasonably secure and should be put into a package name
		2647	like the extension.
		2648
		2649	Example: register a function that gets called whenever a map script calls
		2650	C<rent::overview>, as used by the C<rent> extension.
		2651
		2652	cf::register_script_function "rent::overview" => sub {
		2653	...
		2654	};
		2655
		2656	=cut
527		2657
528	sub register_script_function {	2658	sub register_script_function {
529	my ($fun, $cb) = @_;	2659	my ($fun, $cb) = @_;
530		2660
531	no strict 'refs';	2661	no strict 'refs';
532	*{"ext::$fun"} = $safe_hole->wrap ($cb);	2662	*{"safe::$fun"} = $safe_hole->wrap ($cb);
533	}	2663	}
		2664
		2665	=back
		2666
		2667	=cut
534		2668
535	#############################################################################	2669	#############################################################################
536	# the server's main()	2670	# the server's init and main functions
537		2671
538	sub run {	2672	sub load_facedata($) {
		2673	my ($path) = @_;
		2674
		2675	warn "loading facedata from $path\n";
		2676
		2677	my $facedata;
		2678	0 < aio_load $path, $facedata
		2679	or die "$path: $!";
		2680
		2681	$facedata = Coro::Storable::thaw $facedata;
		2682
		2683	$facedata->{version} == 2
		2684	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2685
		2686	{
		2687	my $faces = $facedata->{faceinfo};
		2688
		2689	while (my ($face, $info) = each %$faces) {
		2690	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2691	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2692	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2693	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2694	Coro::cede;
		2695	}
		2696
		2697	while (my ($face, $info) = each %$faces) {
		2698	next unless $info->{smooth};
		2699	my $idx = cf::face::find $face
		2700	or next;
		2701	if (my $smooth = cf::face::find $info->{smooth}) {
		2702	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2703	} else {
		2704	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2705	}
		2706	Coro::cede;
		2707	}
		2708	}
		2709
		2710	{
		2711	my $anims = $facedata->{animinfo};
		2712
		2713	while (my ($anim, $info) = each %$anims) {
		2714	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2715	Coro::cede;
		2716	}
		2717
		2718	cf::anim::invalidate_all; # d'oh
		2719	}
		2720
		2721	1
		2722	}
		2723
		2724	sub reload_regions {
		2725	load_resource_file "$MAPDIR/regions"
		2726	or die "unable to load regions file\n";
		2727	}
		2728
		2729	sub reload_facedata {
		2730	load_facedata "$DATADIR/facedata"
		2731	or die "unable to load facedata\n";
		2732	}
		2733
		2734	sub reload_archetypes {
		2735	load_resource_file "$DATADIR/archetypes"
		2736	or die "unable to load archetypes\n";
		2737	#d# NEED to laod twice to resolve forward references
		2738	# this really needs to be done in an extra post-pass
		2739	# (which needs to be synchronous, so solve it differently)
		2740	load_resource_file "$DATADIR/archetypes"
		2741	or die "unable to load archetypes\n";
		2742	}
		2743
		2744	sub reload_treasures {
		2745	load_resource_file "$DATADIR/treasures"
		2746	or die "unable to load treasurelists\n";
		2747	}
		2748
		2749	sub reload_resources {
		2750	warn "reloading resource files...\n";
		2751
		2752	reload_regions;
		2753	reload_facedata;
		2754	#reload_archetypes;#d#
		2755	reload_archetypes;
		2756	reload_treasures;
		2757
		2758	warn "finished reloading resource files\n";
		2759	}
		2760
		2761	sub init {
		2762	reload_resources;
		2763	}
		2764
		2765	sub cfg_load {
		2766	open my $fh, "<:utf8", "$CONFDIR/config"
		2767	or return;
		2768
		2769	local $/;
		2770	*CFG = YAML::Syck::Load <$fh>;
		2771
		2772	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2773
		2774	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2775	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2776
		2777	if (exists $CFG{mlockall}) {
		2778	eval {
		2779	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2780	and die "WARNING: m(un)lockall failed: $!\n";
		2781	};
		2782	warn $@ if $@;
		2783	}
		2784	}
		2785
		2786	sub main {
		2787	# we must not ever block the main coroutine
		2788	local $Coro::idle = sub {
		2789	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2790	(async {
		2791	Event::one_event;
		2792	})->prio (Coro::PRIO_MAX);
		2793	};
		2794
		2795	cfg_load;
		2796	db_init;
		2797	load_extensions;
		2798
		2799	$TICK_WATCHER->start;
539	Event::loop;	2800	Event::loop;
540	}	2801	}
541		2802
542	#############################################################################	2803	#############################################################################
543	# initialisation	2804	# initialisation and cleanup
544		2805
545	register "<global>", __PACKAGE__;	2806	# install some emergency cleanup handlers
		2807	BEGIN {
		2808	for my $signal (qw(INT HUP TERM)) {
		2809	Event->signal (
		2810	reentrant => 0,
		2811	data => WF_AUTOCANCEL,
		2812	signal => $signal,
		2813	prio => 0,
		2814	cb => sub {
		2815	cf::cleanup "SIG$signal";
		2816	},
		2817	);
		2818	}
		2819	}
		2820
		2821	sub write_runtime {
		2822	my $runtime = "$LOCALDIR/runtime";
		2823
		2824	# first touch the runtime file to show we are still running:
		2825	# the fsync below can take a very very long time.
		2826
		2827	IO::AIO::aio_utime $runtime, undef, undef;
		2828
		2829	my $guard = cf::lock_acquire "write_runtime";
		2830
		2831	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2832	or return;
		2833
		2834	my $value = $cf::RUNTIME + 90 + 10;
		2835	# 10 is the runtime save interval, for a monotonic clock
		2836	# 60 allows for the watchdog to kill the server.
		2837
		2838	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2839	and return;
		2840
		2841	# always fsync - this file is important
		2842	aio_fsync $fh
		2843	and return;
		2844
		2845	# touch it again to show we are up-to-date
		2846	aio_utime $fh, undef, undef;
		2847
		2848	close $fh
		2849	or return;
		2850
		2851	aio_rename "$runtime~", $runtime
		2852	and return;
		2853
		2854	warn "runtime file written.\n";
		2855
		2856	1
		2857	}
		2858
		2859	sub emergency_save() {
		2860	my $freeze_guard = cf::freeze_mainloop;
		2861
		2862	warn "enter emergency perl save\n";
		2863
		2864	cf::sync_job {
		2865	# use a peculiar iteration method to avoid tripping on perl
		2866	# refcount bugs in for. also avoids problems with players
		2867	# and maps saved/destroyed asynchronously.
		2868	warn "begin emergency player save\n";
		2869	for my $login (keys %cf::PLAYER) {
		2870	my $pl = $cf::PLAYER{$login} or next;
		2871	$pl->valid or next;
		2872	$pl->save;
		2873	}
		2874	warn "end emergency player save\n";
		2875
		2876	warn "begin emergency map save\n";
		2877	for my $path (keys %cf::MAP) {
		2878	my $map = $cf::MAP{$path} or next;
		2879	$map->valid or next;
		2880	$map->save;
		2881	}
		2882	warn "end emergency map save\n";
		2883
		2884	warn "begin emergency database checkpoint\n";
		2885	BDB::db_env_txn_checkpoint $DB_ENV;
		2886	warn "end emergency database checkpoint\n";
		2887	};
		2888
		2889	warn "leave emergency perl save\n";
		2890	}
		2891
		2892	sub post_cleanup {
		2893	my ($make_core) = @_;
		2894
		2895	warn Carp::longmess "post_cleanup backtrace"
		2896	if $make_core;
		2897	}
		2898
		2899	sub do_reload_perl() {
		2900	# can/must only be called in main
		2901	if ($Coro::current != $Coro::main) {
		2902	warn "can only reload from main coroutine";
		2903	return;
		2904	}
		2905
		2906	warn "reloading...";
		2907
		2908	warn "entering sync_job";
		2909
		2910	cf::sync_job {
		2911	cf::write_runtime; # external watchdog should not bark
		2912	cf::emergency_save;
		2913	cf::write_runtime; # external watchdog should not bark
		2914
		2915	warn "syncing database to disk";
		2916	BDB::db_env_txn_checkpoint $DB_ENV;
		2917
		2918	# if anything goes wrong in here, we should simply crash as we already saved
		2919
		2920	warn "cancelling all WF_AUTOCANCEL watchers";
		2921	for (Event::all_watchers) {
		2922	$_->cancel if $_->data & WF_AUTOCANCEL;
		2923	}
		2924
		2925	warn "flushing outstanding aio requests";
		2926	for (;;) {
		2927	BDB::flush;
		2928	IO::AIO::flush;
		2929	Coro::cede;
		2930	last unless IO::AIO::nreqs || BDB::nreqs;
		2931	warn "iterate...";
		2932	}
		2933
		2934	++$RELOAD;
		2935
		2936	warn "cancelling all extension coros";
		2937	$_->cancel for values %EXT_CORO;
		2938	%EXT_CORO = ();
		2939
		2940	warn "removing commands";
		2941	%COMMAND = ();
		2942
		2943	warn "removing ext/exti commands";
		2944	%EXTCMD = ();
		2945	%EXTICMD = ();
		2946
		2947	warn "unloading/nuking all extensions";
		2948	for my $pkg (@EXTS) {
		2949	warn "... unloading $pkg";
		2950
		2951	if (my $cb = $pkg->can ("unload")) {
		2952	eval {
		2953	$cb->($pkg);
		2954	1
		2955	} or warn "$pkg unloaded, but with errors: $@";
		2956	}
		2957
		2958	warn "... nuking $pkg";
		2959	Symbol::delete_package $pkg;
		2960	}
		2961
		2962	warn "unloading all perl modules loaded from $LIBDIR";
		2963	while (my ($k, $v) = each %INC) {
		2964	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2965
		2966	warn "... unloading $k";
		2967	delete $INC{$k};
		2968
		2969	$k =~ s/\.pm$//;
		2970	$k =~ s/\//::/g;
		2971
		2972	if (my $cb = $k->can ("unload_module")) {
		2973	$cb->();
		2974	}
		2975
		2976	Symbol::delete_package $k;
		2977	}
		2978
		2979	warn "getting rid of safe::, as good as possible";
		2980	Symbol::delete_package "safe::$_"
		2981	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2982
		2983	warn "unloading cf.pm \"a bit\"";
		2984	delete $INC{"cf.pm"};
		2985	delete $INC{"cf/pod.pm"};
		2986
		2987	# don't, removes xs symbols, too,
		2988	# and global variables created in xs
		2989	#Symbol::delete_package __PACKAGE__;
		2990
		2991	warn "unload completed, starting to reload now";
		2992
		2993	warn "reloading cf.pm";
		2994	require cf;
		2995	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2996
		2997	warn "loading config and database again";
		2998	cf::cfg_load;
		2999
		3000	warn "loading extensions";
		3001	cf::load_extensions;
		3002
		3003	warn "reattaching attachments to objects/players";
		3004	_global_reattach; # objects, sockets
		3005	warn "reattaching attachments to maps";
		3006	reattach $_ for values %MAP;
		3007	warn "reattaching attachments to players";
		3008	reattach $_ for values %PLAYER;
		3009
		3010	warn "leaving sync_job";
		3011
		3012	1
		3013	} or do {
		3014	warn $@;
		3015	warn "error while reloading, exiting.";
		3016	exit 1;
		3017	};
		3018
		3019	warn "reloaded";
		3020	};
		3021
		3022	our $RELOAD_WATCHER; # used only during reload
		3023
		3024	sub reload_perl() {
		3025	# doing reload synchronously and two reloads happen back-to-back,
		3026	# coro crashes during coro_state_free->destroy here.
		3027
		3028	$RELOAD_WATCHER ||= Event->timer (
		3029	reentrant => 0,
		3030	after => 0,
		3031	data => WF_AUTOCANCEL,
		3032	cb => sub {
		3033	do_reload_perl;
		3034	undef $RELOAD_WATCHER;
		3035	},
		3036	);
		3037	}
		3038
		3039	register_command "reload" => sub {
		3040	my ($who, $arg) = @_;
		3041
		3042	if ($who->flag (FLAG_WIZ)) {
		3043	$who->message ("reloading server.");
		3044	async { reload_perl };
		3045	}
		3046	};
546		3047
547	unshift @INC, $LIBDIR;	3048	unshift @INC, $LIBDIR;
548		3049
549	load_extensions;	3050	my $bug_warning = 0;
550		3051
		3052	our @WAIT_FOR_TICK;
		3053	our @WAIT_FOR_TICK_BEGIN;
		3054
		3055	sub wait_for_tick {
		3056	return unless $TICK_WATCHER->is_active;
		3057	return if $Coro::current == $Coro::main;
		3058
		3059	my $signal = new Coro::Signal;
		3060	push @WAIT_FOR_TICK, $signal;
		3061	$signal->wait;
		3062	}
		3063
		3064	sub wait_for_tick_begin {
		3065	return unless $TICK_WATCHER->is_active;
		3066	return if $Coro::current == $Coro::main;
		3067
		3068	my $signal = new Coro::Signal;
		3069	push @WAIT_FOR_TICK_BEGIN, $signal;
		3070	$signal->wait;
		3071	}
		3072
		3073	my $min = 1e6;#d#
		3074	my $avg = 10;
551	$TICK_WATCHER = Event->timer (	3075	$TICK_WATCHER = Event->timer (
		3076	reentrant => 0,
		3077	parked => 1,
552	prio => 1,	3078	prio => 0,
553	at => $NEXT_TICK || 1,	3079	at => $NEXT_TICK || $TICK,
		3080	data => WF_AUTOCANCEL,
554	cb => sub {	3081	cb => sub {
		3082	if ($Coro::current != $Coro::main) {
		3083	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3084	unless ++$bug_warning > 10;
		3085	return;
		3086	}
		3087
		3088	$NOW = $tick_start = Event::time;
		3089
555	cf::server_tick; # one server iteration	3090	cf::server_tick; # one server iteration
556		3091
		3092	0 && sync_job {#d#
		3093	for(1..10) {
557	my $NOW = Event::time;	3094	my $t = Event::time;
		3095	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3096	or die;
		3097
		3098	$map->width (50);
		3099	$map->height (50);
		3100	$map->alloc;
		3101	$map->_load_objects ("/tmp/x.map", 1);
		3102	my $t = Event::time - $t;
		3103
		3104	#next unless $t < 0.0013;#d#
		3105	if ($t < $min) {
		3106	$min = $t;
		3107	}
		3108	$avg = $avg * 0.99 + $t * 0.01;
		3109	}
		3110	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3111	exit 0;
		3112	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3113	};
		3114
		3115	$RUNTIME += $TICK;
558	$NEXT_TICK += $TICK;	3116	$NEXT_TICK += $TICK;
559		3117
		3118	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3119	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3120	Coro::async_pool {
		3121	write_runtime
		3122	or warn "ERROR: unable to write runtime file: $!";
		3123	};
		3124	}
		3125
		3126	# my $AFTER = Event::time;
		3127	# warn $AFTER - $NOW;#d#
		3128
		3129	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3130	$sig->send;
		3131	}
		3132	while (my $sig = shift @WAIT_FOR_TICK) {
		3133	$sig->send;
		3134	}
		3135
		3136	$NOW = Event::time;
		3137
560	# if we are delayed by four ticks, skip them all	3138	# if we are delayed by four ticks or more, skip them all
561	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3139	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
562		3140
563	$TICK_WATCHER->at ($NEXT_TICK);	3141	$TICK_WATCHER->at ($NEXT_TICK);
564	$TICK_WATCHER->start;	3142	$TICK_WATCHER->start;
		3143
		3144	$LOAD = ($NOW - $tick_start) / $TICK;
		3145	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3146
		3147	_post_tick;
		3148
		3149
565	},	3150	},
566	);	3151	);
567		3152
		3153	{
		3154	BDB::max_poll_time $TICK * 0.1;
		3155	$BDB_POLL_WATCHER = Event->io (
		3156	reentrant => 0,
		3157	fd => BDB::poll_fileno,
		3158	poll => 'r',
		3159	prio => 0,
		3160	data => WF_AUTOCANCEL,
		3161	cb => \&BDB::poll_cb,
		3162	);
		3163	BDB::min_parallel 8;
		3164
		3165	BDB::set_sync_prepare {
		3166	my $status;
		3167	my $current = $Coro::current;
		3168	(
		3169	sub {
		3170	$status = $!;
		3171	$current->ready; undef $current;
		3172	},
		3173	sub {
		3174	Coro::schedule while defined $current;
		3175	$! = $status;
		3176	},
		3177	)
		3178	};
		3179
		3180	unless ($DB_ENV) {
		3181	$DB_ENV = BDB::db_env_create;
		3182
		3183	cf::sync_job {
		3184	eval {
		3185	BDB::db_env_open
		3186	$DB_ENV,
		3187	$BDBDIR,
		3188	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3189	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3190	0666;
		3191
		3192	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3193
		3194	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3195	$DB_ENV->set_lk_detect;
		3196	};
		3197
		3198	cf::cleanup "db_env_open(db): $@" if $@;
		3199	};
		3200	}
		3201	}
		3202
		3203	{
		3204	IO::AIO::min_parallel 8;
		3205
		3206	undef $Coro::AIO::WATCHER;
		3207	IO::AIO::max_poll_time $TICK * 0.1;
		3208	$AIO_POLL_WATCHER = Event->io (
		3209	reentrant => 0,
		3210	data => WF_AUTOCANCEL,
		3211	fd => IO::AIO::poll_fileno,
		3212	poll => 'r',
		3213	prio => 6,
		3214	cb => \&IO::AIO::poll_cb,
		3215	);
		3216	}
		3217
		3218	my $_log_backtrace;
		3219
		3220	sub _log_backtrace {
		3221	my ($msg, @addr) = @_;
		3222
		3223	$msg =~ s/\n//;
		3224
		3225	# limit the # of concurrent backtraces
		3226	if ($_log_backtrace < 2) {
		3227	++$_log_backtrace;
		3228	async {
		3229	my @bt = fork_call {
		3230	@addr = map { sprintf "%x", $_ } @addr;
		3231	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3232	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3233	or die "addr2line: $!";
		3234
		3235	my @funcs;
		3236	my @res = <$fh>;
		3237	chomp for @res;
		3238	while (@res) {
		3239	my ($func, $line) = splice @res, 0, 2, ();
		3240	push @funcs, "[$func] $line";
		3241	}
		3242
		3243	@funcs
		3244	};
		3245
		3246	LOG llevInfo, "[ABT] $msg\n";
		3247	LOG llevInfo, "[ABT] $_\n" for @bt;
		3248	--$_log_backtrace;
		3249	};
		3250	} else {
		3251	LOG llevInfo, "[ABT] $msg\n";
		3252	LOG llevInfo, "[ABT] [suppressed]\n";
		3253	}
		3254	}
		3255
		3256	# load additional modules
		3257	use cf::pod;
		3258
		3259	END { cf::emergency_save }
		3260
568	1	3261	1
569		3262

Diff Legend

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