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

Diff Legend

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