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.146 by root, Sun Jan 7 23:10:43 2007 UTC vs.
Revision 1.318 by root, Tue Jul 24 04:55:34 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	IO::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	Coro::cede;
1142	$pl->save_pl ($path);	1360	$pl->save_pl ($path);
1143	Coro::cede;	1361	Coro::cede;
1144	}	1362	}
1145		1363
1146	sub new($) {	1364	sub new($) {
…		…
1154	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1155		1373
1156	$self	1374	$self
1157	}	1375	}
1158		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
1159	sub quit_character {	1384	sub quit_character {
1160	my ($pl) = @_;	1385	my ($pl) = @_;
		1386
		1387	my $name = $pl->ob->name;
1161		1388
1162	$pl->{deny_save} = 1;	1389	$pl->{deny_save} = 1;
1163	$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
1164		1391
1165	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1392	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1167	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1394	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1168	$pl->ns->destroy if $pl->ns;	1395	$pl->ns->destroy if $pl->ns;
1169		1396
1170	my $path = playerdir $pl;	1397	my $path = playerdir $pl;
1171	my $temp = "$path~$cf::RUNTIME~deleting~";	1398	my $temp = "$path~$cf::RUNTIME~deleting~";
1172	IO::AIO::aio_rename $path, $temp, sub {	1399	aio_rename $path, $temp;
1173	delete $cf::PLAYER{$pl->ob->name};	1400	delete $cf::PLAYER{$pl->ob->name};
1174	$pl->destroy;	1401	$pl->destroy;
1175		1402
		1403	my $prefix = qr<^~\Q$name\E/>;
		1404
		1405	# nuke player maps
		1406	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1407
1176	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;
1177	};	1445	}
1178	}
1179		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
1180	=item $player->ext_reply ($msgid, $msgtype, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1181		1529
1182	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1183		1531
1184	=cut	1532	=cut
1185		1533
1186	sub ext_reply($$$%) {	1534	sub ext_reply($$@) {
1187	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1188		1536
1189	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1190		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1191	$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	}
1192	}	1544	}
1193		1545
1194	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	}
1195		1586
1196	=back	1587	=back
1197
1198		1588
1199	=head3 cf::map	1589	=head3 cf::map
1200		1590
1201	=over 4	1591	=over 4
1202		1592
…		…
1205	package cf::map;	1595	package cf::map;
1206		1596
1207	use Fcntl;	1597	use Fcntl;
1208	use Coro::AIO;	1598	use Coro::AIO;
1209		1599
		1600	use overload
		1601	'""' => \&as_string,
		1602	fallback => 1;
		1603
1210	our $MAX_RESET = 3600;	1604	our $MAX_RESET = 3600;
1211	our $DEFAULT_RESET = 3000;	1605	our $DEFAULT_RESET = 3000;
1212		1606
1213	sub generate_random_map {	1607	sub generate_random_map {
1214	my ($path, $rmp) = @_;	1608	my ($self, $rmp) = @_;
1215
1216	# mit "rum" bekleckern, nicht	1609	# mit "rum" bekleckern, nicht
1217	cf::map::_create_random_map	1610	$self->_create_random_map (
1218	$path,
1219	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1611	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1220	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1612	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1221	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1613	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1222	$rmp->{exit_on_final_map},	1614	$rmp->{exit_on_final_map},
1223	$rmp->{xsize}, $rmp->{ysize},	1615	$rmp->{xsize}, $rmp->{ysize},
1224	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1616	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1225	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1617	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1226	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1618	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1227	$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},
1228	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1620	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1229	(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"
1230	}	1750	}
1231		1751
1232	# and all this just because we cannot iterate over	1752	# and all this just because we cannot iterate over
1233	# all maps in C++...	1753	# all maps in C++...
1234	sub change_all_map_light {	1754	sub change_all_map_light {
…		…
1236		1756
1237	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1238	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
1239	}	1759	}
1240		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
1241	sub try_load_header($) {	1777	sub load_header_from($) {
1242	my ($path) = @_;	1778	my ($self, $path) = @_;
1243		1779
1244	utf8::encode $path;	1780	utf8::encode $path;
1245	aio_open $path, O_RDONLY, 0	1781	#aio_open $path, O_RDONLY, 0
		1782	# or return;
		1783
		1784	$self->_load_header ($path)
1246	or return;	1785	or return;
1247		1786
1248	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
1249	or return;	1830	or return;
		1831	$self->prepare_orig;
		1832	}
1250		1833
1251	# for better error messages only, will be overwritten	1834	$self->{deny_reset} = 1
1252	$map->path ($path);	1835	if $self->no_reset;
1253		1836
1254	$map->load_header ($path)	1837	$self->default_region (cf::region::find_by_path $self->{path})
1255	or return;	1838	unless $self->default_region;
1256		1839
1257	$map->{load_path} = $path;	1840	1
1258
1259	$map
1260	}	1841	}
1261		1842
1262	sub find;	1843	sub find;
1263	sub find {	1844	sub find {
1264	my ($path, $origin) = @_;	1845	my ($path, $origin) = @_;
1265		1846
1266	#warn "find<$path,$origin>\n";#d#
1267
1268	$path = new cf::path $path, $origin && $origin->path;	1847	$path = normalise $path, $origin && $origin->path;
1269	my $key = $path->as_string;
1270		1848
1271	cf::lock_wait "map_find:$key";	1849	cf::lock_wait "map_find:$path";
1272		1850
1273	$cf::MAP{$key} || do {	1851	$cf::MAP{$path} || do {
1274	my $guard = cf::lock_acquire "map_find:$key";	1852	my $guard = cf::lock_acquire "map_find:$path";
1275		1853	my $map = new_from_path cf::map $path
1276	# do it the slow way
1277	my $map = try_load_header $path->save_path;
1278
1279	Coro::cede;
1280
1281	if ($map) {
1282	$map->last_access ((delete $map->{last_access})
1283	|| $cf::RUNTIME); #d#
1284	# safety
1285	$map->{instantiate_time} = $cf::RUNTIME
1286	if $map->{instantiate_time} > $cf::RUNTIME;
1287	} else {
1288	if (my $rmp = $path->random_map_params) {
1289	$map = generate_random_map $key, $rmp;
1290	} else {
1291	$map = try_load_header $path->load_path;
1292	}
1293
1294	$map or return;	1854	or return;
1295		1855
1296	$map->{load_original} = 1;
1297	$map->{instantiate_time} = $cf::RUNTIME;
1298	$map->last_access ($cf::RUNTIME);
1299	$map->instantiate;
1300
1301	# per-player maps become, after loading, normal maps
1302	$map->per_player (0) if $path->{user_rel};
1303	}
1304
1305	$map->path ($key);
1306	$map->{path} = $path;
1307	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1308		1857
1309	Coro::cede;	1858	$map->load_header
		1859	or return;
1310		1860
1311	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;
1312	$map->reset;	1864	$map->reset;
1313	undef $guard;	1865	undef $guard;
1314	$map = find $path	1866	return find $path;
1315	or return;
1316	}	1867	}
1317		1868
1318	$cf::MAP{$key} = $map	1869	$cf::MAP{$path} = $map
1319	}	1870	}
1320	}	1871	}
		1872
		1873	sub pre_load { }
		1874	sub post_load { }
