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

Diff Legend

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