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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.320 by root, Tue Jul 24 22:49:40 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.4 ();	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 ();
20	use Data::Dumper;	27	use Data::Dumper;
21	use Digest::MD5;	28	use Digest::MD5;
22	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
23	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	32	use Time::HiRes;
		33	use Compress::LZF;
		34	use Digest::MD5 ();
26		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
27	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
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		43
31	# 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?
32	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
33		46
34	$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
35		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
36	our %COMMAND = ();	51	our %COMMAND = ();
37	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
38		53
39	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
43		59
		60	our $RELOAD; # number of reloads so far
44	our @EVENT;	61	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		62
47	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(!)
48	our $TICK_WATCHER;	76	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	79	our $NEXT_TICK;
52	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;
53		85
54	our %CFG;	86	our %CFG;
55		87
56	our $UPTIME; $UPTIME ||= time;	88	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	89	our $RUNTIME;
58		90
59	our %PLAYER; # all users	91	our %PLAYER; # all users
60	our %MAP; # all maps	92	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	93	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		94
67	# used to convert map paths into valid unix filenames by replacing / by ∕	95	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		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
		101
70	binmode STDOUT;	102	binmode STDOUT;
71	binmode STDERR;	103	binmode STDERR;
72		104
73	# read virtual server time, if available	105	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
78	}	110	}
79		111
80	mkdir cf::localdir;	112	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		114
86	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
		116
		117	sub cf::map::normalise;
87		118
88	#############################################################################	119	#############################################################################
89		120
90	=head2 GLOBAL VARIABLES	121	=head2 GLOBAL VARIABLES
91		122
…		…
98	=item $cf::RUNTIME	129	=item $cf::RUNTIME
99		130
100	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
101	every server tick.	132	every server tick.
102		133
103	=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
104		137
105	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
106	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.
107		142
108	=item $cf::NOW	143	=item $cf::NOW
109		144
110	The time of the last (current) server tick.	145	The time of the last (current) server tick.
111		146
112	=item $cf::TICK	147	=item $cf::TICK
113		148
114	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.
115		160
116	=item %cf::CFG	161	=item %cf::CFG
117		162
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	164	from wherever your confdir points to.
120		165
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		167
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	169	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	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.
127		177
128	=back	178	=back
129		179
130	=cut	180	=cut
131		181
132	BEGIN {	182	BEGIN {
133	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	184	my $msg = join "", @_;
135	utf8::encode $msg;
136		185
137	$msg .= "\n"	186	$msg .= "\n"
138	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
139		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
140	LOG llevError, $msg;	192	LOG llevError, $msg;
141	};	193	};
142	}	194	}
143		195
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@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';
149	@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)
150		203
151	# 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
152	# within the Safe compartment.	205	# within the Safe compartment.
153	for my $pkg (qw(	206	for my $pkg (qw(
154	cf::global cf::attachable	207	cf::global cf::attachable
…		…
162	}	215	}
163		216
164	$Event::DIED = sub {	217	$Event::DIED = sub {
165	warn "error in event callback: @_";	218	warn "error in event callback: @_";
166	};	219	};
		220
		221	#############################################################################
167		222
168	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
169		224
170	=over 4	225	=over 4
171		226
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	246	$d
192	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
193	}	248	}
194		249
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
198		251
199	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
200		253
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
209		255
210	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
211		257
212	=cut	258	=cut
213		259
214	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
216	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
218		264
219	=item cf::lock_wait $string	265	=item cf::lock_wait $string
220		266
221	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
222		268
…		…
228	returned.	274	returned.
229		275
230	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
231	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
232		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
233	=cut	283	=cut
234		284
235	our %LOCK;	285	our %LOCK;
236		286
237	sub lock_wait($) {	287	sub lock_wait($) {
…		…
256	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
258	}	308	}
259	}	309	}
260		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
		315	}
		316
261	sub freeze_mainloop {	317	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
263		319
264	my $guard = Coro::guard {	320	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	321	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	322	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
270	$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;
271	}	381	}
272		382
273	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
274		384
275	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		390
281	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
282		392
283	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
284		394
285	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)
286	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
287	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.
288		399
289	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
290	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
291	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
292	fast or be very important.	403	fast or be very important.
…		…
295		406
296	sub sync_job(&) {	407	sub sync_job(&) {
297	my ($job) = @_;	408	my ($job) = @_;
298		409
299	if ($Coro::current == $Coro::main) {	410	if ($Coro::current == $Coro::main) {
		411	my $time = Event::time;
		412
300	# this is the main coro, too bad, we have to block	413	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	414	# till the operation succeeds, freezing the server :/
302		415
303	# TODO: use suspend/resume instead	416	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	417	# (but this is cancel-safe)
…		…
315		428
316	while ($busy) {	429	while ($busy) {
317	Coro::cede or Event::one_event;	430	Coro::cede or Event::one_event;
318	}	431	}
319		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
320	wantarray ? @res : $res[0]	440	wantarray ? @res : $res[0]
321	} else {	441	} else {
322	# we are in another coroutine, how wonderful, everything just works	442	# we are in another coroutine, how wonderful, everything just works
323		443
324	$job->()	444	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
344		464
345	$coro	465	$coro
346	}	466	}
347		467
348	sub write_runtime {	468	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		469
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	470	Executes the given code block with the given arguments in a seperate
352	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.
353		474
354	my $value = $cf::RUNTIME + 90 + 10;	475	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		476
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	477	sub _store_scalar {
359	and return;	478	open my $fh, ">", \my $buf
360		479	or die "fork_call: cannot open fh-to-buf in child : $!";
361	aio_fsync $fh	480	Storable::store_fd $_[0], $fh;
362	and return;
363
364	close $fh	481	close $fh;
365	or return;
366		482
367	aio_rename "$runtime~", $runtime	483	$buf
368	and return;	484	}
369		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;
370	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 });
371	}	655	}
372		656
373	=back	657	=back
374		658
375	=cut	659	=cut
…		…
382	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")
383	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
384		668
385	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>
386	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
387	crossfire+).	671	Crossfire TRT).
388		672
389	=over 4	673	=over 4
390		674
391	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
392		676
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
556		840
557	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		845
562	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	847	my $pkg = shift @arg;
564		848
565	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
595	}	879	}
596		880
597	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
598	} else {	882	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	884	}
601		885
602	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
603	}	887	}
604		888
…		…
606	if (ref $_[0]) {	890	if (ref $_[0]) {
607	_object_attach @_;	891	_object_attach @_;
608	} else {	892	} else {
609	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
610	}	894	}
		895	_recalc_want;
611	};	896	};
612		897
613	# all those should be optimised	898	# all those should be optimised
614	sub cf::attachable::detach {	899	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
619	reattach ($obj);	904	reattach ($obj);
620	} else {	905	} else {
621	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
622	}	907	}
		908	_recalc_want;