1321		1875
1322	sub load {	1876	sub load {
1323	my ($self) = @_;	1877	my ($self) = @_;
1324		1878
		1879	local $self->{deny_reset} = 1; # loading can take a long time
		1880
1325	my $path = $self->{path};	1881	my $path = $self->{path};
		1882
		1883	{
1326	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1884	my $guard = cf::lock_acquire "map_load:$path";
1327		1885
1328	return if $self->in_memory != cf::MAP_SWAPPED;	1886	return if $self->in_memory != cf::MAP_SWAPPED;
1329		1887
1330	$self->in_memory (cf::MAP_LOADING);	1888	$self->in_memory (cf::MAP_LOADING);
1331		1889
1332	$self->alloc;	1890	$self->alloc;
		1891
		1892	$self->pre_load;
		1893	Coro::cede;
		1894
1333	$self->load_objects ($self->{load_path}, 1)	1895	$self->_load_objects ($self->{load_path}, 1)
1334	or return;	1896	or return;
1335		1897
1336	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1898	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1337	if delete $self->{load_original};	1899	if delete $self->{load_original};
1338		1900
1339	if (my $uniq = $path->uniq_path) {	1901	if (my $uniq = $self->uniq_path) {
1340	utf8::encode $uniq;	1902	utf8::encode $uniq;
1341	if (aio_open $uniq, O_RDONLY, 0) {	1903	if (aio_open $uniq, O_RDONLY, 0) {
1342	$self->clear_unique_items;	1904	$self->clear_unique_items;
1343	$self->load_objects ($uniq, 0);	1905	$self->_load_objects ($uniq, 0);
1344	}	1906	}
1345	}	1907	}
1346		1908
1347	Coro::cede;	1909	Coro::cede;
1348
1349	# now do the right thing for maps	1910	# now do the right thing for maps
1350	$self->link_multipart_objects;	1911	$self->link_multipart_objects;
1351
1352	if ($self->{path}->is_style_map) {
1353	$self->{deny_save} = 1;
1354	$self->{deny_reset} = 1;
1355	} else {
1356	$self->fix_auto_apply;
1357	$self->decay_objects;
1358	$self->update_buttons;
1359	$self->set_darkness_map;
1360	$self->difficulty ($self->estimate_difficulty)	1912	$self->difficulty ($self->estimate_difficulty)
1361	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;
1362	$self->activate;	1923	$self->activate;
1363	}	1924	}
1364		1925
1365	Coro::cede;
1366
1367	$self->in_memory (cf::MAP_IN_MEMORY);	1926	$self->in_memory (cf::MAP_IN_MEMORY);
		1927	}
		1928
		1929	$self->post_load;
		1930	}
		1931
		1932	sub customise_for {
		1933	my ($self, $ob) = @_;
		1934
		1935	return find "~" . $ob->name . "/" . $self->{path}
		1936	if $self->per_player;
		1937
		1938	# return find "?party/" . $ob->name . "/" . $self->{path}
		1939	# if $self->per_party;
		1940
		1941	$self
		1942	}
		1943
		1944	# find and load all maps in the 3x3 area around a map
		1945	sub load_diag {
		1946	my ($map) = @_;
		1947
		1948	my @diag; # diagonal neighbours
		1949
		1950	for (0 .. 3) {
		1951	my $neigh = $map->tile_path ($_)
		1952	or next;
		1953	$neigh = find $neigh, $map
		1954	or next;
		1955	$neigh->load;
		1956
		1957	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1958	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1959	}
		1960
		1961	for (@diag) {
		1962	my $neigh = find @$_
		1963	or next;
		1964	$neigh->load;
		1965	}
1368	}	1966	}
1369		1967
1370	sub find_sync {	1968	sub find_sync {
1371	my ($path, $origin) = @_;	1969	my ($path, $origin) = @_;
1372		1970
1373	cf::sync_job { cf::map::find $path, $origin }	1971	cf::sync_job { find $path, $origin }
1374	}	1972	}
1375		1973
1376	sub do_load_sync {	1974	sub do_load_sync {
1377	my ($map) = @_;	1975	my ($map) = @_;
1378		1976
1379	cf::sync_job { $map->load };	1977	cf::sync_job { $map->load };
1380	}	1978	}
1381		1979
		1980	our %MAP_PREFETCH;
		1981	our $MAP_PREFETCHER = undef;
		1982
		1983	sub find_async {
		1984	my ($path, $origin) = @_;
		1985
		1986	$path = normalise $path, $origin && $origin->{path};
		1987
		1988	if (my $map = $cf::MAP{$path}) {
		1989	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1990	}
		1991
		1992	undef $MAP_PREFETCH{$path};
		1993	$MAP_PREFETCHER ||= cf::async {
		1994	while (%MAP_PREFETCH) {
		1995	for my $path (keys %MAP_PREFETCH) {
		1996	if (my $map = find $path) {
		1997	$map->load;
		1998	}
		1999
		2000	delete $MAP_PREFETCH{$path};
		2001	}
		2002	}
		2003	undef $MAP_PREFETCHER;
		2004	};
		2005	$MAP_PREFETCHER->prio (6);
		2006
		2007	()
		2008	}
		2009
