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.111 by root, Mon Jan 1 12:28:47 2007 UTC vs.
Revision 1.327 by root, Wed Aug 1 17:22:51 2007 UTC

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

Diff Legend

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