623	};	909	};
624		910
625	sub cf::attachable::attached {	911	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
627		913
…		…
642	";	928	";
643	die if $@;	929	die if $@;
644	}	930	}
645		931
646	our $override;	932	our $override;
647	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?
648		934
649	sub override {	935	sub override {
650	$override = 1;	936	$override = 1;
651	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
652	}	938	}
653		939
654	sub do_invoke {	940	sub do_invoke {
655	my $event = shift;	941	my $event = shift;
656	my $callbacks = shift;	942	my $callbacks = shift;
657		943
658	@invoke_results = ();	944	@INVOKE_RESULTS = ();
659		945
660	local $override;	946	local $override;
661		947
662	for (@$callbacks) {	948	for (@$callbacks) {
663	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
680		966
681	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
682		968
683	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
684	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
685	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		972
687	=back	973	=back
688		974
689	=cut	975	=cut
690		976
691	#############################################################################	977	#############################################################################
692	# 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	}
693		990
694	sub reattach {	991	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	993	my ($obj) = @_;
697		994
…		…
750	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
751		1048
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1053	close $fh;
757		1054
758	if (@$objs) {	1055	if (@$objs) {
759	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) {
760	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1061	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
766	}	1063	}
767	} else {	1064	} else {
768	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
800	or return;	1097	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1099	}
803		1100
804	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1103	return ($data, $av);
807	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
808		1111
809	#############################################################################	1112	#############################################################################
810	# command handling &c	1113	# command handling &c
811		1114
812	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1129	}
827		1130
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1132
830	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
831		1138
832	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
833	called.	1140	called.
834		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
835	=cut	1153	=cut
836		1154
837	sub register_extcmd {	1155	sub register_extcmd {
838	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
839		1157
840	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
841	}	1165	}
842		1166
843	cf::player->attach (	1167	cf::player->attach (
844	on_command => sub {	1168	on_command => sub {
845	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1178	cf::override;
855	},	1179	},
856	on_extcmd => sub {	1180	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
858		1182
859	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1184
861	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
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
864	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
865	}	1195	if $reply;
866	}	1196	}
867	} else {	1197	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1199	}
870		1200
871	cf::override;	1201	cf::override;
872	},	1202	},
873	);	1203	);
874		1204
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
910	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1210	next unless -r $path;
912	eval {	1211
913	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;
914	1	1269	}
915	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
916	}	1275	};
917	}	1276	}
918		1277
919	#############################################################################	1278	#############################################################################
920		1279
		1280	=back
		1281
921	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
922		1283
923	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
924		1285
925	=cut	1286	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
938		1299
939	=cut	1300	=cut
940		1301
941	sub playerdir($) {	1302	sub playerdir($) {
942	cf::localdir	1303	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1305	}
948		1306
949	sub path($) {	1307	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1309
952	(playerdir $login) . "/$login.pl"	1310	(playerdir $login) . "/playerdata"
953	}	1311	}
954		1312
955	sub find_active($) {	1313	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1314	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1315	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1328	my $login = $_[0];
971		1329
972	my $guard = cf::lock_acquire "user_find:$login";	1330	my $guard = cf::lock_acquire "user_find:$login";
973		1331
974	$cf::PLAYER{$_[0]} || do {	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
975	my $pl = load_pl path $login	1340	my $pl = load_pl path $login
976	or return;	1341	or return;
977	$cf::PLAYER{$login} = $pl	1342	$cf::PLAYER{$login} = $pl
978	}	1343	}
979	}	1344	}
…		…
1016		1381
1017	=cut	1382	=cut
1018		1383
1019	sub quit_character {	1384	sub quit_character {
1020	my ($pl) = @_;	1385	my ($pl) = @_;
		1386
		1387	my $name = $pl->ob->name;
1021		1388
1022	$pl->{deny_save} = 1;	1389	$pl->{deny_save} = 1;
1023	$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
1024		1391
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1392	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1397	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1398	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1399	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1400	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1401	$pl->destroy;
		1402
		1403	my $prefix = qr<^~\Q$name\E/>;
		1404
		1405	# nuke player maps
		1406	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1407
1035	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;
1036	}	1423	}
1037		1424
1038	=item cf::player::list_logins	1425	=item cf::player::list_logins
1039		1426
1040	Returns am arrayref of all valid playernames in the system, can take a	1427	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1428	while and may block, so not sync_job-capable, ever.
1042		1429
1043	=cut	1430	=cut
1044		1431
1045	sub list_logins {	1432	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1433	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1434	or return [];
1048		1435
1049	my @logins;	1436	my @logins;
1050		1437
1051	for my $login (@$dirs) {	1438	for my $login (@$dirs) {
…		…
1068	=cut	1455	=cut
1069		1456
1070	sub maps($) {	1457	sub maps($) {
1071	my ($pl) = @_;	1458	my ($pl) = @_;
1072		1459
		1460	$pl = ref $pl ? $pl->ob->name : $pl;
		1461
1073	my $files = aio_readdir playerdir $pl	1462	my $files = aio_readdir playerdir $pl
1074	or return;	1463	or return;
1075		1464
1076	my @paths;	1465	my @paths;
1077		1466
1078	for (@$files) {	1467	for (@$files) {
1079	utf8::decode $_;	1468	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1469	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1470	next unless /^$PATH_SEP/o;
1082		1471
1083	s/\.map$//;	1472	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1473	}
1086		1474
1087	\@paths	1475	\@paths
1088	}	1476	}
1089		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
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1091		1529
1092	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1093		1531
1094	=cut	1532	=cut
1095		1533
1096	sub ext_reply($$$%) {	1534	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1098		1536
1099	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1100		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1101	$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	}
1102	}	1544	}
1103		1545
1104	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	}
1105		1586
1106	=back	1587	=back
1107
1108		1588
1109	=head3 cf::map	1589	=head3 cf::map
1110		1590
1111	=over 4	1591	=over 4
1112		1592
…		…
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1620	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region}), $rmp->{custom}	1621	(cf::region::find $rmp->{region}), $rmp->{custom}
1142	)	1622	)
1143	}	1623	}
1144		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
1145	sub register {	1633	sub register {
1146	my (undef, $regex) = @_;	1634	my (undef, $regex, $prio) = @_;
1147	my $pkg = caller;	1635	my $pkg = caller;
1148		1636
1149	no strict;	1637	no strict;
1150	push @{"$pkg\::ISA"}, __PACKAGE__;	1638	push @{"$pkg\::ISA"}, __PACKAGE__;
1151		1639
1152	$EXT_MAP{$pkg} = qr<$regex>;	1640	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1153	}	1641	}
1154		1642
1155	# also paths starting with '/'	1643	# also paths starting with '/'
1156	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1644	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1157		1645
1158	sub thawer_merge {	1646	sub thawer_merge {
1159	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1160		1648
1161	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1162	local $self->{path};	1650	local $self->{path};
1163	local $self->{load_path};	1651	local $self->{load_path};
1164	local $self->{deny_save};
1165	local $self->{deny_reset};
1166		1652
1167	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1168	}	1654	}
1169		1655
1170	sub normalise {	1656	sub normalise {
1171	my ($path, $base) = @_;	1657	my ($path, $base) = @_;
		1658
		1659	$path = "$path"; # make sure its a string
		1660
		1661	$path =~ s/\.map$//;
1172		1662
1173	# map plan:	1663	# map plan:
1174	#	1664	#
1175	# /! non-realised random map exit (special hack!)	1665	# /! non-realised random map exit (special hack!)
1176	# {... are special paths that are not being touched	1666	# {... are special paths that are not being touched
…		…
1204		1694
1205	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1695	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1206		1696
1207	$path = normalise $path, $base;	1697	$path = normalise $path, $base;
1208		1698
1209	for my $pkg (keys %EXT_MAP) {	1699	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1210	if ($path =~ $EXT_MAP{$pkg}) {	1700	if ($path =~ $EXT_MAP{$pkg}[1]) {
1211	my $self = bless cf::map::new, $pkg;	1701	my $self = bless cf::map::new, $pkg;
1212	$self->{path} = $path; $self->path ($path);	1702	$self->{path} = $path; $self->path ($path);
1213	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1214	return $self;	1704	return $self;
1215	}	1705	}
1216	}	1706	}
1217		1707
1218	Carp::carp "unable to resolve path '$path'.";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1219	()	1709	()
1220	}	1710	}
1221		1711
1222	sub init {	1712	sub init {
1223	my ($self) = @_;	1713	my ($self) = @_;
…		…
1238		1728
1239	# the original (read-only) location	1729	# the original (read-only) location
1240	sub load_path {	1730	sub load_path {
1241	my ($self) = @_;	1731	my ($self) = @_;
1242		1732
1243	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1733	"$MAPDIR/$self->{path}.map"
1244	}	1734	}
1245		1735
1246	# the temporary/swap location	1736	# the temporary/swap location
1247	sub save_path {	1737	sub save_path {
1248	my ($self) = @_;	1738	my ($self) = @_;
1249		1739
1250	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1740	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1251	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1741	"$TMPDIR/$path.map"
1252	}	1742	}
1253		1743
1254	# the unique path, undef == no special unique path	1744	# the unique path, undef == no special unique path
1255	sub uniq_path {	1745	sub uniq_path {
1256	my ($self) = @_;	1746	my ($self) = @_;
1257		1747
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1748	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1749	"$UNIQUEDIR/$path"
1260	}	1750	}
1261		1751
1262	# and all this just because we cannot iterate over	1752	# and all this just because we cannot iterate over
1263	# all maps in C++...	1753	# all maps in C++...
1264	sub change_all_map_light {	1754	sub change_all_map_light {
…		…
1266		1756
1267	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1268	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
1269	}	1759	}
1270		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
		1767	}
		1768
1271	sub unlink_save {	1769	sub unlink_save {
1272	my ($self) = @_;	1770	my ($self) = @_;
1273		1771
1274	utf8::encode (my $save = $self->save_path);	1772	utf8::encode (my $save = $self->save_path);
1275	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1773	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1278		1776
1279	sub load_header_from($) {	1777	sub load_header_from($) {
1280	my ($self, $path) = @_;	1778	my ($self, $path) = @_;
1281		1779
1282	utf8::encode $path;	1780	utf8::encode $path;
1283	aio_open $path, O_RDONLY, 0	1781	#aio_open $path, O_RDONLY, 0
1284	or return;	1782	# or return;
1285		1783
1286	$self->_load_header ($path)	1784	$self->_load_header ($path)
1287	or return;	1785	or return;
1288		1786
1289	$self->{load_path} = $path;	1787	$self->{load_path} = $path;
1290		1788
1291	1	1789	1
1292	}	1790	}
1293		1791
1294	sub load_orig {	1792	sub load_header_orig {
1295	my ($self) = @_;	1793	my ($self) = @_;
1296		1794
1297	$self->load_header_from ($self->load_path)	1795	$self->load_header_from ($self->load_path)
1298	}	1796	}
1299		1797
1300	sub load_temp {	1798	sub load_header_temp {
1301	my ($self) = @_;	1799	my ($self) = @_;
1302		1800
1303	$self->load_header_from ($self->save_path)	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;
1304	}	1821	}
1305		1822
1306	sub load_header {	1823	sub load_header {
1307	my ($self) = @_;	1824	my ($self) = @_;
1308		1825
1309	if ($self->load_temp) {	1826	if ($self->load_header_temp) {
1310	$self->last_access ((delete $self->{last_access})	1827	$self->prepare_temp;
1311	|| $cf::RUNTIME); #d#
1312	# safety
1313	$self->{instantiate_time} = $cf::RUNTIME
1314	if $self->{instantiate_time} > $cf::RUNTIME;
1315	} else {	1828	} else {
1316	$self->load_orig	1829	$self->load_header_orig
1317	or return;	1830	or return;
1318		1831	$self->prepare_orig;
1319	$self->{load_original} = 1;
1320	$self->{instantiate_time} = $cf::RUNTIME;
1321	$self->last_access ($cf::RUNTIME);
1322	$self->instantiate;
1323	}	1832	}
		1833
		1834	$self->{deny_reset} = 1
		1835	if $self->no_reset;
		1836
		1837	$self->default_region (cf::region::find_by_path $self->{path})
		1838	unless $self->default_region;
1324		1839
1325	1	1840	1
1326	}	1841	}
1327		1842
1328	sub find;	1843	sub find;
…		…
1341	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1342		1857
1343	$map->load_header	1858	$map->load_header
1344	or return;	1859	or return;
1345		1860
1346	if ($map->should_reset) {	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1347	# doing this can freeze the server in a sync job, obviously	1862	# doing this can freeze the server in a sync job, obviously
1348	#$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1349	$map->reset;	1864	$map->reset;
1350	undef $guard;	1865	undef $guard;
1351	$map = find $path	1866	return find $path;
1352	or return;
1353	}	1867	}
1354		1868
1355	$cf::MAP{$path} = $map	1869	$cf::MAP{$path} = $map
1356	}	1870	}
1357	}	1871	}
		1872
		1873	sub pre_load { }
		1874	sub post_load { }
