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

Diff Legend

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