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

Diff Legend

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