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.112 by root, Mon Jan 1 13:31:47 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 2007 UTC

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

Diff Legend

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