1358		1875
1359	sub load {	1876	sub load {
1360	my ($self) = @_;	1877	my ($self) = @_;
1361		1878
		1879	local $self->{deny_reset} = 1; # loading can take a long time
		1880
1362	my $path = $self->{path};	1881	my $path = $self->{path};
		1882
		1883	{
1363	my $guard = cf::lock_acquire "map_load:$path";	1884	my $guard = cf::lock_acquire "map_load:$path";
1364		1885
1365	return if $self->in_memory != cf::MAP_SWAPPED;	1886	return if $self->in_memory != cf::MAP_SWAPPED;
1366		1887
1367	$self->in_memory (cf::MAP_LOADING);	1888	$self->in_memory (cf::MAP_LOADING);
1368		1889
1369	$self->alloc;	1890	$self->alloc;
1370	$self->_load_objects ($self->{load_path}, 1)
1371	or return;
1372		1891
1373	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1892	$self->pre_load;
1374	if delete $self->{load_original};
1375
1376	if (my $uniq = $self->uniq_path) {
1377	utf8::encode $uniq;
1378	if (aio_open $uniq, O_RDONLY, 0) {
1379	$self->clear_unique_items;
1380	$self->_load_objects ($uniq, 0);
1381	}
1382	}
1383
1384	Coro::cede;
1385
1386	# now do the right thing for maps
1387	$self->link_multipart_objects;
1388
1389	unless ($self->{deny_activate}) {
1390	$self->decay_objects;
1391	$self->fix_auto_apply;
1392	$self->update_buttons;
1393	Coro::cede;	1893	Coro::cede;
1394	$self->set_darkness_map;	1894
		1895	$self->_load_objects ($self->{load_path}, 1)
		1896	or return;
		1897
		1898	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1899	if delete $self->{load_original};
		1900
		1901	if (my $uniq = $self->uniq_path) {
		1902	utf8::encode $uniq;
		1903	if (aio_open $uniq, O_RDONLY, 0) {
		1904	$self->clear_unique_items;
		1905	$self->_load_objects ($uniq, 0);
		1906	}
		1907	}
		1908
		1909	Coro::cede;
		1910	# now do the right thing for maps
		1911	$self->link_multipart_objects;
1395	$self->difficulty ($self->estimate_difficulty)	1912	$self->difficulty ($self->estimate_difficulty)
1396	unless $self->difficulty;	1913	unless $self->difficulty;
1397	Coro::cede;	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;
1398	$self->activate;	1923	$self->activate;
1399	}	1924	}
1400		1925
1401	$self->in_memory (cf::MAP_IN_MEMORY);	1926	$self->in_memory (cf::MAP_IN_MEMORY);
		1927	}
		1928
		1929	$self->post_load;
1402	}	1930	}
1403		1931
1404	sub customise_for {	1932	sub customise_for {
1405	my ($self, $ob) = @_;	1933	my ($self, $ob) = @_;
1406		1934
1407	return find "~" . $ob->name . "/" . $self->{path}	1935	return find "~" . $ob->name . "/" . $self->{path}
1408	if $self->per_player;	1936	if $self->per_player;
		1937
		1938	# return find "?party/" . $ob->name . "/" . $self->{path}
		1939	# if $self->per_party;
1409		1940
1410	$self	1941	$self
1411	}	1942	}
1412		1943
1413	# find and load all maps in the 3x3 area around a map	1944	# find and load all maps in the 3x3 area around a map
…		…
1460		1991
1461	undef $MAP_PREFETCH{$path};	1992	undef $MAP_PREFETCH{$path};
1462	$MAP_PREFETCHER ||= cf::async {	1993	$MAP_PREFETCHER ||= cf::async {
1463	while (%MAP_PREFETCH) {	1994	while (%MAP_PREFETCH) {
1464	for my $path (keys %MAP_PREFETCH) {	1995	for my $path (keys %MAP_PREFETCH) {
1465	my $map = find $path	1996	if (my $map = find $path) {
1466	or next;
1467	$map->load;	1997	$map->load;
		1998	}
1468		1999
1469	delete $MAP_PREFETCH{$path};	2000	delete $MAP_PREFETCH{$path};
1470	}	2001	}
1471	}	2002	}
1472	undef $MAP_PREFETCHER;	2003	undef $MAP_PREFETCHER;
1473	};	2004	};
		2005	$MAP_PREFETCHER->prio (6);
