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

Diff Legend

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