1382	sub save {	2010	sub save {
1383	my ($self) = @_;	2011	my ($self) = @_;
1384		2012
1385	my $lock = cf::lock_acquire "map_data:" . $self->path;	2013	my $lock = cf::lock_acquire "map_data:" . $self->path;
1386		2014
1387	$self->{last_save} = $cf::RUNTIME;	2015	$self->{last_save} = $cf::RUNTIME;
1388		2016
1389	return unless $self->dirty;	2017	return unless $self->dirty;
1390		2018
1391	my $save = $self->{path}->save_path; utf8::encode $save;	2019	my $save = $self->save_path; utf8::encode $save;
1392	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2020	my $uniq = $self->uniq_path; utf8::encode $uniq;
1393		2021
1394	$self->{load_path} = $save;	2022	$self->{load_path} = $save;
1395		2023
1396	return if $self->{deny_save};	2024	return if $self->{deny_save};
1397		2025
…		…
1400	cf::async {	2028	cf::async {
1401	$_->contr->save for $self->players;	2029	$_->contr->save for $self->players;
1402	};	2030	};
1403		2031
1404	if ($uniq) {	2032	if ($uniq) {
1405	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2033	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1406	$self->save_objects ($uniq, cf::IO_UNIQUES);	2034	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1407	} else {	2035	} else {
1408	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2036	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1409	}	2037	}
1410	}	2038	}
1411		2039
1412	sub swap_out {	2040	sub swap_out {
1413	my ($self) = @_;	2041	my ($self) = @_;
…		…
1427		2055
1428	sub reset_at {	2056	sub reset_at {
1429	my ($self) = @_;	2057	my ($self) = @_;
1430		2058
1431	# TODO: safety, remove and allow resettable per-player maps	2059	# TODO: safety, remove and allow resettable per-player maps
1432	return 1e99 if $self->{path}{user_rel};
1433	return 1e99 if $self->{deny_reset};	2060	return 1e99 if $self->{deny_reset};
1434		2061
1435	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2062	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1436	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2063	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1437		2064
…		…
1442	my ($self) = @_;	2069	my ($self) = @_;
1443		2070
1444	$self->reset_at <= $cf::RUNTIME	2071	$self->reset_at <= $cf::RUNTIME
1445	}	2072	}
1446		2073
1447	sub unlink_save {
1448	my ($self) = @_;
1449
1450	utf8::encode (my $save = $self->{path}->save_path);
1451	aioreq_pri 3; IO::AIO::aio_unlink $save;
1452	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1453	}
1454
1455	sub rename {
1456	my ($self, $new_path) = @_;
1457
1458	$self->unlink_save;
1459
1460	delete $cf::MAP{$self->path};
1461	$self->{path} = new cf::path $new_path;
1462	$self->path ($self->{path}->as_string);
1463	$cf::MAP{$self->path} = $self;
1464
1465	$self->save;
1466	}
1467
1468	sub reset {	2074	sub reset {
1469	my ($self) = @_;	2075	my ($self) = @_;
1470		2076
1471	my $lock = cf::lock_acquire "map_data:" . $self->path;	2077	my $lock = cf::lock_acquire "map_data:$self->{path}";
1472		2078
1473	return if $self->players;	2079	return if $self->players;
1474	return if $self->{path}{user_rel};#d#
1475		2080
1476	warn "resetting map ", $self->path;#d#	2081	warn "resetting map ", $self->path;
		2082
		2083	$self->in_memory (cf::MAP_SWAPPED);
		2084
		2085	# need to save uniques path
		2086	unless ($self->{deny_save}) {
		2087	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2088
		2089	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2090	if $uniq;
		2091	}
1477		2092
1478	delete $cf::MAP{$self->path};	2093	delete $cf::MAP{$self->path};
		2094
		2095	$self->clear;
1479		2096
1480	$_->clear_links_to ($self) for values %cf::MAP;	2097	$_->clear_links_to ($self) for values %cf::MAP;
1481		2098
1482	$self->unlink_save;	2099	$self->unlink_save;
1483	$self->destroy;	2100	$self->destroy;
…		…
1486	my $nuke_counter = "aaaa";	2103	my $nuke_counter = "aaaa";
1487		2104
1488	sub nuke {	2105	sub nuke {
1489	my ($self) = @_;	2106	my ($self) = @_;
1490		2107
		2108	delete $cf::MAP{$self->path};
		2109
		2110	$self->unlink_save;
		2111
		2112	bless $self, "cf::map";
		2113	delete $self->{deny_reset};
1491	$self->{deny_save} = 1;	2114	$self->{deny_save} = 1;
1492	$self->reset_timeout (1);	2115	$self->reset_timeout (1);
1493	$self->rename ("{nuke}/" . ($nuke_counter++));	2116	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2117
		2118	$cf::MAP{$self->path} = $self;
		2119
1494	$self->reset; # polite request, might not happen	2120	$self->reset; # polite request, might not happen
1495	}	2121	}
1496		2122
1497	sub customise_for {	2123	=item $maps = cf::map::tmp_maps
1498	my ($map, $ob) = @_;
1499		2124
1500	if ($map->per_player) {	2125	Returns an arrayref with all map paths of currently instantiated and saved
1501	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2126	maps. May block.
		2127
		2128	=cut
		2129
		2130	sub tmp_maps() {
1502	}	2131	[
1503		2132	map {
1504	$map	2133	utf8::decode $_;
		2134	/\.map$/
		2135	? normalise $_
		2136	: ()
		2137	} @{ aio_readdir $TMPDIR or [] }
		2138	]
1505	}	2139	}
1506		2140
1507	sub emergency_save {	2141	=item $maps = cf::map::random_maps
1508	my $freeze_guard = cf::freeze_mainloop;
1509		2142
1510	warn "enter emergency perl save\n";	2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	random maps. May block.
1511		2145
1512	cf::sync_job {	2146	=cut
1513	warn "begin emergency player save\n";
1514	$_->save for values %cf::PLAYER;
1515	warn "end emergency player save\n";
1516		2147
1517	warn "begin emergency map save\n";	2148	sub random_maps() {
1518	$_->save for values %cf::MAP;	2149	[
1519	warn "end emergency map save\n";	2150	map {
1520	};	2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise "?random/$_"
		2154	: ()
		2155	} @{ aio_readdir $RANDOMDIR or [] }
		2156	]
		2157	}
1521		2158
1522	warn "leave emergency perl save\n";	2159	=item cf::map::unique_maps
		2160
		2161	Returns an arrayref of paths of all shared maps that have
		2162	instantiated unique items. May block.
		2163
		2164	=cut
		2165
		2166	sub unique_maps() {
		2167	[
		2168	map {
		2169	utf8::decode $_;
		2170	/\.map$/
		2171	? normalise $_
		2172	: ()
		2173	} @{ aio_readdir $UNIQUEDIR or [] }
		2174	]
1523	}	2175	}
1524		2176
1525	package cf;	2177	package cf;
1526		2178
1527	=back	2179	=back
1528		2180
		2181	=head3 cf::object
		2182
		2183	=cut
		2184
		2185	package cf::object;
		2186
		2187	=over 4
		2188
		2189	=item $ob->inv_recursive
		2190
		2191	Returns the inventory of the object _and_ their inventories, recursively.
		2192
		2193	=cut
		2194
		2195	sub inv_recursive_;
		2196	sub inv_recursive_ {
		2197	map { $_, inv_recursive_ $_->inv } @_
		2198	}
		2199
		2200	sub inv_recursive {
		2201	inv_recursive_ inv $_[0]
		2202	}
		2203
		2204	package cf;
		2205
		2206	=back
1529		2207
1530	=head3 cf::object::player	2208	=head3 cf::object::player
1531		2209
1532	=over 4	2210	=over 4
1533		2211
…		…
1547		2225
1548	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2226	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1549		2227
1550	if ($self->{record_replies}) {	2228	if ($self->{record_replies}) {
1551	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2229	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2230
1552	} else {	2231	} else {
		2232	my $pl = $self->contr;
		2233
		2234	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2235	my $dialog = $pl->{npc_dialog};
		2236	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2237
		2238	} else {
1553	$msg = $npc->name . " says: $msg" if $npc;	2239	$msg = $npc->name . " says: $msg" if $npc;
1554	$self->message ($msg, $flags);	2240	$self->message ($msg, $flags);
		2241	}
1555	}	2242	}
1556	}	2243	}
1557		2244
1558	=item $player_object->may ("access")	2245	=item $player_object->may ("access")
1559		2246
…		…
1573		2260
1574	=item $player_object->enter_link	2261	=item $player_object->enter_link
1575		2262
1576	Freezes the player and moves him/her to a special map (C<{link}>).	2263	Freezes the player and moves him/her to a special map (C<{link}>).
1577		2264
1578	The player should be reaosnably safe there for short amounts of time. You	2265	The player should be reasonably safe there for short amounts of time. You
1579	I<MUST> call C<leave_link> as soon as possible, though.	2266	I<MUST> call C<leave_link> as soon as possible, though.
1580		2267
		2268	Will never block.
		2269
1581	=item $player_object->leave_link ($map, $x, $y)	2270	=item $player_object->leave_link ($map, $x, $y)
1582		2271
1583	Moves the player out of the specila link map onto the given map. If the	2272	Moves the player out of the special C<{link}> map onto the specified
1584	map is not valid (or omitted), the player will be moved back to the	2273	map. If the map is not valid (or omitted), the player will be moved back
1585	location he/she was before the call to C<enter_link>, or, if that fails,	2274	to the location he/she was before the call to C<enter_link>, or, if that
1586	to the emergency map position.	2275	fails, to the emergency map position.
1587		2276
1588	Might block.	2277	Might block.
1589		2278
1590	=cut	2279	=cut
		2280
		2281	sub link_map {
		2282	unless ($LINK_MAP) {
		2283	$LINK_MAP = cf::map::find "{link}"
		2284	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2285	$LINK_MAP->load;
		2286	}
		2287
		2288	$LINK_MAP
		2289	}
1591		2290
1592	sub cf::object::player::enter_link {	2291	sub cf::object::player::enter_link {
1593	my ($self) = @_;	2292	my ($self) = @_;
1594		2293
1595	$self->deactivate_recursive;	2294	$self->deactivate_recursive;
1596		2295
1597	return if $self->map == $LINK_MAP;	2296	return if UNIVERSAL::isa $self->map, "ext::map_link";
1598		2297
1599	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2298	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1600	if $self->map;	2299	if $self->map && $self->map->{path} ne "{link}";
1601		2300
1602	$self->enter_map ($LINK_MAP, 20, 20);	2301	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1603	}	2302	}
1604		2303
1605	sub cf::object::player::leave_link {	2304	sub cf::object::player::leave_link {
1606	my ($self, $map, $x, $y) = @_;	2305	my ($self, $map, $x, $y) = @_;
		2306
		2307	return unless $self->contr->active;
1607		2308
1608	my $link_pos = delete $self->{_link_pos};	2309	my $link_pos = delete $self->{_link_pos};
1609		2310
1610	unless ($map) {	2311	unless ($map) {
1611	# restore original map position	2312	# restore original map position
…		…
1625	# use -1 or undef as default coordinates, not 0, 0	2326	# use -1 or undef as default coordinates, not 0, 0
1626	($x, $y) = ($map->enter_x, $map->enter_y)	2327	($x, $y) = ($map->enter_x, $map->enter_y)
1627	if $x <=0 && $y <= 0;	2328	if $x <=0 && $y <= 0;
1628		2329
1629	$map->load;	2330	$map->load;
		2331	$map->load_diag;
1630		2332
1631	return unless $self->contr->active;	2333	return unless $self->contr->active;
1632	$self->activate_recursive;	2334	$self->activate_recursive;
		2335
		2336	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1633	$self->enter_map ($map, $x, $y);	2337	$self->enter_map ($map, $x, $y);
1634	}	2338	}
1635		2339
1636	cf::player->attach (	2340	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1637	on_logout => sub {
1638	my ($pl) = @_;
1639		2341
1640	# abort map switching before logout	2342	Moves the player to the given map-path and coordinates by first freezing
1641	if ($pl->ob->{_link_pos}) {	2343	her, loading and preparing them map, calling the provided $check callback
1642	cf::sync_job {	2344	that has to return the map if sucecssful, and then unfreezes the player on
1643	$pl->ob->leave_link	2345	the new (success) or old (failed) map position. In either case, $done will
1644	};	2346	be called at the end of this process.
1645	}
1646	},
1647	on_login => sub {
1648	my ($pl) = @_;
1649		2347
1650	# try to abort aborted map switching on player login :)
1651	# should happen only on crashes
1652	if ($pl->ob->{_link_pos}) {
1653	$pl->ob->enter_link;
1654	(async {
1655	# we need this sleep as the login has a concurrent enter_exit running
1656	# and this sleep increases chances of the player not ending up in scorn
1657	$pl->ob->reply (undef,
1658	"There was an internal problem at your last logout, "
1659	. "the server will try to bring you to your intended destination in a second.",
1660	cf::NDI_RED);
1661	Coro::Timer::sleep 1;
1662	$pl->ob->leave_link;
1663	})->prio (2);
1664	}
1665	},
1666	);
1667
1668	=item $player_object->goto ($path, $x, $y)
1669
1670	=cut	2348	=cut
		2349
		2350	our $GOTOGEN;
1671		2351
1672	sub cf::object::player::goto {	2352	sub cf::object::player::goto {
1673	my ($self, $path, $x, $y) = @_;	2353	my ($self, $path, $x, $y, $check, $done) = @_;
		2354
		2355	# do generation counting so two concurrent goto's will be executed in-order
		2356	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1674		2357
1675	$self->enter_link;	2358	$self->enter_link;
1676		2359
1677	(async {	2360	(async {
1678	$path = new cf::path $path;	2361	my $map = eval {
1679
1680	my $map = cf::map::find $path->as_string;	2362	my $map = cf::map::find $path;
		2363
		2364	if ($map) {
1681	$map = $map->customise_for ($self) if $map;	2365	$map = $map->customise_for ($self);
1682		2366	$map = $check->($map) if $check && $map;
1683	# warn "entering ", $map->path, " at ($x, $y)\n"	2367	} else {
1684	# if $map;
1685
1686	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2368	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	}
1687		2370
		2371	$map
		2372	};
		2373
		2374	if ($@) {
		2375	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2376	LOG llevError | logBacktrace, Carp::longmess $@;
		2377	}
		2378
		2379	if ($gen == $self->{_goto_generation}) {
		2380	delete $self->{_goto_generation};
1688	$self->leave_link ($map, $x, $y);	2381	$self->leave_link ($map, $x, $y);
		2382	}
		2383
		2384	$done->() if $done;
1689	})->prio (1);	2385	})->prio (1);
1690	}	2386	}
1691		2387
1692	=item $player_object->enter_exit ($exit_object)	2388	=item $player_object->enter_exit ($exit_object)
1693		2389
…		…
1695		2391
1696	sub parse_random_map_params {	2392	sub parse_random_map_params {
1697	my ($spec) = @_;	2393	my ($spec) = @_;
1698		2394
1699	my $rmp = { # defaults	2395	my $rmp = { # defaults
1700	xsize => 10,	2396	xsize => (cf::rndm 15, 40),
1701	ysize => 10,	2397	ysize => (cf::rndm 15, 40),
		2398	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2399	#layout => string,
1702	};	2400	};
1703		2401
1704	for (split /\n/, $spec) {	2402	for (split /\n/, $spec) {
1705	my ($k, $v) = split /\s+/, $_, 2;	2403	my ($k, $v) = split /\s+/, $_, 2;
1706		2404
…		…
1710	$rmp	2408	$rmp
1711	}	2409	}
1712		2410
1713	sub prepare_random_map {	2411	sub prepare_random_map {
1714	my ($exit) = @_;	2412	my ($exit) = @_;
		2413
		2414	my $guard = cf::lock_acquire "exit_prepare:$exit";
1715		2415
1716	# all this does is basically replace the /! path by	2416	# all this does is basically replace the /! path by
1717	# a new random map path (?random/...) with a seed	2417	# a new random map path (?random/...) with a seed
1718	# that depends on the exit object	2418	# that depends on the exit object
1719		2419
1720	my $rmp = parse_random_map_params $exit->msg;	2420	my $rmp = parse_random_map_params $exit->msg;
1721		2421
1722	if ($exit->map) {	2422	if ($exit->map) {
1723	$rmp->{region} = $exit->map->region_name;	2423	$rmp->{region} = $exit->region->name;
1724	$rmp->{origin_map} = $exit->map->path;	2424	$rmp->{origin_map} = $exit->map->path;
1725	$rmp->{origin_x} = $exit->x;	2425	$rmp->{origin_x} = $exit->x;
1726	$rmp->{origin_y} = $exit->y;	2426	$rmp->{origin_y} = $exit->y;
1727	}	2427	}
1728		2428
1729	$rmp->{random_seed} ||= $exit->random_seed;	2429	$rmp->{random_seed} ||= $exit->random_seed;
1730		2430
1731	my $data = cf::to_json $rmp;	2431	my $data = cf::to_json $rmp;
1732	my $md5 = Digest::MD5::md5_hex $data;	2432	my $md5 = Digest::MD5::md5_hex $data;
		2433	my $meta = "$RANDOMDIR/$md5.meta";
1733		2434
1734	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2435	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1735	aio_write $fh, 0, (length $data), $data, 0;	2436	aio_write $fh, 0, (length $data), $data, 0;
		2437	undef $fh;
		2438	aio_rename "$meta~", $meta;
1736		2439
1737	$exit->slaying ("?random/$md5");	2440	$exit->slaying ("?random/$md5");
1738	$exit->msg (undef);	2441	$exit->msg (undef);
1739	}	2442	}
1740	}	2443	}
…		…
1742	sub cf::object::player::enter_exit {	2445	sub cf::object::player::enter_exit {
1743	my ($self, $exit) = @_;	2446	my ($self, $exit) = @_;
1744		2447
1745	return unless $self->type == cf::PLAYER;	2448	return unless $self->type == cf::PLAYER;
1746		2449
		2450	if ($exit->slaying eq "/!") {
		2451	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2452	# the problem is that $exit might not survive long enough
		2453	# so it needs to be done right now, right here
		2454	cf::sync_job { prepare_random_map $exit };
		2455	}
		2456
		2457	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2458	my $hp = $exit->stats->hp;
		2459	my $sp = $exit->stats->sp;
		2460
1747	$self->enter_link;	2461	$self->enter_link;
		2462
		2463	# if exit is damned, update players death & WoR home-position
		2464	$self->contr->savebed ($slaying, $hp, $sp)
		2465	if $exit->flag (FLAG_DAMNED);
1748		2466
1749	(async {	2467	(async {
1750	$self->deactivate_recursive; # just to be sure	2468	$self->deactivate_recursive; # just to be sure
1751	unless (eval {	2469	unless (eval {
1752	prepare_random_map $exit	2470	$self->goto ($slaying, $hp, $sp);
1753	if $exit->slaying eq "/!";
1754
1755	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1756	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1757		2471
1758	1;	2472	1;
1759	}) {	2473	}) {
1760	$self->message ("Something went wrong deep within the crossfire server. "	2474	$self->message ("Something went wrong deep within the crossfire server. "
1761	. "I'll try to bring you back to the map you were before. "	2475	. "I'll try to bring you back to the map you were before. "
1762	. "Please report this to the dungeon master",	2476	. "Please report this to the dungeon master!",
1763	cf::NDI_UNIQUE | cf::NDI_RED);	2477	cf::NDI_UNIQUE | cf::NDI_RED);
1764		2478
1765	warn "ERROR in enter_exit: $@";	2479	warn "ERROR in enter_exit: $@";
1766	$self->leave_link;	2480	$self->leave_link;
1767	}	2481	}
1768	})->prio (1);	2482	})->prio (1);
…		…
1781		2495
1782	sub cf::client::send_drawinfo {	2496	sub cf::client::send_drawinfo {
1783	my ($self, $text, $flags) = @_;	2497	my ($self, $text, $flags) = @_;
1784		2498
1785	utf8::encode $text;	2499	utf8::encode $text;
1786	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2500	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1787	}	2501	}
1788		2502
		2503	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2504
		2505	Send a drawinfo or msg packet to the client, formatting the msg for the
		2506	client if neccessary. C<$type> should be a string identifying the type of
		2507	the message, with C<log> being the default. If C<$color> is negative, suppress
		2508	the message unless the client supports the msg packet.
		2509
		2510	=cut
		2511
		2512	sub cf::client::send_msg {
		2513	my ($self, $channel, $msg, $color, @extra) = @_;
		2514
		2515	$msg = $self->pl->expand_cfpod ($msg);
		2516
		2517	$color &= ~cf::NDI_UNIQUE; # just in case...
		2518
		2519	if (ref $channel) {
		2520	# send meta info to client, if not yet sent
		2521	unless (exists $self->{channel}{$channel->{id}}) {
		2522	$self->{channel}{$channel->{id}} = $channel;
		2523	$self->ext_msg (channel_info => %$channel);
		2524	}
		2525
		2526	$channel = $channel->{id};
		2527	}
		2528
		2529	return unless @extra || length $msg;
		2530
		2531	if ($self->can_msg) {
		2532	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2533	} else {
		2534	# replace some tags by gcfclient-compatible ones
		2535	for ($msg) {
		2536	1 while
		2537	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2538	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2539	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2540	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2541	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2542	}
		2543
		2544	if ($color >= 0) {
		2545	if (0 && $msg =~ /\[/) {
		2546	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
		2555	=item $client->ext_msg ($type, @msg)
		2556
		2557	Sends an ext event to the client.
		2558
		2559	=cut
		2560
		2561	sub cf::client::ext_msg($$@) {
		2562	my ($self, $type, @msg) = @_;
		2563
		2564	my $extcmd = $self->extcmd;
		2565
		2566	if ($extcmd == 2) {
		2567	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2568	} elsif ($extcmd == 1) { # TODO: remove
		2569	push @msg, msgtype => "event_$type";
		2570	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2571	}
		2572	}
1789		2573
1790	=item $success = $client->query ($flags, "text", \&cb)	2574	=item $success = $client->query ($flags, "text", \&cb)
1791		2575
1792	Queues a query to the client, calling the given callback with	2576	Queues a query to the client, calling the given callback with
1793	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1794	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2578	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1795		2579
1796	Queries can fail, so check the return code. Or don't, as queries will become	2580	Queries can fail, so check the return code. Or don't, as queries will
1797	reliable at some point in the future.	2581	become reliable at some point in the future.
1798		2582
1799	=cut	2583	=cut
1800		2584
1801	sub cf::client::query {	2585	sub cf::client::query {
1802	my ($self, $flags, $text, $cb) = @_;	2586	my ($self, $flags, $text, $cb) = @_;
…		…
1810	utf8::encode $text;	2594	utf8::encode $text;
1811	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1812		2596
1813	$self->send_packet ($self->{query_queue}[0][0])	2597	$self->send_packet ($self->{query_queue}[0][0])
1814	if @{ $self->{query_queue} } == 1;	2598	if @{ $self->{query_queue} } == 1;
		2599
		2600	1
1815	}	2601	}
1816		2602
1817	cf::client->attach (	2603	cf::client->attach (
		2604	on_connect => sub {
		2605	my ($ns) = @_;
		2606
		2607	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2608	},
1818	on_reply => sub {	2609	on_reply => sub {
1819	my ($ns, $msg) = @_;	2610	my ($ns, $msg) = @_;
1820		2611
1821	# this weird shuffling is so that direct followup queries	2612	# this weird shuffling is so that direct followup queries
1822	# get handled first	2613	# get handled first
1823	my $queue = delete $ns->{query_queue}	2614	my $queue = delete $ns->{query_queue}
1824	or return; # be conservative, not sure how that can happen, but we saw a crash here	2615	or return; # be conservative, not sure how that can happen, but we saw a crash here
1825		2616
1826	(shift @$queue)->[1]->($msg);	2617	(shift @$queue)->[1]->($msg);
		2618	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1827		2619
1828	push @{ $ns->{query_queue} }, @$queue;	2620	push @{ $ns->{query_queue} }, @$queue;
1829		2621
1830	if (@{ $ns->{query_queue} } == @$queue) {	2622	if (@{ $ns->{query_queue} } == @$queue) {
1831	if (@$queue) {	2623	if (@$queue) {
…		…
1833	} else {	2625	} else {
1834	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2626	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1835	}	2627	}
1836	}	2628	}
1837	},	2629	},
		2630	on_exticmd => sub {
		2631	my ($ns, $buf) = @_;
		2632
		2633	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2634
		2635	if (ref $msg) {
		2636	my ($type, $reply, @payload) =
		2637	"ARRAY" eq ref $msg
		2638	? @$msg
		2639	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2640
		2641	if (my $cb = $EXTICMD{$type}) {
		2642	my @reply = $cb->($ns, @payload);
		2643
		2644	$ns->ext_reply ($reply, @reply)
		2645	if $reply;
		2646	}
		2647	} else {
		2648	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2649	}
		2650
		2651	cf::override;
		2652	},
1838	);	2653	);
1839		2654
1840	=item $client->async (\&cb)	2655	=item $client->async (\&cb)
1841		2656
1842	Create a new coroutine, running the specified callback. The coroutine will	2657	Create a new coroutine, running the specified callback. The coroutine will
…		…
1889		2704
1890	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
1891		2706
1892	=pod	2707	=pod
1893		2708
1894	The following fucntions and emthods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
1895		2710
1896	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove
		2714
1897	cf::object::player player	2715	cf::object::player
1898	cf::player peaceful	2716	player
1899	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
1900		2723
1901	=cut	2724	=cut
1902		2725
1903	for (	2726	for (
1904	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove)],
1905	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
1906	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
1907	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
1908	) {	2732	) {
1909	no strict 'refs';	2733	no strict 'refs';
…		…
1980	=back	2804	=back
1981		2805
1982	=cut	2806	=cut
1983		2807
1984	#############################################################################	2808	#############################################################################
		2809	# the server's init and main functions
1985		2810
1986	=head2 EXTENSION DATABASE SUPPORT	2811	sub load_facedata($) {
		2812	my ($path) = @_;
1987		2813
1988	Crossfire maintains a very simple database for extension use. It can	2814	warn "loading facedata from $path\n";
1989	currently store anything that can be serialised using Storable, which
1990	excludes objects.
1991		2815
1992	The parameter C<$family> should best start with the name of the extension	2816	my $facedata;
1993	using it, it should be unique.	2817	0 < aio_load $path, $facedata
		2818	or die "$path: $!";
1994		2819
1995	=over 4	2820	$facedata = Coro::Storable::thaw $facedata;
1996		2821
1997	=item $hashref = cf::db_get $family	2822	$facedata->{version} == 2
		2823	or cf::cleanup "$path: version mismatch, cannot proceed.";
1998		2824
1999	Return a hashref for use by the extension C<$family>, which can be
2000	modified. After modifications, you have to call C<cf::db_dirty> or
2001	C<cf::db_sync>.
2002
2003	=item $value = cf::db_get $family => $key
2004
2005	Returns a single value from the database
2006
2007	=item cf::db_put $family => $hashref
2008
2009	Stores the given family hashref into the database. Updates are delayed, if
2010	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2011
2012	=item cf::db_put $family => $key => $value
2013
2014	Stores the given C<$value> in the family hash. Updates are delayed, if you
2015	want the data to be synced to disk immediately, use C<cf::db_sync>.
2016
2017	=item cf::db_dirty
2018
2019	Marks the database as dirty, to be updated at a later time.
2020
2021	=item cf::db_sync
2022
2023	Immediately write the database to disk I<if it is dirty>.
2024
2025	=cut
2026
2027	our $DB;
2028
2029	{
2030	my $path = cf::localdir . "/database.pst";
2031
2032	sub db_load() {
2033	$DB = stat $path ? Storable::retrieve $path : { };
2034	}	2825	{
		2826	my $faces = $facedata->{faceinfo};
2035		2827
2036	my $pid;	2828	while (my ($face, $info) = each %$faces) {
		2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
		2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2037		2834
2038	sub db_save() {	2835	cf::cede_to_tick;
2039	waitpid $pid, 0 if $pid;
2040	if (0 == ($pid = fork)) {
2041	$DB->{_meta}{version} = 1;
2042	Storable::nstore $DB, "$path~";
2043	rename "$path~", $path;
2044	cf::_exit 0 if defined $pid;
2045	}
2046	}
2047
2048	my $dirty;
2049
2050	sub db_sync() {
2051	db_save if $dirty;
2052	undef $dirty;
2053	}
2054
2055	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2056	db_sync;
2057	});
2058
2059	sub db_dirty() {
2060	$dirty = 1;
2061	$idle->start;
2062	}
2063
2064	sub db_get($;$) {
2065	@_ >= 2
2066	? $DB->{$_[0]}{$_[1]}
2067	: ($DB->{$_[0]} ||= { })
2068	}
2069
2070	sub db_put($$;$) {
2071	if (@_ >= 3) {
2072	$DB->{$_[0]}{$_[1]} = $_[2];
2073	} else {
2074	$DB->{$_[0]} = $_[1];
2075	}
2076	db_dirty;
2077	}
2078
2079	cf::global->attach (
2080	prio => 10000,
2081	on_cleanup => sub {
2082	db_sync;
2083	},	2836	}
2084	);
2085	}
2086		2837
2087	#############################################################################	2838	while (my ($face, $info) = each %$faces) {
2088	# the server's main()	2839	next unless $info->{smooth};
		2840	my $idx = cf::face::find $face
		2841	or next;
		2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
		2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2845	} else {
		2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2847	}
		2848
		2849	cf::cede_to_tick;
		2850	}
		2851	}
		2852
		2853	{
		2854	my $anims = $facedata->{animinfo};
		2855
		2856	while (my ($anim, $info) = each %$anims) {
		2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2858	cf::cede_to_tick;
		2859	}
		2860
		2861	cf::anim::invalidate_all; # d'oh
		2862	}
		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	while (my ($name, $info) = each %$res) {
		2871	my $meta = $enc->encode ({
		2872	name => $name,
		2873	copyright => $info->{copyright}, #TODO#
		2874	});
		2875
		2876	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2877
		2878	if ($info->{type} & 1) {
		2879	# prepend meta info
		2880
		2881	my $data = pack "(w/a*)*", $meta, $info->{data};
		2882	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2883
		2884	cf::face::set_data $idx, 0, $data, $chk;
		2885	} else {
		2886	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2887	}
		2888
		2889	cf::face::set_type $idx, $info->{type};
		2890
		2891	cf::cede_to_tick;
		2892	}
		2893	}
		2894
		2895	1
		2896	}
		2897
		2898	register_exticmd fx_want => sub {
		2899	my ($ns, $want) = @_;
		2900
		2901	while (my ($k, $v) = each %$want) {
		2902	$ns->fx_want ($k, $v);
		2903	}
		2904	};
		2905
		2906	sub reload_regions {
		2907	load_resource_file "$MAPDIR/regions"
		2908	or die "unable to load regions file\n";
		2909
		2910	for (cf::region::list) {
		2911	$_->{match} = qr/$_->{match}/
		2912	if exists $_->{match};
		2913	}
		2914	}
		2915
		2916	sub reload_facedata {
		2917	load_facedata "$DATADIR/facedata"
		2918	or die "unable to load facedata\n";
		2919	}
		2920
		2921	sub reload_archetypes {
		2922	load_resource_file "$DATADIR/archetypes"
		2923	or die "unable to load archetypes\n";
		2924	#d# NEED to laod twice to resolve forward references
		2925	# this really needs to be done in an extra post-pass
		2926	# (which needs to be synchronous, so solve it differently)
		2927	load_resource_file "$DATADIR/archetypes"
		2928	or die "unable to load archetypes\n";
		2929	}
		2930
		2931	sub reload_treasures {
		2932	load_resource_file "$DATADIR/treasures"
		2933	or die "unable to load treasurelists\n";
		2934	}
		2935
		2936	sub reload_resources {
		2937	warn "reloading resource files...\n";
		2938
		2939	reload_regions;
		2940	reload_facedata;
		2941	#reload_archetypes;#d#
		2942	reload_archetypes;
		2943	reload_treasures;
		2944
		2945	warn "finished reloading resource files\n";
		2946	}
		2947
		2948	sub init {
		2949	reload_resources;
		2950	}
2089		2951
2090	sub cfg_load {	2952	sub cfg_load {
2091	open my $fh, "<:utf8", cf::confdir . "/config"	2953	open my $fh, "<:utf8", "$CONFDIR/config"
2092	or return;	2954	or return;
2093		2955
2094	local $/;	2956	local $/;
2095	*CFG = YAML::Syck::Load <$fh>;	2957	*CFG = YAML::Syck::Load <$fh>;
2096		2958
…		…
2099	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	2961	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2100	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	2962	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2101		2963
2102	if (exists $CFG{mlockall}) {	2964	if (exists $CFG{mlockall}) {
2103	eval {	2965	eval {
2104	$CFG{mlockall} ? &mlockall : &munlockall	2966	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2105	and die "WARNING: m(un)lockall failed: $!\n";	2967	and die "WARNING: m(un)lockall failed: $!\n";
2106	};	2968	};
2107	warn $@ if $@;	2969	warn $@ if $@;
2108	}	2970	}
2109	}	2971	}
2110		2972
2111	sub main {	2973	sub main {
2112	# we must not ever block the main coroutine	2974	# we must not ever block the main coroutine
2113	local $Coro::idle = sub {	2975	local $Coro::idle = sub {
2114	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2976	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2977	(async {
2115	async { Event::one_event };	2978	Event::one_event;
		2979	})->prio (Coro::PRIO_MAX);
2116	};	2980	};
2117		2981
2118	cfg_load;	2982	cfg_load;
2119	db_load;	2983	db_init;
2120	load_extensions;	2984	load_extensions;
		2985
		2986	$TICK_WATCHER->start;
2121	Event::loop;	2987	Event::loop;
2122	}	2988	}
2123		2989
2124	#############################################################################	2990	#############################################################################
2125	# initialisation	2991	# initialisation and cleanup
2126		2992
		2993	# install some emergency cleanup handlers
		2994	BEGIN {
		2995	for my $signal (qw(INT HUP TERM)) {
		2996	Event->signal (
		2997	reentrant => 0,
		2998	data => WF_AUTOCANCEL,
		2999	signal => $signal,
		3000	prio => 0,
		3001	cb => sub {
		3002	cf::cleanup "SIG$signal";
		3003	},
		3004	);
		3005	}
		3006	}
		3007
		3008	sub write_runtime {
		3009	my $runtime = "$LOCALDIR/runtime";
		3010
		3011	# first touch the runtime file to show we are still running:
		3012	# the fsync below can take a very very long time.
		3013
		3014	IO::AIO::aio_utime $runtime, undef, undef;
		3015
		3016	my $guard = cf::lock_acquire "write_runtime";
		3017
		3018	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3019	or return;
		3020
		3021	my $value = $cf::RUNTIME + 90 + 10;
		3022	# 10 is the runtime save interval, for a monotonic clock
		3023	# 60 allows for the watchdog to kill the server.
		3024
		3025	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3026	and return;
		3027
		3028	# always fsync - this file is important
		3029	aio_fsync $fh
		3030	and return;
		3031
		3032	# touch it again to show we are up-to-date
		3033	aio_utime $fh, undef, undef;
		3034
		3035	close $fh
		3036	or return;
		3037
		3038	aio_rename "$runtime~", $runtime
		3039	and return;
		3040
		3041	warn "runtime file written.\n";
		3042
		3043	1
		3044	}
		3045
		3046	sub emergency_save() {
		3047	my $freeze_guard = cf::freeze_mainloop;
		3048
		3049	warn "enter emergency perl save\n";
		3050
		3051	cf::sync_job {
		3052	# use a peculiar iteration method to avoid tripping on perl
		3053	# refcount bugs in for. also avoids problems with players
		3054	# and maps saved/destroyed asynchronously.
		3055	warn "begin emergency player save\n";
		3056	for my $login (keys %cf::PLAYER) {
		3057	my $pl = $cf::PLAYER{$login} or next;
		3058	$pl->valid or next;
		3059	$pl->save;
		3060	}
		3061	warn "end emergency player save\n";
		3062
		3063	warn "begin emergency map save\n";
		3064	for my $path (keys %cf::MAP) {
		3065	my $map = $cf::MAP{$path} or next;
		3066	$map->valid or next;
		3067	$map->save;
		3068	}
		3069	warn "end emergency map save\n";
		3070
		3071	warn "begin emergency database checkpoint\n";
		3072	BDB::db_env_txn_checkpoint $DB_ENV;
		3073	warn "end emergency database checkpoint\n";
		3074	};
		3075
		3076	warn "leave emergency perl save\n";
		3077	}
		3078
		3079	sub post_cleanup {
		3080	my ($make_core) = @_;
		3081
		3082	warn Carp::longmess "post_cleanup backtrace"
		3083	if $make_core;
		3084	}
		3085
2127	sub reload() {	3086	sub do_reload_perl() {
2128	# can/must only be called in main	3087	# can/must only be called in main
2129	if ($Coro::current != $Coro::main) {	3088	if ($Coro::current != $Coro::main) {
2130	warn "can only reload from main coroutine\n";	3089	warn "can only reload from main coroutine";
2131	return;	3090	return;
2132	}	3091	}
2133		3092
2134	warn "reloading...";	3093	warn "reloading...";
2135		3094
2136	my $guard = freeze_mainloop;	3095	warn "entering sync_job";
		3096
		3097	cf::sync_job {
		3098	cf::write_runtime; # external watchdog should not bark
2137	cf::emergency_save;	3099	cf::emergency_save;
		3100	cf::write_runtime; # external watchdog should not bark
2138		3101
2139	eval {	3102	warn "syncing database to disk";
		3103	BDB::db_env_txn_checkpoint $DB_ENV;
		3104
2140	# if anything goes wrong in here, we should simply crash as we already saved	3105	# if anything goes wrong in here, we should simply crash as we already saved
2141		3106
2142	# cancel all watchers	3107	warn "cancelling all WF_AUTOCANCEL watchers";
2143	for (Event::all_watchers) {	3108	for (Event::all_watchers) {
2144	$_->cancel if $_->data & WF_AUTOCANCEL;	3109	$_->cancel if $_->data & WF_AUTOCANCEL;
2145	}	3110	}
2146		3111
		3112	warn "flushing outstanding aio requests";
		3113	for (;;) {
		3114	BDB::flush;
		3115	IO::AIO::flush;
		3116	Coro::cede;
		3117	last unless IO::AIO::nreqs || BDB::nreqs;
		3118	warn "iterate...";
		3119	}
		3120
		3121	++$RELOAD;
		3122
2147	# cancel all extension coros	3123	warn "cancelling all extension coros";
2148	$_->cancel for values %EXT_CORO;	3124	$_->cancel for values %EXT_CORO;
2149	%EXT_CORO = ();	3125	%EXT_CORO = ();
2150		3126
2151	# unload all extensions	3127	warn "removing commands";
2152	for (@exts) {	3128	%COMMAND = ();
		3129
		3130	warn "removing ext/exti commands";
		3131	%EXTCMD = ();
		3132	%EXTICMD = ();
		3133
		3134	warn "unloading/nuking all extensions";
		3135	for my $pkg (@EXTS) {
2153	warn "unloading <$_>";	3136	warn "... unloading $pkg";
2154	unload_extension $_;	3137
		3138	if (my $cb = $pkg->can ("unload")) {
		3139	eval {
		3140	$cb->($pkg);
		3141	1
		3142	} or warn "$pkg unloaded, but with errors: $@";
2155	}	3143	}
2156		3144
		3145	warn "... nuking $pkg";
		3146	Symbol::delete_package $pkg;
		3147	}
		3148
2157	# unload all modules loaded from $LIBDIR	3149	warn "unloading all perl modules loaded from $LIBDIR";
2158	while (my ($k, $v) = each %INC) {	3150	while (my ($k, $v) = each %INC) {
2159	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3151	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2160		3152
2161	warn "removing <$k>";	3153	warn "... unloading $k";
2162	delete $INC{$k};	3154	delete $INC{$k};
2163		3155
2164	$k =~ s/\.pm$//;	3156	$k =~ s/\.pm$//;
2165	$k =~ s/\//::/g;	3157	$k =~ s/\//::/g;
2166		3158
…		…
2169	}	3161	}
2170		3162
2171	Symbol::delete_package $k;	3163	Symbol::delete_package $k;
2172	}	3164	}
2173		3165
2174	# sync database to disk
2175	cf::db_sync;
2176	IO::AIO::flush;
2177
2178	# get rid of safe::, as good as possible	3166	warn "getting rid of safe::, as good as possible";
2179	Symbol::delete_package "safe::$_"	3167	Symbol::delete_package "safe::$_"
2180	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3168	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2181		3169
2182	# remove register_script_function callbacks
2183	# TODO
2184
2185	# unload cf.pm "a bit"	3170	warn "unloading cf.pm \"a bit\"";
2186	delete $INC{"cf.pm"};	3171	delete $INC{"cf.pm"};
		3172	delete $INC{"cf/pod.pm"};
2187		3173
2188	# don't, removes xs symbols, too,	3174	# don't, removes xs symbols, too,
2189	# and global variables created in xs	3175	# and global variables created in xs
2190	#Symbol::delete_package __PACKAGE__;	3176	#Symbol::delete_package __PACKAGE__;
2191		3177
2192	# reload cf.pm	3178	warn "unload completed, starting to reload now";
		3179
2193	warn "reloading cf.pm";	3180	warn "reloading cf.pm";
2194	require cf;	3181	require cf;
2195	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3182	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2196		3183
2197	# load config and database again	3184	warn "loading config and database again";
2198	cf::cfg_load;	3185	cf::cfg_load;
2199	cf::db_load;
2200		3186
2201	# load extensions
2202	warn "load extensions";	3187	warn "loading extensions";
2203	cf::load_extensions;	3188	cf::load_extensions;
2204		3189
2205	# reattach attachments to objects	3190	warn "reattaching attachments to objects/players";
2206	warn "reattach";	3191	_global_reattach; # objects, sockets
2207	_global_reattach;	3192	warn "reattaching attachments to maps";
2208	reattach $_ for values %MAP;	3193	reattach $_ for values %MAP;
2209	};	3194	warn "reattaching attachments to players";
		3195	reattach $_ for values %PLAYER;
2210		3196
2211	if ($@) {	3197	warn "leaving sync_job";
		3198
		3199	1
		3200	} or do {
2212	warn $@;	3201	warn $@;
2213	warn "error while reloading, exiting.";	3202	warn "error while reloading, exiting.";
2214	exit 1;	3203	exit 1;
2215	}	3204	};
2216		3205
2217	warn "reloaded successfully";	3206	warn "reloaded";
2218	};	3207	};
2219		3208
2220	#############################################################################	3209	our $RELOAD_WATCHER; # used only during reload
2221		3210
2222	unless ($LINK_MAP) {	3211	sub reload_perl() {
2223	$LINK_MAP = cf::map::new;	3212	# doing reload synchronously and two reloads happen back-to-back,
		3213	# coro crashes during coro_state_free->destroy here.
2224		3214
2225	$LINK_MAP->width (41);	3215	$RELOAD_WATCHER ||= Event->timer (
2226	$LINK_MAP->height (41);	3216	reentrant => 0,
2227	$LINK_MAP->alloc;
2228	$LINK_MAP->path ("{link}");
2229	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2230	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2231
2232	# dirty hack because... archetypes are not yet loaded
2233	Event->timer (
2234	after => 10,	3217	after => 0,
		3218	data => WF_AUTOCANCEL,
2235	cb => sub {	3219	cb => sub {
2236	$_[0]->w->cancel;	3220	do_reload_perl;
2237		3221	undef $RELOAD_WATCHER;
2238	# provide some exits "home"
2239	my $exit = cf::object::new "exit";
2240
2241	$exit->slaying ($EMERGENCY_POSITION->[0]);
2242	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2243	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2244
2245	$LINK_MAP->insert ($exit->clone, 19, 19);
2246	$LINK_MAP->insert ($exit->clone, 19, 20);
2247	$LINK_MAP->insert ($exit->clone, 19, 21);
2248	$LINK_MAP->insert ($exit->clone, 20, 19);
2249	$LINK_MAP->insert ($exit->clone, 20, 21);
2250	$LINK_MAP->insert ($exit->clone, 21, 19);
2251	$LINK_MAP->insert ($exit->clone, 21, 20);
2252	$LINK_MAP->insert ($exit->clone, 21, 21);
2253
2254	$exit->destroy;
2255	});	3222	},
2256		3223	);
2257	$LINK_MAP->{deny_save} = 1;
2258	$LINK_MAP->{deny_reset} = 1;
2259
2260	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2261	}	3224	}
2262
2263	register "<global>", __PACKAGE__;
2264		3225
2265	register_command "reload" => sub {	3226	register_command "reload" => sub {
2266	my ($who, $arg) = @_;	3227	my ($who, $arg) = @_;
2267		3228
2268	if ($who->flag (FLAG_WIZ)) {	3229	if ($who->flag (FLAG_WIZ)) {
2269	$who->message ("start of reload.");
2270	reload;
2271	$who->message ("end of reload.");	3230	$who->message ("reloading server.");
		3231	async { reload_perl };
2272	}	3232	}
2273	};	3233	};
2274		3234
2275	unshift @INC, $LIBDIR;	3235	unshift @INC, $LIBDIR;
2276		3236
		3237	my $bug_warning = 0;
		3238
		3239	our @WAIT_FOR_TICK;
		3240	our @WAIT_FOR_TICK_BEGIN;
		3241
		3242	sub wait_for_tick {
		3243	return unless $TICK_WATCHER->is_active;
		3244	return if $Coro::current == $Coro::main;
		3245
		3246	my $signal = new Coro::Signal;
		3247	push @WAIT_FOR_TICK, $signal;
		3248	$signal->wait;
		3249	}
		3250
		3251	sub wait_for_tick_begin {
		3252	return unless $TICK_WATCHER->is_active;
		3253	return if $Coro::current == $Coro::main;
		3254
		3255	my $signal = new Coro::Signal;
		3256	push @WAIT_FOR_TICK_BEGIN, $signal;
		3257	$signal->wait;
		3258	}
		3259
		3260	my $min = 1e6;#d#
		3261	my $avg = 10;
2277	$TICK_WATCHER = Event->timer (	3262	$TICK_WATCHER = Event->timer (
2278	reentrant => 0,	3263	reentrant => 0,
		3264	parked => 1,
2279	prio => 0,	3265	prio => 0,
2280	at => $NEXT_TICK || $TICK,	3266	at => $NEXT_TICK || $TICK,
2281	data => WF_AUTOCANCEL,	3267	data => WF_AUTOCANCEL,
2282	cb => sub {	3268	cb => sub {
		3269	if ($Coro::current != $Coro::main) {
		3270	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3271	unless ++$bug_warning > 10;
		3272	return;
		3273	}
		3274
		3275	$NOW = $tick_start = Event::time;
		3276
2283	cf::server_tick; # one server iteration	3277	cf::server_tick; # one server iteration
		3278
		3279	0 && sync_job {#d#
		3280	for(1..10) {
		3281	my $t = Event::time;
		3282	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3283	or die;
		3284
		3285	$map->width (50);
		3286	$map->height (50);
		3287	$map->alloc;
		3288	$map->_load_objects ("/tmp/x.map", 1);
		3289	my $t = Event::time - $t;
		3290
		3291	#next unless $t < 0.0013;#d#
		3292	if ($t < $min) {
		3293	$min = $t;
		3294	}
		3295	$avg = $avg * 0.99 + $t * 0.01;
		3296	}
		3297	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3298	exit 0;
		3299	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3300	};
		3301
2284	$RUNTIME += $TICK;	3302	$RUNTIME += $TICK;
2285	$NEXT_TICK += $TICK;	3303	$NEXT_TICK += $TICK;
2286		3304
		3305	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3306	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3307	Coro::async_pool {
		3308	write_runtime
		3309	or warn "ERROR: unable to write runtime file: $!";
		3310	};
		3311	}
		3312
		3313	# my $AFTER = Event::time;
		3314	# warn $AFTER - $NOW;#d#
		3315
		3316	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3317	$sig->send;
		3318	}
		3319	while (my $sig = shift @WAIT_FOR_TICK) {
		3320	$sig->send;
		3321	}
		3322
		3323	$NOW = Event::time;
		3324
2287	# if we are delayed by four ticks or more, skip them all	3325	# if we are delayed by four ticks or more, skip them all
2288	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3326	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2289		3327
2290	$TICK_WATCHER->at ($NEXT_TICK);	3328	$TICK_WATCHER->at ($NEXT_TICK);
2291	$TICK_WATCHER->start;	3329	$TICK_WATCHER->start;
		3330
		3331	$LOAD = ($NOW - $tick_start) / $TICK;
		3332	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3333
		3334	_post_tick;
		3335
		3336
2292	},	3337	},
2293	);	3338	);
2294		3339
		3340	{
2295	IO::AIO::max_poll_time $TICK * 0.2;	3341	BDB::max_poll_time $TICK * 0.1;
2296		3342	$BDB_POLL_WATCHER = Event->io (
2297	Event->io (	3343	reentrant => 0,
2298	fd => IO::AIO::poll_fileno,	3344	fd => BDB::poll_fileno,
2299	poll => 'r',	3345	poll => 'r',
2300	prio => 5,	3346	prio => 0,
2301	data => WF_AUTOCANCEL,
2302	cb => \&IO::AIO::poll_cb,
2303	);
2304
2305	Event->timer (
2306	data => WF_AUTOCANCEL,	3347	data => WF_AUTOCANCEL,
2307	after => 0,	3348	cb => \&BDB::poll_cb,
2308	interval => 10,	3349	);
2309	cb => sub {	3350	BDB::min_parallel 8;
2310	(Coro::unblock_sub {	3351
2311	write_runtime	3352	BDB::set_sync_prepare {
2312	or warn "ERROR: unable to write runtime file: $!";	3353	my $status;
		3354	my $current = $Coro::current;
		3355	(
		3356	sub {
		3357	$status = $!;
		3358	$current->ready; undef $current;
		3359	},
		3360	sub {
		3361	Coro::schedule while defined $current;
		3362	$! = $status;
		3363	},
		3364	)
		3365	};
		3366
		3367	unless ($DB_ENV) {
		3368	$DB_ENV = BDB::db_env_create;
		3369
		3370	cf::sync_job {
		3371	eval {
		3372	BDB::db_env_open
		3373	$DB_ENV,
		3374	$BDBDIR,
		3375	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3376	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3377	0666;
		3378
		3379	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3380
		3381	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3382	$DB_ENV->set_lk_detect;
		3383	};
		3384
		3385	cf::cleanup "db_env_open(db): $@" if $@;
2313	})->();	3386	};
2314	},	3387	}
2315	);	3388	}
		3389
		3390	{
		3391	IO::AIO::min_parallel 8;
		3392
		3393	undef $Coro::AIO::WATCHER;
		3394	IO::AIO::max_poll_time $TICK * 0.1;
		3395	$AIO_POLL_WATCHER = Event->io (
		3396	reentrant => 0,
		3397	data => WF_AUTOCANCEL,
		3398	fd => IO::AIO::poll_fileno,
		3399	poll => 'r',
		3400	prio => 6,
		3401	cb => \&IO::AIO::poll_cb,
		3402	);
		3403	}
		3404
		3405	my $_log_backtrace;
		3406
		3407	sub _log_backtrace {
		3408	my ($msg, @addr) = @_;
		3409
		3410	$msg =~ s/\n//;
		3411
		3412	# limit the # of concurrent backtraces
		3413	if ($_log_backtrace < 2) {
		3414	++$_log_backtrace;
		3415	async {
		3416	my @bt = fork_call {
		3417	@addr = map { sprintf "%x", $_ } @addr;
		3418	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3419	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3420	or die "addr2line: $!";
		3421
		3422	my @funcs;
		3423	my @res = <$fh>;
		3424	chomp for @res;
		3425	while (@res) {
		3426	my ($func, $line) = splice @res, 0, 2, ();
		3427	push @funcs, "[$func] $line";
		3428	}
		3429
		3430	@funcs
		3431	};
		3432
		3433	LOG llevInfo, "[ABT] $msg\n";
		3434	LOG llevInfo, "[ABT] $_\n" for @bt;
		3435	--$_log_backtrace;
		3436	};
		3437	} else {
		3438	LOG llevInfo, "[ABT] $msg\n";
		3439	LOG llevInfo, "[ABT] [suppressed]\n";
		3440	}
		3441	}
		3442
		3443	# load additional modules
		3444	use cf::pod;
2316		3445
2317	END { cf::emergency_save }	3446	END { cf::emergency_save }
2318		3447
2319	1	3448	1
2320		3449

Diff Legend

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