1474		2006
1475	()	2007	()
1476	}	2008	}
1477		2009
1478	sub save {	2010	sub save {
…		…
1523		2055
1524	sub reset_at {	2056	sub reset_at {
1525	my ($self) = @_;	2057	my ($self) = @_;
1526		2058
1527	# TODO: safety, remove and allow resettable per-player maps	2059	# TODO: safety, remove and allow resettable per-player maps
1528	return 1e99 if $self->isa ("ext::map_per_player");#d#
1529	return 1e99 if $self->{deny_reset};	2060	return 1e99 if $self->{deny_reset};
1530		2061
1531	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2062	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1532	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;
1533		2064
…		…
1544	my ($self) = @_;	2075	my ($self) = @_;
1545		2076
1546	my $lock = cf::lock_acquire "map_data:$self->{path}";	2077	my $lock = cf::lock_acquire "map_data:$self->{path}";
1547		2078
1548	return if $self->players;	2079	return if $self->players;
1549	return if $self->isa ("ext::map_per_player");#d#
1550		2080
1551	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	}
1552		2092
1553	delete $cf::MAP{$self->path};	2093	delete $cf::MAP{$self->path};
1554		2094
1555	$self->in_memory (cf::MAP_SWAPPED);
1556	$self->clear;	2095	$self->clear;
1557		2096
1558	$_->clear_links_to ($self) for values %cf::MAP;	2097	$_->clear_links_to ($self) for values %cf::MAP;
1559		2098
1560	$self->unlink_save;	2099	$self->unlink_save;
…		…
1579	$cf::MAP{$self->path} = $self;	2118	$cf::MAP{$self->path} = $self;
1580		2119
1581	$self->reset; # polite request, might not happen	2120	$self->reset; # polite request, might not happen
1582	}	2121	}
1583		2122
		2123	=item $maps = cf::map::tmp_maps
		2124
		2125	Returns an arrayref with all map paths of currently instantiated and saved
		2126	maps. May block.
		2127
		2128	=cut
		2129
		2130	sub tmp_maps() {
		2131	[
		2132	map {
		2133	utf8::decode $_;
		2134	/\.map$/
		2135	? normalise $_
		2136	: ()
		2137	} @{ aio_readdir $TMPDIR or [] }
		2138	]
		2139	}
		2140
		2141	=item $maps = cf::map::random_maps
		2142
		2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	random maps. May block.
		2145
		2146	=cut
		2147
		2148	sub random_maps() {
		2149	[
		2150	map {
		2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise "?random/$_"
		2154	: ()
		2155	} @{ aio_readdir $RANDOMDIR or [] }
		2156	]
		2157	}
		2158
1584	=item cf::map::unique_maps	2159	=item cf::map::unique_maps
1585		2160
1586	Returns an arrayref of paths of all shared maps that have	2161	Returns an arrayref of paths of all shared maps that have
1587	instantiated unique items. May block.	2162	instantiated unique items. May block.
1588		2163
1589	=cut	2164	=cut
1590		2165
1591	sub unique_maps() {	2166	sub unique_maps() {
1592	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2167	[
1593	or return;	2168	map {
1594
1595	my @paths;
1596
1597	for (@$files) {
1598	utf8::decode $_;	2169	utf8::decode $_;
1599	next if /\.pst$/;
1600	next unless /^$PATH_SEP/o;
1601
1602	s/\.map$//;	2170	/\.map$/
1603	push @paths, $_;	2171	? normalise $_
		2172	: ()
		2173	} @{ aio_readdir $UNIQUEDIR or [] }
1604	}	2174	]
1605
1606	\@paths
1607	}	2175	}
1608		2176
1609	package cf;	2177	package cf;
1610		2178
1611	=back	2179	=back
…		…
1657		2225
1658	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2226	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1659		2227
1660	if ($self->{record_replies}) {	2228	if ($self->{record_replies}) {
1661	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2229	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2230
1662	} 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 {
1663	$msg = $npc->name . " says: $msg" if $npc;	2239	$msg = $npc->name . " says: $msg" if $npc;
1664	$self->message ($msg, $flags);	2240	$self->message ($msg, $flags);
		2241	}
1665	}	2242	}
1666	}	2243	}
1667		2244
1668	=item $player_object->may ("access")	2245	=item $player_object->may ("access")
1669		2246
…		…
1702	=cut	2279	=cut
1703		2280
1704	sub link_map {	2281	sub link_map {
1705	unless ($LINK_MAP) {	2282	unless ($LINK_MAP) {
1706	$LINK_MAP = cf::map::find "{link}"	2283	$LINK_MAP = cf::map::find "{link}"
1707	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2284	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1708	$LINK_MAP->load;	2285	$LINK_MAP->load;
1709	}	2286	}
1710		2287
1711	$LINK_MAP	2288	$LINK_MAP
1712	}	2289	}
…		…
1717	$self->deactivate_recursive;	2294	$self->deactivate_recursive;
1718		2295
1719	return if UNIVERSAL::isa $self->map, "ext::map_link";	2296	return if UNIVERSAL::isa $self->map, "ext::map_link";
1720		2297
1721	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2298	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1722	if $self->map;	2299	if $self->map && $self->map->{path} ne "{link}";
1723		2300
1724	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2301	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1725	}	2302	}
1726		2303
1727	sub cf::object::player::leave_link {	2304	sub cf::object::player::leave_link {
1728	my ($self, $map, $x, $y) = @_;	2305	my ($self, $map, $x, $y) = @_;
		2306
		2307	return unless $self->contr->active;
1729		2308
1730	my $link_pos = delete $self->{_link_pos};	2309	my $link_pos = delete $self->{_link_pos};
1731		2310
1732	unless ($map) {	2311	unless ($map) {
1733	# restore original map position	2312	# restore original map position
…		…
1751	$map->load;	2330	$map->load;
1752	$map->load_diag;	2331	$map->load_diag;
1753		2332
1754	return unless $self->contr->active;	2333	return unless $self->contr->active;
1755	$self->activate_recursive;	2334	$self->activate_recursive;
		2335
		2336	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1756	$self->enter_map ($map, $x, $y);	2337	$self->enter_map ($map, $x, $y);
1757	}	2338	}
1758		2339
1759	cf::player->attach (	2340	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1760	on_logout => sub {
1761	my ($pl) = @_;
1762		2341
1763	# abort map switching before logout	2342	Moves the player to the given map-path and coordinates by first freezing
1764	if ($pl->ob->{_link_pos}) {	2343	her, loading and preparing them map, calling the provided $check callback
1765	cf::sync_job {	2344	that has to return the map if sucecssful, and then unfreezes the player on
1766	$pl->ob->leave_link	2345	the new (success) or old (failed) map position. In either case, $done will
1767	};	2346	be called at the end of this process.
1768	}
1769	},
1770	on_login => sub {
1771	my ($pl) = @_;
1772		2347
1773	# try to abort aborted map switching on player login :)
1774	# should happen only on crashes
1775	if ($pl->ob->{_link_pos}) {
1776	$pl->ob->enter_link;
1777	(async {
1778	# we need this sleep as the login has a concurrent enter_exit running
1779	# and this sleep increases chances of the player not ending up in scorn
1780	$pl->ob->reply (undef,
1781	"There was an internal problem at your last logout, "
1782	. "the server will try to bring you to your intended destination in a second.",
1783	cf::NDI_RED);
1784	Coro::Timer::sleep 1;
1785	$pl->ob->leave_link;
1786	})->prio (2);
1787	}
1788	},
1789	);
1790
1791	=item $player_object->goto ($path, $x, $y)
1792
1793	=cut	2348	=cut
		2349
		2350	our $GOTOGEN;
1794		2351
1795	sub cf::object::player::goto {	2352	sub cf::object::player::goto {
1796	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;
1797		2357
1798	$self->enter_link;	2358	$self->enter_link;
1799		2359
1800	(async {	2360	(async {
		2361	my $map = eval {
1801	my $map = cf::map::find $path;	2362	my $map = cf::map::find $path;
		2363
		2364	if ($map) {
1802	$map = $map->customise_for ($self) if $map;	2365	$map = $map->customise_for ($self);
1803		2366	$map = $check->($map) if $check && $map;
1804	# warn "entering ", $map->path, " at ($x, $y)\n"	2367	} else {
1805	# if $map;
1806
1807	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2368	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	}
1808		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};
1809	$self->leave_link ($map, $x, $y);	2381	$self->leave_link ($map, $x, $y);
		2382	}
		2383
		2384	$done->() if $done;
1810	})->prio (1);	2385	})->prio (1);
1811	}	2386	}
1812		2387
1813	=item $player_object->enter_exit ($exit_object)	2388	=item $player_object->enter_exit ($exit_object)
1814		2389
…		…
1843	# that depends on the exit object	2418	# that depends on the exit object
1844		2419
1845	my $rmp = parse_random_map_params $exit->msg;	2420	my $rmp = parse_random_map_params $exit->msg;
1846		2421
1847	if ($exit->map) {	2422	if ($exit->map) {
1848	$rmp->{region} = $exit->map->region_name;	2423	$rmp->{region} = $exit->region->name;
1849	$rmp->{origin_map} = $exit->map->path;	2424	$rmp->{origin_map} = $exit->map->path;
1850	$rmp->{origin_x} = $exit->x;	2425	$rmp->{origin_x} = $exit->x;
1851	$rmp->{origin_y} = $exit->y;	2426	$rmp->{origin_y} = $exit->y;
1852	}	2427	}
1853		2428
1854	$rmp->{random_seed} ||= $exit->random_seed;	2429	$rmp->{random_seed} ||= $exit->random_seed;
1855		2430
1856	my $data = cf::to_json $rmp;	2431	my $data = cf::to_json $rmp;
1857	my $md5 = Digest::MD5::md5_hex $data;	2432	my $md5 = Digest::MD5::md5_hex $data;
1858	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2433	my $meta = "$RANDOMDIR/$md5.meta";
1859		2434
1860	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2435	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1861	aio_write $fh, 0, (length $data), $data, 0;	2436	aio_write $fh, 0, (length $data), $data, 0;
1862	undef $fh;	2437	undef $fh;
1863	aio_rename "$meta~", $meta;	2438	aio_rename "$meta~", $meta;
…		…
1870	sub cf::object::player::enter_exit {	2445	sub cf::object::player::enter_exit {
1871	my ($self, $exit) = @_;	2446	my ($self, $exit) = @_;
1872		2447
1873	return unless $self->type == cf::PLAYER;	2448	return unless $self->type == cf::PLAYER;
1874		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
1875	$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);
1876		2466
1877	(async {	2467	(async {
1878	$self->deactivate_recursive; # just to be sure	2468	$self->deactivate_recursive; # just to be sure
1879	unless (eval {	2469	unless (eval {
1880	prepare_random_map $exit	2470	$self->goto ($slaying, $hp, $sp);
1881	if $exit->slaying eq "/!";
1882
1883	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1884	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1885		2471
1886	1;	2472	1;
1887	}) {	2473	}) {
1888	$self->message ("Something went wrong deep within the crossfire server. "	2474	$self->message ("Something went wrong deep within the crossfire server. "
1889	. "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. "
1890	. "Please report this to the dungeon master!",	2476	. "Please report this to the dungeon master!",
1891	cf::NDI_UNIQUE | cf::NDI_RED);	2477	cf::NDI_UNIQUE | cf::NDI_RED);
1892		2478
1893	warn "ERROR in enter_exit: $@";	2479	warn "ERROR in enter_exit: $@";
1894	$self->leave_link;	2480	$self->leave_link;
1895	}	2481	}
1896	})->prio (1);	2482	})->prio (1);
…		…
1909		2495
1910	sub cf::client::send_drawinfo {	2496	sub cf::client::send_drawinfo {
1911	my ($self, $text, $flags) = @_;	2497	my ($self, $text, $flags) = @_;
1912		2498
1913	utf8::encode $text;	2499	utf8::encode $text;
1914	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2500	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1915	}	2501	}
1916		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	}
1917		2573
1918	=item $success = $client->query ($flags, "text", \&cb)	2574	=item $success = $client->query ($flags, "text", \&cb)
1919		2575
1920	Queues a query to the client, calling the given callback with	2576	Queues a query to the client, calling the given callback with
1921	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>,
1922	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>.
1923		2579
1924	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
1925	reliable at some point in the future.	2581	become reliable at some point in the future.
1926		2582
1927	=cut	2583	=cut
1928		2584
1929	sub cf::client::query {	2585	sub cf::client::query {
1930	my ($self, $flags, $text, $cb) = @_;	2586	my ($self, $flags, $text, $cb) = @_;
…		…
1938	utf8::encode $text;	2594	utf8::encode $text;
1939	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1940		2596
1941	$self->send_packet ($self->{query_queue}[0][0])	2597	$self->send_packet ($self->{query_queue}[0][0])
1942	if @{ $self->{query_queue} } == 1;	2598	if @{ $self->{query_queue} } == 1;
		2599
		2600	1
1943	}	2601	}
1944		2602
1945	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	},
1946	on_reply => sub {	2609	on_reply => sub {
1947	my ($ns, $msg) = @_;	2610	my ($ns, $msg) = @_;
1948		2611
1949	# this weird shuffling is so that direct followup queries	2612	# this weird shuffling is so that direct followup queries
1950	# get handled first	2613	# get handled first
1951	my $queue = delete $ns->{query_queue}	2614	my $queue = delete $ns->{query_queue}
1952	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
1953		2616
1954	(shift @$queue)->[1]->($msg);	2617	(shift @$queue)->[1]->($msg);
		2618	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1955		2619
1956	push @{ $ns->{query_queue} }, @$queue;	2620	push @{ $ns->{query_queue} }, @$queue;
1957		2621
1958	if (@{ $ns->{query_queue} } == @$queue) {	2622	if (@{ $ns->{query_queue} } == @$queue) {
1959	if (@$queue) {	2623	if (@$queue) {
…		…
1961	} else {	2625	} else {
1962	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2626	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1963	}	2627	}
1964	}	2628	}
1965	},	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	},
1966	);	2653	);
1967		2654
1968	=item $client->async (\&cb)	2655	=item $client->async (\&cb)
1969		2656
1970	Create a new coroutine, running the specified callback. The coroutine will	2657	Create a new coroutine, running the specified callback. The coroutine will
…		…
2017		2704
2018	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
2019		2706
2020	=pod	2707	=pod
2021		2708
2022	The following fucntions and emthods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2023		2710
2024	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
2025	cf::object::player player	2715	cf::object::player
2026	cf::player peaceful	2716	player
2027	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2028		2723
2029	=cut	2724	=cut
2030		2725
2031	for (	2726	for (
2032	["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)],
2033	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2034	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2035	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2036	) {	2732	) {
2037	no strict 'refs';	2733	no strict 'refs';
…		…
2108	=back	2804	=back
2109		2805
2110	=cut	2806	=cut
2111		2807
2112	#############################################################################	2808	#############################################################################
		2809	# the server's init and main functions
2113		2810
2114	=head2 EXTENSION DATABASE SUPPORT	2811	sub load_facedata($) {
		2812	my ($path) = @_;
2115		2813
2116	Crossfire maintains a very simple database for extension use. It can	2814	warn "loading facedata from $path\n";
2117	currently store anything that can be serialised using Storable, which
2118	excludes objects.
2119		2815
2120	The parameter C<$family> should best start with the name of the extension	2816	my $facedata;
2121	using it, it should be unique.	2817	0 < aio_load $path, $facedata
		2818	or die "$path: $!";
2122		2819
2123	=over 4	2820	$facedata = Coro::Storable::thaw $facedata;
2124		2821
2125	=item $hashref = cf::db_get $family	2822	$facedata->{version} == 2
		2823	or cf::cleanup "$path: version mismatch, cannot proceed.";
2126		2824
2127	Return a hashref for use by the extension C<$family>, which can be
2128	modified. After modifications, you have to call C<cf::db_dirty> or
2129	C<cf::db_sync>.
2130
2131	=item $value = cf::db_get $family => $key
2132
2133	Returns a single value from the database
2134
2135	=item cf::db_put $family => $hashref
2136
2137	Stores the given family hashref into the database. Updates are delayed, if
2138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140	=item cf::db_put $family => $key => $value
2141
2142	Stores the given C<$value> in the family hash. Updates are delayed, if you
2143	want the data to be synced to disk immediately, use C<cf::db_sync>.
2144
2145	=item cf::db_dirty
2146
2147	Marks the database as dirty, to be updated at a later time.
2148
2149	=item cf::db_sync
2150
2151	Immediately write the database to disk I<if it is dirty>.
2152
2153	=cut
2154
2155	our $DB;
2156
2157	{
2158	my $path = cf::localdir . "/database.pst";
2159
2160	sub db_load() {
2161	$DB = stat $path ? Storable::retrieve $path : { };
2162	}	2825	{
		2826	my $faces = $facedata->{faceinfo};
2163		2827
2164	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};
2165		2834
2166	sub db_save() {	2835	cf::cede_to_tick;
2167	waitpid $pid, 0 if $pid;
2168	if (0 == ($pid = fork)) {
2169	$DB->{_meta}{version} = 1;
2170	Storable::nstore $DB, "$path~";
2171	rename "$path~", $path;
2172	cf::_exit 0 if defined $pid;
2173	}
2174	}
2175
2176	my $dirty;
2177
2178	sub db_sync() {
2179	db_save if $dirty;
2180	undef $dirty;
2181	}
2182
2183	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2184	db_sync;
2185	});
2186
2187	sub db_dirty() {
2188	$dirty = 1;
2189	$idle->start;
2190	}
2191
2192	sub db_get($;$) {
2193	@_ >= 2
2194	? $DB->{$_[0]}{$_[1]}
2195	: ($DB->{$_[0]} ||= { })
2196	}
2197
2198	sub db_put($$;$) {
2199	if (@_ >= 3) {
2200	$DB->{$_[0]}{$_[1]} = $_[2];
2201	} else {
2202	$DB->{$_[0]} = $_[1];
2203	}
2204	db_dirty;
2205	}
2206
2207	cf::global->attach (
2208	prio => 10000,
2209	on_cleanup => sub {
2210	db_sync;
2211	},	2836	}
2212	);
2213	}
2214		2837
2215	#############################################################################	2838	while (my ($face, $info) = each %$faces) {
2216	# 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	if (my $soundconf = delete $res->{"res/sound.conf"}) {
		2871	$soundconf = $enc->decode (delete $soundconf->{data});
		2872	# todo
		2873	}
		2874
		2875	while (my ($name, $info) = each %$res) {
		2876	my $meta = $enc->encode ({
		2877	name => $name,
		2878	%{ $info->{meta} || {} },
		2879	});
		2880
		2881	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2882
		2883	if ($info->{type} & 1) {
		2884	# prepend meta info
		2885
		2886	my $data = pack "(w/a*)*", $meta, $info->{data};
		2887	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2888
		2889	cf::face::set_data $idx, 0, $data, $chk;
		2890	} else {
		2891	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2892	}
		2893
		2894	cf::face::set_type $idx, $info->{type};
		2895
		2896	cf::cede_to_tick;
		2897	}
		2898	}
		2899
		2900	1
		2901	}
		2902
		2903	register_exticmd fx_want => sub {
		2904	my ($ns, $want) = @_;
		2905
		2906	while (my ($k, $v) = each %$want) {
		2907	$ns->fx_want ($k, $v);
		2908	}
		2909	};
		2910
		2911	sub reload_regions {
		2912	load_resource_file "$MAPDIR/regions"
		2913	or die "unable to load regions file\n";
		2914
		2915	for (cf::region::list) {
		2916	$_->{match} = qr/$_->{match}/
		2917	if exists $_->{match};
		2918	}
		2919	}
		2920
		2921	sub reload_facedata {
		2922	load_facedata "$DATADIR/facedata"
		2923	or die "unable to load facedata\n";
		2924	}
		2925
		2926	sub reload_archetypes {
		2927	load_resource_file "$DATADIR/archetypes"
		2928	or die "unable to load archetypes\n";
		2929	#d# NEED to laod twice to resolve forward references
		2930	# this really needs to be done in an extra post-pass
		2931	# (which needs to be synchronous, so solve it differently)
		2932	load_resource_file "$DATADIR/archetypes"
		2933	or die "unable to load archetypes\n";
		2934	}
		2935
		2936	sub reload_treasures {
		2937	load_resource_file "$DATADIR/treasures"
		2938	or die "unable to load treasurelists\n";
		2939	}
		2940
		2941	sub reload_resources {
		2942	warn "reloading resource files...\n";
		2943
		2944	reload_regions;
		2945	reload_facedata;
		2946	#reload_archetypes;#d#
		2947	reload_archetypes;
		2948	reload_treasures;
		2949
		2950	warn "finished reloading resource files\n";
		2951	}
		2952
		2953	sub init {
		2954	reload_resources;
		2955	}
