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

Diff Legend

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