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.395 by root, Sat Nov 10 22:41:59 2007 UTC

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

Diff Legend

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