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.148 by root, Mon Jan 8 12:39:16 2007 UTC vs.
Revision 1.327 by root, Wed Aug 1 17:22:51 2007 UTC

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

Diff Legend

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