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

Diff Legend

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