2217		2956
2218	sub cfg_load {	2957	sub cfg_load {
2219	open my $fh, "<:utf8", cf::confdir . "/config"	2958	open my $fh, "<:utf8", "$CONFDIR/config"
2220	or return;	2959	or return;
2221		2960
2222	local $/;	2961	local $/;
2223	*CFG = YAML::Syck::Load <$fh>;	2962	*CFG = YAML::Syck::Load <$fh>;
2224		2963
…		…
2244	Event::one_event;	2983	Event::one_event;
2245	})->prio (Coro::PRIO_MAX);	2984	})->prio (Coro::PRIO_MAX);
2246	};	2985	};
2247		2986
2248	cfg_load;	2987	cfg_load;
2249	db_load;	2988	db_init;
2250	load_extensions;	2989	load_extensions;
2251		2990
2252	$TICK_WATCHER->start;	2991	$TICK_WATCHER->start;
2253	Event::loop;	2992	Event::loop;
2254	}	2993	}
…		…
2258		2997
2259	# install some emergency cleanup handlers	2998	# install some emergency cleanup handlers
2260	BEGIN {	2999	BEGIN {
2261	for my $signal (qw(INT HUP TERM)) {	3000	for my $signal (qw(INT HUP TERM)) {
2262	Event->signal (	3001	Event->signal (
		3002	reentrant => 0,
2263	data => WF_AUTOCANCEL,	3003	data => WF_AUTOCANCEL,
2264	signal => $signal,	3004	signal => $signal,
		3005	prio => 0,
2265	cb => sub {	3006	cb => sub {
2266	cf::cleanup "SIG$signal";	3007	cf::cleanup "SIG$signal";
2267	},	3008	},
2268	);	3009	);
2269	}	3010	}
		3011	}
		3012
		3013	sub write_runtime {
		3014	my $runtime = "$LOCALDIR/runtime";
		3015
		3016	# first touch the runtime file to show we are still running:
		3017	# the fsync below can take a very very long time.
		3018
		3019	IO::AIO::aio_utime $runtime, undef, undef;
		3020
		3021	my $guard = cf::lock_acquire "write_runtime";
		3022
		3023	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3024	or return;
		3025
		3026	my $value = $cf::RUNTIME + 90 + 10;
		3027	# 10 is the runtime save interval, for a monotonic clock
		3028	# 60 allows for the watchdog to kill the server.
		3029
		3030	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3031	and return;
		3032
		3033	# always fsync - this file is important
		3034	aio_fsync $fh
		3035	and return;
		3036
		3037	# touch it again to show we are up-to-date
		3038	aio_utime $fh, undef, undef;
		3039
		3040	close $fh
		3041	or return;
		3042
		3043	aio_rename "$runtime~", $runtime
		3044	and return;
		3045
		3046	warn "runtime file written.\n";
		3047
		3048	1
2270	}	3049	}
2271		3050
2272	sub emergency_save() {	3051	sub emergency_save() {
2273	my $freeze_guard = cf::freeze_mainloop;	3052	my $freeze_guard = cf::freeze_mainloop;
2274		3053
…		…
2291	my $map = $cf::MAP{$path} or next;	3070	my $map = $cf::MAP{$path} or next;
2292	$map->valid or next;	3071	$map->valid or next;
2293	$map->save;	3072	$map->save;
2294	}	3073	}
2295	warn "end emergency map save\n";	3074	warn "end emergency map save\n";
		3075
		3076	warn "begin emergency database checkpoint\n";
		3077	BDB::db_env_txn_checkpoint $DB_ENV;
		3078	warn "end emergency database checkpoint\n";
