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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.390 by root, Thu Oct 25 09:01:24 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}";
		2138
		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;
762		2284
763	=over 4	2285	=over 4
764		2286
765	=item cf::player::exists $login	2287	=item $ob->inv_recursive
766		2288
767	Returns true when the given account exists.	2289	Returns the inventory of the object _and_ their inventories, recursively.
768		2290
769	=cut	2291	=cut
770		2292
771	sub cf::player::exists($) {	2293	sub inv_recursive_;
772	cf::player::find $_[0]	2294	sub inv_recursive_ {
773	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2295	map { $_, inv_recursive_ $_->inv } @_
774	}	2296	}
		2297
		2298	sub inv_recursive {
		2299	inv_recursive_ inv $_[0]
		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;
		2331
		2332	=back
		2333
		2334	=head3 cf::object::player
		2335
		2336	=over 4
775		2337
776	=item $player_object->reply ($npc, $msg[, $flags])	2338	=item $player_object->reply ($npc, $msg[, $flags])
777		2339
778	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2340	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
779	can be C<undef>. Does the right thing when the player is currently in a	2341	can be C<undef>. Does the right thing when the player is currently in a
…		…
781		2343
782	=cut	2344	=cut
783		2345
784	# rough implementation of a future "reply" method that works	2346	# rough implementation of a future "reply" method that works
785	# with dialog boxes.	2347	# with dialog boxes.
		2348	#TODO: the first argument must go, split into a $npc->reply_to ( method
786	sub cf::object::player::reply($$$;$) {	2349	sub cf::object::player::reply($$$;$) {
787	my ($self, $npc, $msg, $flags) = @_;	2350	my ($self, $npc, $msg, $flags) = @_;
788		2351
789	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2352	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790		2353
791	if ($self->{record_replies}) {	2354	if ($self->{record_replies}) {
792	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2355	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2356
793	} 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 {
794	$msg = $npc->name . " says: $msg" if $npc;	2365	$msg = $npc->name . " says: $msg" if $npc;
795	$self->message ($msg, $flags);	2366	$self->message ($msg, $flags);
		2367	}
796	}	2368	}
797	}	2369	}
798		2370
799	=item $player->ext_reply ($msgid, $msgtype, %msg)	2371	=item $object->send_msg ($channel, $msg, $color, [extra...])
800		2372
801	Sends an ext reply to the player.
802
803	=cut	2373	=cut
804		2374
805	sub cf::player::ext_reply($$$%) {	2375	sub cf::object::send_msg {
806	my ($self, $id, %msg) = @_;	2376	my $pl = shift->contr
807		2377	or return;
808	$msg{msgid} = $id;	2378	$pl->send_msg (@_);
809
810	$self->send ("ext " . to_json \%msg);
811	}	2379	}
812		2380
813	=item $player_object->may ("access")	2381	=item $player_object->may ("access")
814		2382
815	Returns wether the given player is authorized to access resource "access"	2383	Returns wether the given player is authorized to access resource "access"
…		…
824	(ref $cf::CFG{"may_$access"}	2392	(ref $cf::CFG{"may_$access"}
825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2393	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826	: $cf::CFG{"may_$access"})	2394	: $cf::CFG{"may_$access"})
827	}	2395	}
828		2396
829	=cut	2397	=item $player_object->enter_link
830		2398
831	#############################################################################	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
		2644	=head3 cf::client
		2645
		2646	=over 4
		2647
		2648	=item $client->send_drawinfo ($text, $flags)
		2649
		2650	Sends a drawinfo packet to the client. Circumvents output buffering so
		2651	should not be used under normal circumstances.
		2652
		2653	=cut
		2654
		2655	sub cf::client::send_drawinfo {
		2656	my ($self, $text, $flags) = @_;
		2657
		2658	utf8::encode $text;
		2659	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2660	}
		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	"c/who" => {
		2697	id => "infobox",
		2698	title => "Players",
		2699	reply => undef,
		2700	tooltip => "Shows players who are currently online",
		2701	},
		2702	"c/body" => {
		2703	id => "infobox",
		2704	title => "Body Parts",
		2705	reply => undef,
		2706	tooltip => "Shows which body parts you posess and are available",
		2707	},
		2708	"c/uptime" => {
		2709	id => "infobox",
		2710	title => "Uptime",
		2711	reply => undef,
		2712	tooltip => "How long the server has been running sicne last restart",
		2713	},
		2714	"c/mapinfo" => {
		2715	id => "infobox",
		2716	title => "Map Info",
		2717	reply => undef,
		2718	tooltip => "Information related to the maps",
		2719	},
		2720	);
		2721
		2722	sub cf::client::send_msg {
		2723	my ($self, $channel, $msg, $color, @extra) = @_;
		2724
		2725	$msg = $self->pl->expand_cfpod ($msg);
		2726
		2727	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2728
		2729	# check predefined channels, for the benefit of C
		2730	if ($CHANNEL{$channel}) {
		2731	$channel = $CHANNEL{$channel};
		2732
		2733	$self->ext_msg (channel_info => $channel)
		2734	if $self->can_msg;
		2735
		2736	$channel = $channel->{id};
		2737
		2738	} elsif (ref $channel) {
		2739	# send meta info to client, if not yet sent
		2740	unless (exists $self->{channel}{$channel->{id}}) {
		2741	$self->{channel}{$channel->{id}} = $channel;
		2742	$self->ext_msg (channel_info => $channel)
		2743	if $self->can_msg;
		2744	}
		2745
		2746	$channel = $channel->{id};
		2747	}
		2748
		2749	return unless @extra || length $msg;
		2750
		2751	if ($self->can_msg) {
		2752	# default colour, mask it out
		2753	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2754	if $color & cf::NDI_DEF;
		2755
		2756	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2757	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2758	} else {
		2759	if ($color >= 0) {
		2760	# replace some tags by gcfclient-compatible ones
		2761	for ($msg) {
		2762	1 while
		2763	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2764	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2765	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2766	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2767	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2768	}
		2769
		2770	$color &= cf::NDI_COLOR_MASK;
		2771
		2772	utf8::encode $msg;
		2773
		2774	if (0 && $msg =~ /\[/) {
		2775	# COMMAND/INFO
		2776	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2777	} else {
		2778	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2779	$self->send_packet ("drawinfo $color $msg")
		2780	}
		2781	}
		2782	}
		2783	}
		2784
		2785	=item $client->ext_msg ($type, @msg)
		2786
		2787	Sends an ext event to the client.
		2788
		2789	=cut
		2790
		2791	sub cf::client::ext_msg($$@) {
		2792	my ($self, $type, @msg) = @_;
		2793
		2794	if ($self->extcmd == 2) {
		2795	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2796	} elsif ($self->extcmd == 1) { # TODO: remove
		2797	push @msg, msgtype => "event_$type";
		2798	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2799	}
		2800	}
		2801
		2802	=item $client->ext_reply ($msgid, @msg)
		2803
		2804	Sends an ext reply to the client.
		2805
		2806	=cut
		2807
		2808	sub cf::client::ext_reply($$@) {
		2809	my ($self, $id, @msg) = @_;
		2810
		2811	if ($self->extcmd == 2) {
		2812	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2813	} elsif ($self->extcmd == 1) {
		2814	#TODO: version 1, remove
		2815	unshift @msg, msgtype => "reply", msgid => $id;
		2816	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2817	}
		2818	}
		2819
		2820	=item $success = $client->query ($flags, "text", \&cb)
		2821
		2822	Queues a query to the client, calling the given callback with
		2823	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2824	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2825
		2826	Queries can fail, so check the return code. Or don't, as queries will
		2827	become reliable at some point in the future.
		2828
		2829	=cut
		2830
		2831	sub cf::client::query {
		2832	my ($self, $flags, $text, $cb) = @_;
		2833
		2834	return unless $self->state == ST_PLAYING
		2835	|| $self->state == ST_SETUP
		2836	|| $self->state == ST_CUSTOM;
		2837
		2838	$self->state (ST_CUSTOM);
		2839
		2840	utf8::encode $text;
		2841	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2842
		2843	$self->send_packet ($self->{query_queue}[0][0])
		2844	if @{ $self->{query_queue} } == 1;
		2845
		2846	1
		2847	}
		2848
		2849	cf::client->attach (
		2850	on_connect => sub {
		2851	my ($ns) = @_;
		2852
		2853	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2854	},
		2855	on_reply => sub {
		2856	my ($ns, $msg) = @_;
		2857
		2858	# this weird shuffling is so that direct followup queries
		2859	# get handled first
		2860	my $queue = delete $ns->{query_queue}
		2861	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2862
		2863	(shift @$queue)->[1]->($msg);
		2864	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2865
		2866	push @{ $ns->{query_queue} }, @$queue;
		2867
		2868	if (@{ $ns->{query_queue} } == @$queue) {
		2869	if (@$queue) {
		2870	$ns->send_packet ($ns->{query_queue}[0][0]);
		2871	} else {
		2872	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2873	}
		2874	}
		2875	},
		2876	on_exticmd => sub {
		2877	my ($ns, $buf) = @_;
		2878
		2879	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2880
		2881	if (ref $msg) {
		2882	my ($type, $reply, @payload) =
		2883	"ARRAY" eq ref $msg
		2884	? @$msg
		2885	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2886
		2887	my @reply;
		2888
		2889	if (my $cb = $EXTICMD{$type}) {
		2890	@reply = $cb->($ns, @payload);
		2891	}
		2892
		2893	$ns->ext_reply ($reply, @reply)
		2894	if $reply;
		2895
		2896	} else {
		2897	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2898	}
		2899
		2900	cf::override;
		2901	},
		2902	);
		2903
		2904	=item $client->async (\&cb)
		2905
		2906	Create a new coroutine, running the specified callback. The coroutine will
		2907	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2908	or loss of connection).
		2909
		2910	=cut
		2911
		2912	sub cf::client::async {
		2913	my ($self, $cb) = @_;
		2914
		2915	my $coro = &Coro::async ($cb);
		2916
		2917	$coro->on_destroy (sub {
		2918	delete $self->{_coro}{$coro+0};
		2919	});
		2920
		2921	$self->{_coro}{$coro+0} = $coro;
		2922
		2923	$coro
		2924	}
		2925
		2926	cf::client->attach (
		2927	on_destroy => sub {
		2928	my ($ns) = @_;
		2929
		2930	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2931	},
		2932	);
		2933
		2934	=back
		2935
