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

Diff Legend

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