2296	};	3079	};
2297		3080
2298	warn "leave emergency perl save\n";	3081	warn "leave emergency perl save\n";
2299	}	3082	}
2300		3083
		3084	sub post_cleanup {
		3085	my ($make_core) = @_;
		3086
		3087	warn Carp::longmess "post_cleanup backtrace"
		3088	if $make_core;
		3089	}
		3090
2301	sub reload() {	3091	sub do_reload_perl() {
2302	# can/must only be called in main	3092	# can/must only be called in main
2303	if ($Coro::current != $Coro::main) {	3093	if ($Coro::current != $Coro::main) {
2304	warn "can only reload from main coroutine";	3094	warn "can only reload from main coroutine";
2305	return;	3095	return;
2306	}	3096	}
2307		3097
2308	warn "reloading...";	3098	warn "reloading...";
2309		3099
2310	warn "cancelling server ticker";	3100	warn "entering sync_job";
2311	$TICK_WATCHER->cancel;
2312		3101
		3102	cf::sync_job {
		3103	cf::write_runtime; # external watchdog should not bark
2313	cf::emergency_save;	3104	cf::emergency_save;
		3105	cf::write_runtime; # external watchdog should not bark
2314		3106
2315	eval {	3107	warn "syncing database to disk";
		3108	BDB::db_env_txn_checkpoint $DB_ENV;
		3109
2316	# if anything goes wrong in here, we should simply crash as we already saved	3110	# if anything goes wrong in here, we should simply crash as we already saved
2317
2318	warn "syncing database to disk";
2319	cf::db_sync;
2320		3111
2321	warn "cancelling all WF_AUTOCANCEL watchers";	3112	warn "cancelling all WF_AUTOCANCEL watchers";
2322	for (Event::all_watchers) {	3113	for (Event::all_watchers) {
2323	$_->cancel if $_->data & WF_AUTOCANCEL;	3114	$_->cancel if $_->data & WF_AUTOCANCEL;
2324	}	3115	}
2325		3116
2326	warn "flushing outstanding aio requests";	3117	warn "flushing outstanding aio requests";
2327	for (;;) {	3118	for (;;) {
		3119	BDB::flush;
2328	IO::AIO::flush;	3120	IO::AIO::flush;
2329	Coro::cede;	3121	Coro::cede;
2330	last unless IO::AIO::nreqs;	3122	last unless IO::AIO::nreqs || BDB::nreqs;
2331	warn "iterate...";	3123	warn "iterate...";
2332	}	3124	}
		3125
		3126	++$RELOAD;
2333		3127
2334	warn "cancelling all extension coros";	3128	warn "cancelling all extension coros";
2335	$_->cancel for values %EXT_CORO;	3129	$_->cancel for values %EXT_CORO;
2336	%EXT_CORO = ();	3130	%EXT_CORO = ();
2337		3131
2338	warn "removing commands";	3132	warn "removing commands";
2339	%COMMAND = ();	3133	%COMMAND = ();
2340		3134
2341	warn "removing ext commands";	3135	warn "removing ext/exti commands";
2342	%EXTCMD = ();	3136	%EXTCMD = ();
		3137	%EXTICMD = ();
2343		3138
2344	warn "unloading/nuking all extensions";	3139	warn "unloading/nuking all extensions";
2345	for my $pkg (@EXTS) {	3140	for my $pkg (@EXTS) {
2346	warn "... unloading $pkg";	3141	warn "... unloading $pkg";
2347		3142
…		…
2377	Symbol::delete_package "safe::$_"	3172	Symbol::delete_package "safe::$_"
2378	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3173	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2379		3174
2380	warn "unloading cf.pm \"a bit\"";	3175	warn "unloading cf.pm \"a bit\"";
2381	delete $INC{"cf.pm"};	3176	delete $INC{"cf.pm"};
		3177	delete $INC{"cf/pod.pm"};
2382		3178
2383	# don't, removes xs symbols, too,	3179	# don't, removes xs symbols, too,
2384	# and global variables created in xs	3180	# and global variables created in xs
2385	#Symbol::delete_package __PACKAGE__;	3181	#Symbol::delete_package __PACKAGE__;
2386		3182
…		…
2390	require cf;	3186	require cf;
2391	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3187	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2392		3188
2393	warn "loading config and database again";	3189	warn "loading config and database again";
2394	cf::cfg_load;	3190	cf::cfg_load;
2395	cf::db_load;
2396		3191
2397	warn "loading extensions";	3192	warn "loading extensions";
2398	cf::load_extensions;	3193	cf::load_extensions;
2399		3194
2400	warn "reattaching attachments to objects/players";	3195	warn "reattaching attachments to objects/players";
2401	_global_reattach;	3196	_global_reattach; # objects, sockets
2402	warn "reattaching attachments to maps";	3197	warn "reattaching attachments to maps";
2403	reattach $_ for values %MAP;	3198	reattach $_ for values %MAP;
		3199	warn "reattaching attachments to players";
		3200	reattach $_ for values %PLAYER;
2404		3201
2405	warn "restarting server ticker";	3202	warn "leaving sync_job";
2406		3203
2407	$TICK_WATCHER->start;	3204	1
2408	};	3205	} or do {
2409
2410	if ($@) {
2411	warn $@;	3206	warn $@;
2412	warn "error while reloading, exiting.";	3207	warn "error while reloading, exiting.";
2413	exit 1;	3208	exit 1;
2414	}	3209	};
2415		3210
2416	warn "reloaded";	3211	warn "reloaded";
2417	};	3212	};
2418		3213
2419	our $RELOAD_WATCHER; # used only during reload	3214	our $RELOAD_WATCHER; # used only during reload
2420		3215
		3216	sub reload_perl() {
		3217	# doing reload synchronously and two reloads happen back-to-back,
		3218	# coro crashes during coro_state_free->destroy here.
		3219
		3220	$RELOAD_WATCHER ||= Event->timer (
		3221	reentrant => 0,
		3222	after => 0,
		3223	data => WF_AUTOCANCEL,
		3224	cb => sub {
		3225	do_reload_perl;
		3226	undef $RELOAD_WATCHER;
		3227	},
		3228	);
		3229	}
		3230
2421	register_command "reload" => sub {	3231	register_command "reload" => sub {
2422	my ($who, $arg) = @_;	3232	my ($who, $arg) = @_;
2423		3233
2424	if ($who->flag (FLAG_WIZ)) {	3234	if ($who->flag (FLAG_WIZ)) {
2425	$who->message ("reloading server.");	3235	$who->message ("reloading server.");
2426		3236	async { reload_perl };
2427	# doing reload synchronously and two reloads happen back-to-back,
2428	# coro crashes during coro_state_free->destroy here.
2429
2430	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2431	reload;
2432	undef $RELOAD_WATCHER;
2433	});
2434	}	3237	}
2435	};	3238	};
2436		3239
2437	unshift @INC, $LIBDIR;	3240	unshift @INC, $LIBDIR;
2438		3241
2439	my $bug_warning = 0;	3242	my $bug_warning = 0;
2440		3243
		3244	our @WAIT_FOR_TICK;
		3245	our @WAIT_FOR_TICK_BEGIN;
		3246
		3247	sub wait_for_tick {
		3248	return unless $TICK_WATCHER->is_active;
		3249	return if $Coro::current == $Coro::main;
		3250
		3251	my $signal = new Coro::Signal;
		3252	push @WAIT_FOR_TICK, $signal;
		3253	$signal->wait;
		3254	}
		3255
		3256	sub wait_for_tick_begin {
		3257	return unless $TICK_WATCHER->is_active;
		3258	return if $Coro::current == $Coro::main;
		3259
		3260	my $signal = new Coro::Signal;
		3261	push @WAIT_FOR_TICK_BEGIN, $signal;
		3262	$signal->wait;
		3263	}
		3264
		3265	my $min = 1e6;#d#
		3266	my $avg = 10;
