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.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.366 by root, Tue Sep 11 16:05:35 2007 UTC

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

Diff Legend

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