832		2936
833	=head2 SAFE SCRIPTING	2937	=head2 SAFE SCRIPTING
834		2938
835	Functions that provide a safe environment to compile and execute	2939	Functions that provide a safe environment to compile and execute
836	snippets of perl code without them endangering the safety of the server	2940	snippets of perl code without them endangering the safety of the server
…		…
843	our $safe = new Safe "safe";	2947	our $safe = new Safe "safe";
844	our $safe_hole = new Safe::Hole;	2948	our $safe_hole = new Safe::Hole;
845		2949
846	$SIG{FPE} = 'IGNORE';	2950	$SIG{FPE} = 'IGNORE';
847		2951
848	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2952	$safe->permit_only (Opcode::opset qw(
		2953	:base_core :base_mem :base_orig :base_math
		2954	grepstart grepwhile mapstart mapwhile
		2955	sort time
		2956	));
849		2957
850	# here we export the classes and methods available to script code	2958	# here we export the classes and methods available to script code
851		2959
852	=pod	2960	=pod
853		2961
854	The following fucntions and emthods are available within a safe environment:	2962	The following functions and methods are available within a safe environment:
855		2963
856	cf::object contr pay_amount pay_player map	2964	cf::object
		2965	contr pay_amount pay_player map x y force_find force_add destroy
		2966	insert remove name archname title slaying race decrease_ob_nr
		2967