2441	$TICK_WATCHER = Event->timer (	3267	$TICK_WATCHER = Event->timer (
2442	reentrant => 0,	3268	reentrant => 0,
2443	parked => 1,	3269	parked => 1,
2444	prio => 0,	3270	prio => 0,
2445	at => $NEXT_TICK || $TICK,	3271	at => $NEXT_TICK || $TICK,
…		…
2449	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3275	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2450	unless ++$bug_warning > 10;	3276	unless ++$bug_warning > 10;
2451	return;	3277	return;
2452	}	3278	}
2453		3279
2454	$NOW = Event::time;	3280	$NOW = $tick_start = Event::time;
2455		3281
2456	cf::server_tick; # one server iteration	3282	cf::server_tick; # one server iteration
		3283
		3284	0 && sync_job {#d#
		3285	for(1..10) {
		3286	my $t = Event::time;
		3287	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3288	or die;
		3289
		3290	$map->width (50);
		3291	$map->height (50);
		3292	$map->alloc;
		3293	$map->_load_objects ("/tmp/x.map", 1);
		3294	my $t = Event::time - $t;
		3295
		3296	#next unless $t < 0.0013;#d#
		3297	if ($t < $min) {
		3298	$min = $t;
		3299	}
		3300	$avg = $avg * 0.99 + $t * 0.01;
		3301	}
		3302	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3303	exit 0;
		3304	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3305	};
		3306
