ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.405 by root, Mon Dec 17 08:03:22 2007 UTC

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

Diff Legend

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