857	cf::object::player player	2968	cf::object::player
858	cf::player peaceful	2969	player
859	cf::map trigger	2970
		2971	cf::player
		2972	peaceful
		2973
		2974	cf::map
		2975	trigger
860		2976
861	=cut	2977	=cut
862		2978
863	for (	2979	for (
864	["cf::object" => qw(contr pay_amount pay_player map)],	2980	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2981	insert remove inv name archname title slaying race
		2982	decrease_ob_nr destroy)],
865	["cf::object::player" => qw(player)],	2983	["cf::object::player" => qw(player)],
866	["cf::player" => qw(peaceful)],	2984	["cf::player" => qw(peaceful)],
867	["cf::map" => qw(trigger)],	2985	["cf::map" => qw(trigger)],
868	) {	2986	) {
869	no strict 'refs';	2987	no strict 'refs';
…		…
940	=back	3058	=back
941		3059
942	=cut	3060	=cut
943		3061
944	#############################################################################	3062	#############################################################################
		3063	# the server's init and main functions
945		3064
946	=head2 EXTENSION DATABASE SUPPORT	3065	sub load_facedata($) {
		3066	my ($path) = @_;
947		3067
948	Crossfire maintains a very simple database for extension use. It can	3068	# HACK to clear player env face cache, we need some signal framework
949	currently store anything that can be serialised using Storable, which	3069	# for this (global event?)
950	excludes objects.	3070	%ext::player_env::MUSIC_FACE_CACHE = ();
951		3071
952	The parameter C<$family> should best start with the name of the extension	3072	my $enc = JSON::XS->new->utf8->canonical->relaxed;
953	using it, it should be unique.
954		3073
955	=over 4	3074	warn "loading facedata from $path\n";
956		3075
957	=item $hashref = cf::db_get $family	3076	my $facedata;
		3077	0 < aio_load $path, $facedata
		3078	or die "$path: $!";
958		3079
959	Return a hashref for use by the extension C<$family>, which can be	3080	$facedata = Coro::Storable::thaw $facedata;
960	modified. After modifications, you have to call C<cf::db_dirty> or
961	C<cf::db_sync>.
962		3081
963	=item $value = cf::db_get $family => $key	3082	$facedata->{version} == 2
		3083	or cf::cleanup "$path: version mismatch, cannot proceed.";
964		3084
965	Returns a single value from the database	3085	# patch in the exptable
966		3086	$facedata->{resource}{"res/exp_table"} = {
967	=item cf::db_put $family => $hashref	3087	type => FT_RSRC,
968		3088	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
969	Stores the given family hashref into the database. Updates are delayed, if
970	you want the data to be synced to disk immediately, use C<cf::db_sync>.
971
972	=item cf::db_put $family => $key => $value
973
974	Stores the given C<$value> in the family hash. Updates are delayed, if you
975	want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977	=item cf::db_dirty
978
979	Marks the database as dirty, to be updated at a later time.
980
981	=item cf::db_sync
982
983	Immediately write the database to disk I<if it is dirty>.
984
985	=cut
986
987	our $DB;
988
989	{
990	my $path = cf::localdir . "/database.pst";
991
992	sub db_load() {
993	warn "loading database $path\n";#d# remove later
994	$DB = stat $path ? Storable::retrieve $path : { };
995	}
996
997	my $pid;
998
999	sub db_save() {
1000	warn "saving database $path\n";#d# remove later
1001	waitpid $pid, 0 if $pid;
1002	if (0 == ($pid = fork)) {
1003	$DB->{_meta}{version} = 1;
1004	Storable::nstore $DB, "$path~";
1005	rename "$path~", $path;
1006	cf::_exit 0 if defined $pid;
1007	}
1008	}
1009
1010	my $dirty;
1011
1012	sub db_sync() {
1013	db_save if $dirty;
1014	undef $dirty;
1015	}
1016
1017	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018	db_sync;
1019	});	3089	};
		3090	cf::cede_to_tick;
1020		3091
1021	sub db_dirty() {
1022	$dirty = 1;
1023	$idle->start;
1024	}	3092	{
		3093	my $faces = $facedata->{faceinfo};
1025		3094
1026	sub db_get($;$) {	3095	while (my ($face, $info) = each %$faces) {
1027	@_ >= 2	3096	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1028	? $DB->{$_[0]}{$_[1]}	3097	cf::face::set_visibility $idx, $info->{visibility};
1029	: ($DB->{$_[0]} ||= { })	3098	cf::face::set_magicmap $idx, $info->{magicmap};
1030	}	3099	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3100	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1031		3101
1032	sub db_put($$;$) {	3102	cf::cede_to_tick;
1033	if (@_ >= 3) {
1034	$DB->{$_[0]}{$_[1]} = $_[2];
1035	} else {
1036	$DB->{$_[0]} = $_[1];
1037	}
1038	db_dirty;
1039	}
1040
1041	cf::global->attach (
1042	prio => 10000,
1043	on_cleanup => sub {
1044	db_sync;
1045	},	3103	}
1046	);
1047	}
1048		3104
1049	#############################################################################	3105	while (my ($face, $info) = each %$faces) {
1050	# the server's main()	3106	next unless $info->{smooth};
		3107	my $idx = cf::face::find $face
		3108	or next;
		3109	if (my $smooth = cf::face::find $info->{smooth}) {
		3110	cf::face::set_smooth $idx, $smooth;
		3111	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3112	} else {
		3113	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3114	}
1051		3115
1052	sub cfg_load {	3116	cf::cede_to_tick;
		3117	}
		3118	}
		3119
		3120	{
		3121	my $anims = $facedata->{animinfo};
		3122
		3123	while (my ($anim, $info) = each %$anims) {
		3124	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3125	cf::cede_to_tick;
		3126	}
		3127
		3128	cf::anim::invalidate_all; # d'oh
		3129	}
		3130
		3131	{
		3132	# TODO: for gcfclient pleasure, we should give resources
		3133	# that gcfclient doesn't grok a >10000 face index.
		3134	my $res = $facedata->{resource};
		3135
		3136	my $soundconf = delete $res->{"res/sound.conf"};
		3137
		3138	while (my ($name, $info) = each %$res) {
		3139	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3140	my $data;
		3141
		3142	if ($info->{type} & 1) {
		3143	# prepend meta info
		3144
		3145	my $meta = $enc->encode ({
		3146	name => $name,
		3147	%{ $info->{meta} || {} },
		3148	});
		3149
		3150	$data = pack "(w/a*)*", $meta, $info->{data};
		3151	} else {
		3152	$data = $info->{data};
		3153	}
		3154
		3155	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3156	cf::face::set_type $idx, $info->{type};
		3157
		3158	cf::cede_to_tick;
		3159	}
		3160
		3161	if ($soundconf) {
		3162	$soundconf = $enc->decode (delete $soundconf->{data});
		3163
		3164	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3165	my $sound = $soundconf->{compat}[$_]
		3166	or next;
		3167
		3168	my $face = cf::face::find "sound/$sound->[1]";
		3169	cf::sound::set $sound->[0] => $face;
		3170	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3171	}
		3172
		3173	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3174	my $face = cf::face::find "sound/$v";
		3175	cf::sound::set $k => $face;
		3176	}
		3177	}
		3178	}
		3179
		3180	1
		3181	}
		3182
		3183	register_exticmd fx_want => sub {
		3184	my ($ns, $want) = @_;
		3185
		3186	while (my ($k, $v) = each %$want) {
		3187	$ns->fx_want ($k, $v);
		3188	}
		3189	};
		3190
		3191	sub reload_regions {
		3192	# HACK to clear player env face cache, we need some signal framework
		3193	# for this (global event?)
		3194	%ext::player_env::MUSIC_FACE_CACHE = ();
		3195
		3196	load_resource_file "$MAPDIR/regions"
		3197	or die "unable to load regions file\n";
		3198
		3199	for (cf::region::list) {
		3200	$_->{match} = qr/$_->{match}/
		3201	if exists $_->{match};
		3202	}
		3203	}
		3204
		3205	sub reload_facedata {
		3206	load_facedata "$DATADIR/facedata"
		3207	or die "unable to load facedata\n";
		3208	}
		3209
		3210	sub reload_archetypes {
		3211	load_resource_file "$DATADIR/archetypes"
		3212	or die "unable to load archetypes\n";
		3213	#d# NEED to laod twice to resolve forward references
		3214	# this really needs to be done in an extra post-pass
		3215	# (which needs to be synchronous, so solve it differently)
		3216	load_resource_file "$DATADIR/archetypes"
		3217	or die "unable to load archetypes\n";
		3218	}
		3219
		3220	sub reload_treasures {
		3221	load_resource_file "$DATADIR/treasures"
		3222	or die "unable to load treasurelists\n";
		3223	}
		3224
		3225	sub reload_resources {
		3226	warn "reloading resource files...\n";
		3227
		3228	reload_regions;
		3229	reload_facedata;
		3230	#reload_archetypes;#d#
		3231	reload_archetypes;
		3232	reload_treasures;
		3233
		3234	warn "finished reloading resource files\n";
		3235	}
		3236
		3237	sub init {
		3238	reload_resources;
		3239	}
		3240
		3241	sub reload_config {
1053	open my $fh, "<:utf8", cf::confdir . "/config"	3242	open my $fh, "<:utf8", "$CONFDIR/config"
1054	or return;	3243	or return;
1055		3244
1056	local $/;	3245	local $/;
1057	*CFG = YAML::Syck::Load <$fh>;	3246	*CFG = YAML::Syck::Load <$fh>;
		3247
		3248	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3249
		3250	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3251	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3252
		3253	if (exists $CFG{mlockall}) {
		3254	eval {
		3255	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3256	and die "WARNING: m(un)lockall failed: $!\n";
		3257	};
		3258	warn $@ if $@;
		3259	}
1058	}	3260	}
1059		3261
1060	sub main {	3262	sub main {
1061	cfg_load;	3263	# we must not ever block the main coroutine
1062	db_load;	3264	local $Coro::idle = sub {
		3265	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3266	(async {
		3267	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3268	Event::one_event;
		3269	})->prio (Coro::PRIO_MAX);
		3270	};
		3271
		3272	reload_config;
		3273	db_init;
1063	load_extensions;	3274	load_extensions;
		3275
		3276	$TICK_WATCHER->start;
1064	Event::loop;	3277	Event::loop;
1065	}	3278	}
1066		3279
1067	#############################################################################	3280	#############################################################################
1068	# initialisation	3281	# initialisation and cleanup
1069		3282
1070	sub _perl_reload(&) {	3283	# install some emergency cleanup handlers
		3284	BEGIN {
		3285	for my $signal (qw(INT HUP TERM)) {
		3286	Event->signal (
		3287	reentrant => 0,
		3288	data => WF_AUTOCANCEL,
		3289	signal => $signal,
		3290	prio => 0,
		3291	cb => sub {
		3292	cf::cleanup "SIG$signal";
		3293	},
		3294	);
		3295	}
		3296	}
		3297
		3298	sub write_runtime {
		3299	my $runtime = "$LOCALDIR/runtime";
		3300
		3301	# first touch the runtime file to show we are still running:
		3302	# the fsync below can take a very very long time.
		3303
		3304	IO::AIO::aio_utime $runtime, undef, undef;
		3305
		3306	my $guard = cf::lock_acquire "write_runtime";
		3307
		3308	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3309	or return;
		3310
		3311	my $value = $cf::RUNTIME + 90 + 10;
		3312	# 10 is the runtime save interval, for a monotonic clock
		3313	# 60 allows for the watchdog to kill the server.
		3314
		3315	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3316	and return;
		3317
		3318	# always fsync - this file is important
		3319	aio_fsync $fh
		3320	and return;
		3321
		3322	# touch it again to show we are up-to-date
		3323	aio_utime $fh, undef, undef;
		3324
		3325	close $fh
		3326	or return;
		3327
		3328	aio_rename "$runtime~", $runtime
		3329	and return;
		3330
		3331	warn "runtime file written.\n";
		3332
		3333	1
		3334	}
		3335
		3336	sub emergency_save() {
		3337	my $freeze_guard = cf::freeze_mainloop;
		3338
		3339	warn "enter emergency perl save\n";
		3340
		3341	cf::sync_job {
		3342	# use a peculiar iteration method to avoid tripping on perl
		3343	# refcount bugs in for. also avoids problems with players
		3344	# and maps saved/destroyed asynchronously.
		3345	warn "begin emergency player save\n";
		3346	for my $login (keys %cf::PLAYER) {
		3347	my $pl = $cf::PLAYER{$login} or next;
		3348	$pl->valid or next;
		3349	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3350	$pl->save;
		3351	}
		3352	warn "end emergency player save\n";
		3353
		3354	warn "begin emergency map save\n";
		3355	for my $path (keys %cf::MAP) {
		3356	my $map = $cf::MAP{$path} or next;
		3357	$map->valid or next;
		3358	$map->save;
		3359	}
		3360	warn "end emergency map save\n";
		3361
		3362	warn "begin emergency database checkpoint\n";
		3363	BDB::db_env_txn_checkpoint $DB_ENV;
		3364	warn "end emergency database checkpoint\n";
		3365	};
		3366
		3367	warn "leave emergency perl save\n";
		3368	}
		3369
		3370	sub post_cleanup {
1071	my ($msg) = @_;	3371	my ($make_core) = @_;
1072		3372
1073	$msg->("reloading...");	3373	warn Carp::longmess "post_cleanup backtrace"
		3374	if $make_core;
		3375	}
1074		3376
1075	eval {	3377	sub do_reload_perl() {
1076	# cancel all watchers	3378	# can/must only be called in main
		3379	if ($Coro::current != $Coro::main) {
		3380	warn "can only reload from main coroutine";
		3381	return;
		3382	}
		3383
		3384	warn "reloading...";
		3385
		3386	warn "entering sync_job";
		3387
		3388	cf::sync_job {
		3389	cf::write_runtime; # external watchdog should not bark
		3390	cf::emergency_save;
		3391	cf::write_runtime; # external watchdog should not bark
		3392
		3393	warn "syncing database to disk";
		3394	BDB::db_env_txn_checkpoint $DB_ENV;
		3395
		3396	# if anything goes wrong in here, we should simply crash as we already saved
		3397
		3398	warn "cancelling all WF_AUTOCANCEL watchers";
1077	for (Event::all_watchers) {	3399	for (Event::all_watchers) {
1078	$_->cancel if $_->data & WF_AUTOCANCEL;	3400	$_->cancel if $_->data & WF_AUTOCANCEL;
1079	}	3401	}
1080		3402
1081	# unload all extensions	3403	warn "flushing outstanding aio requests";
1082	for (@exts) {	3404	for (;;) {
1083	$msg->("unloading <$_>");	3405	BDB::flush;
1084	unload_extension $_;	3406	IO::AIO::flush;
		3407	Coro::cede_notself;
		3408	last unless IO::AIO::nreqs || BDB::nreqs;
		3409	warn "iterate...";
		3410	}
		3411
		3412	++$RELOAD;
		3413
		3414	warn "cancelling all extension coros";
		3415	$_->cancel for values %EXT_CORO;
		3416	%EXT_CORO = ();
		3417
		3418	warn "removing commands";
		3419	%COMMAND = ();
		3420
		3421	warn "removing ext/exti commands";
		3422	%EXTCMD = ();
		3423	%EXTICMD = ();
		3424
		3425	warn "unloading/nuking all extensions";
		3426	for my $pkg (@EXTS) {
		3427	warn "... unloading $pkg";
		3428
		3429	if (my $cb = $pkg->can ("unload")) {
		3430	eval {
		3431	$cb->($pkg);
		3432	1
		3433	} or warn "$pkg unloaded, but with errors: $@";
1085	}	3434	}
1086		3435
		3436	warn "... nuking $pkg";
		3437	Symbol::delete_package $pkg;
		3438	}
		3439
1087	# unload all modules loaded from $LIBDIR	3440	warn "unloading all perl modules loaded from $LIBDIR";
1088	while (my ($k, $v) = each %INC) {	3441	while (my ($k, $v) = each %INC) {
1089	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3442	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090		3443
1091	$msg->("removing <$k>");	3444	warn "... unloading $k";
1092	delete $INC{$k};	3445	delete $INC{$k};
1093		3446
1094	$k =~ s/\.pm$//;	3447	$k =~ s/\.pm$//;
1095	$k =~ s/\//::/g;	3448	$k =~ s/\//::/g;
1096		3449
…		…
1099	}	3452	}
1100		3453
1101	Symbol::delete_package $k;	3454	Symbol::delete_package $k;
1102	}	3455	}
1103		3456
1104	# sync database to disk
1105	cf::db_sync;
1106
1107	# get rid of safe::, as good as possible	3457	warn "getting rid of safe::, as good as possible";
1108	Symbol::delete_package "safe::$_"	3458	Symbol::delete_package "safe::$_"
1109	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	3459	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110		3460
1111	# remove register_script_function callbacks
1112	# TODO
1113
1114	# unload cf.pm "a bit"	3461	warn "unloading cf.pm \"a bit\"";
1115	delete $INC{"cf.pm"};	3462	delete $INC{"cf.pm"};
		3463	delete $INC{"cf/pod.pm"};
1116		3464
1117	# don't, removes xs symbols, too,	3465	# don't, removes xs symbols, too,
1118	# and global variables created in xs	3466	# and global variables created in xs
1119	#Symbol::delete_package __PACKAGE__;	3467	#Symbol::delete_package __PACKAGE__;
1120		3468
1121	# reload cf.pm	3469	warn "unload completed, starting to reload now";
		3470
1122	$msg->("reloading cf.pm");	3471	warn "reloading cf.pm";
1123	require cf;	3472	require cf;
		3473	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124		3474
1125	# load config and database again	3475	warn "loading config and database again";
1126	cf::cfg_load;	3476	cf::reload_config;
1127	cf::db_load;
1128		3477
1129	# load extensions	3478	warn "loading extensions";
1130	$msg->("load extensions");
1131	cf::load_extensions;	3479	cf::load_extensions;
1132		3480
1133	# reattach attachments to objects	3481	warn "reattaching attachments to objects/players";
1134	$msg->("reattach");	3482	_global_reattach; # objects, sockets
1135	_global_reattach;	3483	warn "reattaching attachments to maps";
		3484	reattach $_ for values %MAP;
		3485	warn "reattaching attachments to players";
		3486	reattach $_ for values %PLAYER;
		3487
		3488	warn "leaving sync_job";
		3489
		3490	1
		3491	} or do {
		3492	warn $@;
		3493	warn "error while reloading, exiting.";
		3494	exit 1;
1136	};	3495	};
1137	$msg->($@) if $@;
1138		3496
1139	$msg->("reloaded");	3497	warn "reloaded";
1140	};	3498	};
1141		3499
1142	sub perl_reload() {	3500	our $RELOAD_WATCHER; # used only during reload
1143	_perl_reload {	3501
1144	warn $_[0];	3502	sub reload_perl() {
1145	print "$_[0]\n";	3503	# doing reload synchronously and two reloads happen back-to-back,
		3504	# coro crashes during coro_state_free->destroy here.
		3505
		3506	$RELOAD_WATCHER ||= Event->timer (
		3507	reentrant => 0,
		3508	after => 0,
		3509	data => WF_AUTOCANCEL,
		3510	cb => sub {
		3511	do_reload_perl;
		3512	undef $RELOAD_WATCHER;
		3513	},
1146	};	3514	);
1147	}	3515	}
1148		3516
1149	register "<global>", __PACKAGE__;
1150
1151	register_command "perl-reload" => sub {	3517	register_command "reload" => sub {
1152	my ($who, $arg) = @_;	3518	my ($who, $arg) = @_;
1153		3519
1154	if ($who->flag (FLAG_WIZ)) {	3520	if ($who->flag (FLAG_WIZ)) {
1155	_perl_reload {	3521	$who->message ("reloading server.");
1156	warn $_[0];	3522	async {
1157	$who->message ($_[0]);	3523	$Coro::current->{desc} = "perl_reload";
		3524	reload_perl;
1158	};	3525	};
1159	}	3526	}
1160	};	3527	};
1161		3528
1162	unshift @INC, $LIBDIR;	3529	unshift @INC, $LIBDIR;
1163		3530
		3531	my $bug_warning = 0;
		3532
		3533	our @WAIT_FOR_TICK;
		3534	our @WAIT_FOR_TICK_BEGIN;
		3535
		3536	sub wait_for_tick {
		3537	return unless $TICK_WATCHER->is_active;
		3538	return if $Coro::current == $Coro::main;
		3539
		3540	my $signal = new Coro::Signal;
		3541	push @WAIT_FOR_TICK, $signal;
		3542	$signal->wait;
		3543	}
		3544
		3545	sub wait_for_tick_begin {
		3546	return unless $TICK_WATCHER->is_active;
		3547	return if $Coro::current == $Coro::main;
		3548
		3549	my $signal = new Coro::Signal;
		3550	push @WAIT_FOR_TICK_BEGIN, $signal;
		3551	$signal->wait;
		3552	}
		3553
