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.66 by root, Tue Sep 12 22:43:31 2006 UTC vs.
Revision 1.290 by root, Mon Jul 2 03:15:30 2007 UTC

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

Diff Legend

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