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.95 by root, Fri Dec 22 02:04:20 2006 UTC vs.
Revision 1.389 by root, Sat Oct 20 04:39:57 2007 UTC

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

Diff Legend

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