1164	$TICK_WATCHER = Event->timer (	3554	$TICK_WATCHER = Event->timer (
		3555	reentrant => 0,
		3556	parked => 1,
1165	prio => 0,	3557	prio => 0,
1166	at => $NEXT_TICK || 1,	3558	at => $NEXT_TICK || $TICK,
1167	data => WF_AUTOCANCEL,	3559	data => WF_AUTOCANCEL,
1168	cb => sub {	3560	cb => sub {
		3561	if ($Coro::current != $Coro::main) {
		3562	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3563	unless ++$bug_warning > 10;
		3564	return;
		3565	}
		3566
		3567	$NOW = $tick_start = Event::time;
		3568
1169	cf::server_tick; # one server iteration	3569	cf::server_tick; # one server iteration
1170		3570
1171	my $NOW = Event::time;	3571	$RUNTIME += $TICK;
1172	$NEXT_TICK += $TICK;	3572	$NEXT_TICK += $TICK;
		3573
		3574	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3575	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3576	Coro::async_pool {
		3577	$Coro::current->{desc} = "runtime saver";
		3578	write_runtime
		3579	or warn "ERROR: unable to write runtime file: $!";
		3580	};
		3581	}
		3582
		3583	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3584	$sig->send;
		3585	}
		3586	while (my $sig = shift @WAIT_FOR_TICK) {
		3587	$sig->send;
		3588	}
		3589
		3590	$NOW = Event::time;
1173		3591
1174	# if we are delayed by four ticks or more, skip them all	3592	# if we are delayed by four ticks or more, skip them all
1175	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3593	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1176		3594
1177	$TICK_WATCHER->at ($NEXT_TICK);	3595	$TICK_WATCHER->at ($NEXT_TICK);
1178	$TICK_WATCHER->start;	3596	$TICK_WATCHER->start;
		3597
		3598	$LOAD = ($NOW - $tick_start) / $TICK;
		3599	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3600
		3601	_post_tick;
1179	},	3602	},
1180	);	3603	);
1181		3604
		3605	{
		3606	BDB::min_parallel 8;
		3607	BDB::max_poll_time $TICK * 0.1;
		3608	$BDB_POLL_WATCHER = Event->io (
		3609	reentrant => 0,
		3610	fd => BDB::poll_fileno,
		3611	poll => 'r',
		3612	prio => 0,
		3613	data => WF_AUTOCANCEL,
		3614	cb => \&BDB::poll_cb,
		3615	);
		3616
		3617	BDB::set_sync_prepare {
		3618	my $status;
		3619	my $current = $Coro::current;
		3620	(
		3621	sub {
		3622	$status = $!;
		3623	$current->ready; undef $current;
		3624	},
		3625	sub {
		3626	Coro::schedule while defined $current;
		3627	$! = $status;
		3628	},
		3629	)
		3630	};
		3631
		3632	unless ($DB_ENV) {
		3633	$DB_ENV = BDB::db_env_create;
		3634	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3635	| BDB::LOG_AUTOREMOVE, 1);
		3636	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3637	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3638
		3639	cf::sync_job {
		3640	eval {
		3641	BDB::db_env_open
		3642	$DB_ENV,
		3643	$BDBDIR,
		3644	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3645	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3646	0666;
		3647
		3648	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3649	};
		3650
		3651	cf::cleanup "db_env_open(db): $@" if $@;
		3652	};
		3653	}
		3654
		3655	$BDB_DEADLOCK_WATCHER = Event->timer (
		3656	after => 3,
		3657	interval => 1,
		3658	hard => 1,
		3659	prio => 0,
		3660	data => WF_AUTOCANCEL,
		3661	cb => sub {
		3662	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3663	},
		3664	);
		3665	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3666	after => 11,
		3667	interval => 60,
		3668	hard => 1,
		3669	prio => 0,
		3670	data => WF_AUTOCANCEL,
		3671	cb => sub {
		3672	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3673	},
		3674	);
		3675	$BDB_TRICKLE_WATCHER = Event->timer (
		3676	after => 5,
		3677	interval => 10,
		3678	hard => 1,
		3679	prio => 0,
		3680	data => WF_AUTOCANCEL,
		3681	cb => sub {
		3682	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3683	},
		3684	);
		3685	}
		3686
		3687	{
		3688	IO::AIO::min_parallel 8;
		3689
		3690	undef $Coro::AIO::WATCHER;
1182	IO::AIO::max_poll_time $TICK * 0.2;	3691	IO::AIO::max_poll_time $TICK * 0.1;
1183		3692	$AIO_POLL_WATCHER = Event->io (
1184	Event->io (fd => IO::AIO::poll_fileno,	3693	reentrant => 0,
1185	poll => 'r',
1186	prio => 5,
1187	data => WF_AUTOCANCEL,	3694	data => WF_AUTOCANCEL,
		3695	fd => IO::AIO::poll_fileno,
		3696	poll => 'r',
		3697	prio => 0,
1188	cb => \&IO::AIO::poll_cb);	3698	cb => \&IO::AIO::poll_cb,
		3699	);
		3700	}
		3701
		3702	my $_log_backtrace;
		3703
		3704	sub _log_backtrace {
		3705	my ($msg, @addr) = @_;
		3706
		3707	$msg =~ s/\n//;
		3708
		3709	# limit the # of concurrent backtraces
		3710	if ($_log_backtrace < 2) {
		3711	++$_log_backtrace;
		3712	async {
		3713	$Coro::current->{desc} = "abt $msg";
		3714
		3715	my @bt = fork_call {
		3716	@addr = map { sprintf "%x", $_ } @addr;
		3717	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3718	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3719	or die "addr2line: $!";
		3720
		3721	my @funcs;
		3722	my @res = <$fh>;
		3723	chomp for @res;
		3724	while (@res) {
		3725	my ($func, $line) = splice @res, 0, 2, ();
		3726	push @funcs, "[$func] $line";
		3727	}
		3728
		3729	@funcs
		3730	};
		3731
		3732	LOG llevInfo, "[ABT] $msg\n";
		3733	LOG llevInfo, "[ABT] $_\n" for @bt;
		3734	--$_log_backtrace;
		3735	};
		3736	} else {
		3737	LOG llevInfo, "[ABT] $msg\n";
		3738	LOG llevInfo, "[ABT] [suppressed]\n";
		3739	}
		3740	}
		3741
		3742	# load additional modules
		3743	use cf::pod;
		3744
		3745	END { cf::emergency_save }
1189		3746
1190	1	3747	1
1191		3748

Diff Legend

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