2457	$RUNTIME += $TICK;	3307	$RUNTIME += $TICK;
2458	$NEXT_TICK += $TICK;	3308	$NEXT_TICK += $TICK;
2459		3309
2460	$WAIT_FOR_TICK->broadcast;	3310	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2461	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3311	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3312	Coro::async_pool {
		3313	write_runtime
		3314	or warn "ERROR: unable to write runtime file: $!";
		3315	};
		3316	}
		3317
		3318	# my $AFTER = Event::time;
		3319	# warn $AFTER - $NOW;#d#
		3320
		3321	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3322	$sig->send;
		3323	}
		3324	while (my $sig = shift @WAIT_FOR_TICK) {
		3325	$sig->send;
		3326	}
		3327
		3328	$NOW = Event::time;
2462		3329
2463	# if we are delayed by four ticks or more, skip them all	3330	# if we are delayed by four ticks or more, skip them all
2464	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3331	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2465		3332
2466	$TICK_WATCHER->at ($NEXT_TICK);	3333	$TICK_WATCHER->at ($NEXT_TICK);
2467	$TICK_WATCHER->start;	3334	$TICK_WATCHER->start;
		3335
		3336	$LOAD = ($NOW - $tick_start) / $TICK;
		3337	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3338
		3339	_post_tick;
		3340
		3341
2468	},	3342	},
2469	);	3343	);
2470		3344
		3345	{
		3346	BDB::max_poll_time $TICK * 0.1;
		3347	$BDB_POLL_WATCHER = Event->io (
		3348	reentrant => 0,
		3349	fd => BDB::poll_fileno,
		3350	poll => 'r',
		3351	prio => 0,
		3352	data => WF_AUTOCANCEL,
		3353	cb => \&BDB::poll_cb,
		3354	);
		3355	BDB::min_parallel 8;
		3356
		3357	BDB::set_sync_prepare {
		3358	my $status;
		3359	my $current = $Coro::current;
		3360	(
		3361	sub {
		3362	$status = $!;
		3363	$current->ready; undef $current;
		3364	},
		3365	sub {
		3366	Coro::schedule while defined $current;
		3367	$! = $status;
		3368	},
		3369	)
		3370	};
		3371
		3372	unless ($DB_ENV) {
		3373	$DB_ENV = BDB::db_env_create;
		3374
		3375	cf::sync_job {
		3376	eval {
		3377	BDB::db_env_open
		3378	$DB_ENV,
		3379	$BDBDIR,
		3380	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3381	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3382	0666;
		3383
		3384	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3385
		3386	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3387	$DB_ENV->set_lk_detect;
		3388	};
		3389
		3390	cf::cleanup "db_env_open(db): $@" if $@;
		3391	};
		3392	}
		3393	}
		3394
		3395	{
		3396	IO::AIO::min_parallel 8;
		3397
		3398	undef $Coro::AIO::WATCHER;
2471	IO::AIO::max_poll_time $TICK * 0.2;	3399	IO::AIO::max_poll_time $TICK * 0.1;
2472
2473	$AIO_POLL_WATCHER = Event->io (	3400	$AIO_POLL_WATCHER = Event->io (
2474	fd => IO::AIO::poll_fileno,	3401	reentrant => 0,
2475	poll => 'r',
2476	prio => 5,
2477	data => WF_AUTOCANCEL,
2478	cb => \&IO::AIO::poll_cb,
2479	);
2480
2481	$WRITE_RUNTIME_WATCHER = Event->timer (
2482	data => WF_AUTOCANCEL,	3402	data => WF_AUTOCANCEL,
2483	after => 1,	3403	fd => IO::AIO::poll_fileno,
2484	interval => 10,	3404	poll => 'r',
2485	prio => 6, # keep it lowest so it acts like a watchdog	3405	prio => 6,
2486	cb => Coro::unblock_sub {	3406	cb => \&IO::AIO::poll_cb,
2487	write_runtime	3407	);
2488	or warn "ERROR: unable to write runtime file: $!";	3408	}
		3409
		3410	my $_log_backtrace;
		3411
		3412	sub _log_backtrace {
		3413	my ($msg, @addr) = @_;
		3414
		3415	$msg =~ s/\n//;
		3416
		3417	# limit the # of concurrent backtraces
		3418	if ($_log_backtrace < 2) {
		3419	++$_log_backtrace;
		3420	async {
		3421	my @bt = fork_call {
		3422	@addr = map { sprintf "%x", $_ } @addr;
		3423	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3424	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3425	or die "addr2line: $!";
		3426
		3427	my @funcs;
		3428	my @res = <$fh>;
		3429	chomp for @res;
		3430	while (@res) {
		3431	my ($func, $line) = splice @res, 0, 2, ();
		3432	push @funcs, "[$func] $line";
		3433	}
		3434
		3435	@funcs
		3436	};
		3437
		3438	LOG llevInfo, "[ABT] $msg\n";
		3439	LOG llevInfo, "[ABT] $_\n" for @bt;
		3440	--$_log_backtrace;
		3441	};
		3442	} else {
		3443	LOG llevInfo, "[ABT] $msg\n";
		3444	LOG llevInfo, "[ABT] [suppressed]\n";
2489	},	3445	}
2490	);	3446	}
		3447
		3448	# load additional modules
		3449	use cf::pod;
2491		3450
2492	END { cf::emergency_save }	3451	END { cf::emergency_save }
2493		3452
2494	1	3453	1
2495		3454

Diff Legend

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