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.188 by root, Sat Jan 20 23:30:16 2007 UTC vs.
Revision 1.324 by root, Sat Jul 28 14:23:17 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.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
…		…
1167	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1168		1648
1169	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1170	local $self->{path};	1650	local $self->{path};
1171	local $self->{load_path};	1651	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1652
1175	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1176	}	1654	}
1177		1655
1178	sub normalise {	1656	sub normalise {
1179	my ($path, $base) = @_;	1657	my ($path, $base) = @_;
		1658
		1659	$path = "$path"; # make sure its a string
		1660
		1661	$path =~ s/\.map$//;
1180		1662
1181	# map plan:	1663	# map plan:
1182	#	1664	#
1183	# /! non-realised random map exit (special hack!)	1665	# /! non-realised random map exit (special hack!)
1184	# {... are special paths that are not being touched	1666	# {... are special paths that are not being touched
…		…
1221	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1222	return $self;	1704	return $self;
1223	}	1705	}
1224	}	1706	}
1225		1707
1226	Carp::carp "unable to resolve path '$path'.";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1227	()	1709	()
1228	}	1710	}
1229		1711
1230	sub init {	1712	sub init {
1231	my ($self) = @_;	1713	my ($self) = @_;
…		…
1246		1728
1247	# the original (read-only) location	1729	# the original (read-only) location
1248	sub load_path {	1730	sub load_path {
1249	my ($self) = @_;	1731	my ($self) = @_;
1250		1732
1251	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1733	"$MAPDIR/$self->{path}.map"
1252	}	1734	}
1253		1735
1254	# the temporary/swap location	1736	# the temporary/swap location
1255	sub save_path {	1737	sub save_path {
1256	my ($self) = @_;	1738	my ($self) = @_;
1257		1739
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1740	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1741	"$TMPDIR/$path.map"
1260	}	1742	}
1261		1743
1262	# the unique path, undef == no special unique path	1744	# the unique path, undef == no special unique path
1263	sub uniq_path {	1745	sub uniq_path {
1264	my ($self) = @_;	1746	my ($self) = @_;
1265		1747
1266	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1748	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1749	"$UNIQUEDIR/$path"
1268	}	1750	}
1269		1751
1270	# and all this just because we cannot iterate over	1752	# and all this just because we cannot iterate over
1271	# all maps in C++...	1753	# all maps in C++...
1272	sub change_all_map_light {	1754	sub change_all_map_light {
…		…
1274		1756
1275	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1276	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
1277	}	1759	}
1278		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
		1767	}
		1768
1279	sub unlink_save {	1769	sub unlink_save {
1280	my ($self) = @_;	1770	my ($self) = @_;
1281		1771
1282	utf8::encode (my $save = $self->save_path);	1772	utf8::encode (my $save = $self->save_path);
1283	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1773	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1286		1776
1287	sub load_header_from($) {	1777	sub load_header_from($) {
1288	my ($self, $path) = @_;	1778	my ($self, $path) = @_;
1289		1779
1290	utf8::encode $path;	1780	utf8::encode $path;
1291	aio_open $path, O_RDONLY, 0	1781	#aio_open $path, O_RDONLY, 0
1292	or return;	1782	# or return;
1293		1783
1294	$self->_load_header ($path)	1784	$self->_load_header ($path)
1295	or return;	1785	or return;
1296		1786
1297	$self->{load_path} = $path;	1787	$self->{load_path} = $path;
…		…
1339	$self->load_header_orig	1829	$self->load_header_orig
1340	or return;	1830	or return;
1341	$self->prepare_orig;	1831	$self->prepare_orig;
1342	}	1832	}
1343		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;
		1839
1344	1	1840	1
1345	}	1841	}
1346		1842
1347	sub find;	1843	sub find;
1348	sub find {	1844	sub find {
…		…
1360	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1361		1857
1362	$map->load_header	1858	$map->load_header
1363	or return;	1859	or return;
1364		1860
1365	if ($map->should_reset) {	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1366	# doing this can freeze the server in a sync job, obviously	1862	# doing this can freeze the server in a sync job, obviously
1367	#$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1368	$map->reset;	1864	$map->reset;
1369	undef $guard;	1865	undef $guard;
1370	$map = find $path	1866	return find $path;
1371	or return;
1372	}	1867	}
1373		1868
1374	$cf::MAP{$path} = $map	1869	$cf::MAP{$path} = $map
1375	}	1870	}
1376	}	1871	}
…		…
1379	sub post_load { }	1874	sub post_load { }
1380		1875
1381	sub load {	1876	sub load {
1382	my ($self) = @_;	1877	my ($self) = @_;
1383		1878
		1879	local $self->{deny_reset} = 1; # loading can take a long time
		1880
1384	my $path = $self->{path};	1881	my $path = $self->{path};
		1882
		1883	{
1385	my $guard = cf::lock_acquire "map_load:$path";	1884	my $guard = cf::lock_acquire "map_load:$path";
1386		1885
1387	return if $self->in_memory != cf::MAP_SWAPPED;	1886	return if $self->in_memory != cf::MAP_SWAPPED;
1388		1887
1389	$self->in_memory (cf::MAP_LOADING);	1888	$self->in_memory (cf::MAP_LOADING);
1390		1889
1391	$self->alloc;	1890	$self->alloc;
1392		1891
1393	$self->pre_load;	1892	$self->pre_load;
1394
1395	$self->_load_objects ($self->{load_path}, 1)
1396	or return;
1397
1398	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1399	if delete $self->{load_original};
1400
1401	if (my $uniq = $self->uniq_path) {
1402	utf8::encode $uniq;
1403	if (aio_open $uniq, O_RDONLY, 0) {
1404	$self->clear_unique_items;
1405	$self->_load_objects ($uniq, 0);
1406	}
1407	}
1408
1409	Coro::cede;
1410
1411	# now do the right thing for maps
1412	$self->link_multipart_objects;
1413
1414	unless ($self->{deny_activate}) {
1415	$self->decay_objects;
1416	$self->fix_auto_apply;
1417	$self->update_buttons;
1418	Coro::cede;	1893	Coro::cede;
1419	$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;
1420	$self->difficulty ($self->estimate_difficulty)	1912	$self->difficulty ($self->estimate_difficulty)
1421	unless $self->difficulty;	1913	unless $self->difficulty;
1422	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;
1423	$self->activate;	1923	$self->activate;
		1924	}
		1925
		1926	$map->{last_save} = $cf::RUNTIME;
		1927	$map->last_access ($cf::RUNTIME);
		1928
		1929	$self->in_memory (cf::MAP_IN_MEMORY);
1424	}	1930	}
1425		1931
1426	$self->post_load;	1932	$self->post_load;
1427
1428	$self->in_memory (cf::MAP_IN_MEMORY);
1429	}	1933	}
1430		1934
1431	sub customise_for {	1935	sub customise_for {
1432	my ($self, $ob) = @_;	1936	my ($self, $ob) = @_;
1433		1937
1434	return find "~" . $ob->name . "/" . $self->{path}	1938	return find "~" . $ob->name . "/" . $self->{path}
1435	if $self->per_player;	1939	if $self->per_player;
		1940
		1941	# return find "?party/" . $ob->name . "/" . $self->{path}
		1942	# if $self->per_party;
1436		1943
1437	$self	1944	$self
1438	}	1945	}
1439		1946
1440	# find and load all maps in the 3x3 area around a map	1947	# find and load all maps in the 3x3 area around a map
…		…
1487		1994
1488	undef $MAP_PREFETCH{$path};	1995	undef $MAP_PREFETCH{$path};
1489	$MAP_PREFETCHER ||= cf::async {	1996	$MAP_PREFETCHER ||= cf::async {
1490	while (%MAP_PREFETCH) {	1997	while (%MAP_PREFETCH) {
1491	for my $path (keys %MAP_PREFETCH) {	1998	for my $path (keys %MAP_PREFETCH) {
1492	my $map = find $path	1999	if (my $map = find $path) {
1493	or next;
1494	$map->load;	2000	$map->load;
		2001	}
1495		2002
1496	delete $MAP_PREFETCH{$path};	2003	delete $MAP_PREFETCH{$path};
1497	}	2004	}
1498	}	2005	}
1499	undef $MAP_PREFETCHER;	2006	undef $MAP_PREFETCHER;
1500	};	2007	};
		2008	$MAP_PREFETCHER->prio (6);
1501		2009
1502	()	2010	()
1503	}	2011	}
1504		2012
1505	sub save {	2013	sub save {
…		…
1550		2058
1551	sub reset_at {	2059	sub reset_at {
1552	my ($self) = @_;	2060	my ($self) = @_;
1553		2061
1554	# TODO: safety, remove and allow resettable per-player maps	2062	# TODO: safety, remove and allow resettable per-player maps
1555	return 1e99 if $self->isa ("ext::map_per_player");#d#
1556	return 1e99 if $self->{deny_reset};	2063	return 1e99 if $self->{deny_reset};
1557		2064
1558	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2065	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1559	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2066	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1560		2067
…		…
1571	my ($self) = @_;	2078	my ($self) = @_;
1572		2079
1573	my $lock = cf::lock_acquire "map_data:$self->{path}";	2080	my $lock = cf::lock_acquire "map_data:$self->{path}";
1574		2081
1575	return if $self->players;	2082	return if $self->players;
1576	return if $self->isa ("ext::map_per_player");#d#
1577		2083
1578	warn "resetting map ", $self->path;#d#	2084	warn "resetting map ", $self->path;
		2085
		2086	$self->in_memory (cf::MAP_SWAPPED);
		2087
		2088	# need to save uniques path
		2089	unless ($self->{deny_save}) {
		2090	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2091
		2092	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2093	if $uniq;
		2094	}
1579		2095
1580	delete $cf::MAP{$self->path};	2096	delete $cf::MAP{$self->path};
1581		2097
1582	$self->in_memory (cf::MAP_SWAPPED);
1583	$self->clear;	2098	$self->clear;
1584		2099
1585	$_->clear_links_to ($self) for values %cf::MAP;	2100	$_->clear_links_to ($self) for values %cf::MAP;
1586		2101
1587	$self->unlink_save;	2102	$self->unlink_save;
…		…
1606	$cf::MAP{$self->path} = $self;	2121	$cf::MAP{$self->path} = $self;
1607		2122
1608	$self->reset; # polite request, might not happen	2123	$self->reset; # polite request, might not happen
1609	}	2124	}
1610		2125
		2126	=item $maps = cf::map::tmp_maps
		2127
		2128	Returns an arrayref with all map paths of currently instantiated and saved
		2129	maps. May block.
		2130
		2131	=cut
		2132
		2133	sub tmp_maps() {
		2134	[
		2135	map {
		2136	utf8::decode $_;
		2137	/\.map$/
		2138	? normalise $_
		2139	: ()
		2140	} @{ aio_readdir $TMPDIR or [] }
		2141	]
		2142	}
		2143
		2144	=item $maps = cf::map::random_maps
		2145
		2146	Returns an arrayref with all map paths of currently instantiated and saved
		2147	random maps. May block.
		2148
		2149	=cut
		2150
		2151	sub random_maps() {
		2152	[
		2153	map {
		2154	utf8::decode $_;
		2155	/\.map$/
		2156	? normalise "?random/$_"
		2157	: ()
		2158	} @{ aio_readdir $RANDOMDIR or [] }
		2159	]
		2160	}
		2161
1611	=item cf::map::unique_maps	2162	=item cf::map::unique_maps
1612		2163
1613	Returns an arrayref of paths of all shared maps that have	2164	Returns an arrayref of paths of all shared maps that have
1614	instantiated unique items. May block.	2165	instantiated unique items. May block.
1615		2166
1616	=cut	2167	=cut
1617		2168
1618	sub unique_maps() {	2169	sub unique_maps() {
1619	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2170	[
1620	or return;	2171	map {
1621
1622	my @paths;
1623
1624	for (@$files) {
1625	utf8::decode $_;	2172	utf8::decode $_;
1626	next if /\.pst$/;
1627	next unless /^$PATH_SEP/o;
1628
1629	s/\.map$//;	2173	/\.map$/
1630	push @paths, $_;	2174	? normalise $_
		2175	: ()
		2176	} @{ aio_readdir $UNIQUEDIR or [] }
1631	}	2177	]
1632
1633	\@paths
1634	}	2178	}
1635		2179
1636	package cf;	2180	package cf;
1637		2181
1638	=back	2182	=back
…		…
1684		2228
1685	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2229	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1686		2230
1687	if ($self->{record_replies}) {	2231	if ($self->{record_replies}) {
1688	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2232	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2233
1689	} else {	2234	} else {
		2235	my $pl = $self->contr;
		2236
		2237	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2238	my $dialog = $pl->{npc_dialog};
		2239	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2240
		2241	} else {
1690	$msg = $npc->name . " says: $msg" if $npc;	2242	$msg = $npc->name . " says: $msg" if $npc;
1691	$self->message ($msg, $flags);	2243	$self->message ($msg, $flags);
		2244	}
1692	}	2245	}
1693	}	2246	}
1694		2247
1695	=item $player_object->may ("access")	2248	=item $player_object->may ("access")
1696		2249
…		…
1729	=cut	2282	=cut
1730		2283
1731	sub link_map {	2284	sub link_map {
1732	unless ($LINK_MAP) {	2285	unless ($LINK_MAP) {
1733	$LINK_MAP = cf::map::find "{link}"	2286	$LINK_MAP = cf::map::find "{link}"
1734	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2287	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1735	$LINK_MAP->load;	2288	$LINK_MAP->load;
1736	}	2289	}
1737		2290
1738	$LINK_MAP	2291	$LINK_MAP
1739	}	2292	}
…		…
1744	$self->deactivate_recursive;	2297	$self->deactivate_recursive;
1745		2298
1746	return if UNIVERSAL::isa $self->map, "ext::map_link";	2299	return if UNIVERSAL::isa $self->map, "ext::map_link";
1747		2300
1748	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2301	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1749	if $self->map;	2302	if $self->map && $self->map->{path} ne "{link}";
1750		2303
1751	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2304	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1752	}	2305	}
1753		2306
1754	sub cf::object::player::leave_link {	2307	sub cf::object::player::leave_link {
1755	my ($self, $map, $x, $y) = @_;	2308	my ($self, $map, $x, $y) = @_;
		2309
		2310	return unless $self->contr->active;
1756		2311
1757	my $link_pos = delete $self->{_link_pos};	2312	my $link_pos = delete $self->{_link_pos};
1758		2313
1759	unless ($map) {	2314	unless ($map) {
1760	# restore original map position	2315	# restore original map position
…		…
1778	$map->load;	2333	$map->load;
1779	$map->load_diag;	2334	$map->load_diag;
1780		2335
1781	return unless $self->contr->active;	2336	return unless $self->contr->active;
1782	$self->activate_recursive;	2337	$self->activate_recursive;
		2338
		2339	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1783	$self->enter_map ($map, $x, $y);	2340	$self->enter_map ($map, $x, $y);
1784	}	2341	}
1785		2342
1786	cf::player->attach (	2343	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1787	on_logout => sub {
1788	my ($pl) = @_;
1789		2344
1790	# abort map switching before logout	2345	Moves the player to the given map-path and coordinates by first freezing
1791	if ($pl->ob->{_link_pos}) {	2346	her, loading and preparing them map, calling the provided $check callback
1792	cf::sync_job {	2347	that has to return the map if sucecssful, and then unfreezes the player on
1793	$pl->ob->leave_link	2348	the new (success) or old (failed) map position. In either case, $done will
1794	};	2349	be called at the end of this process.
1795	}
1796	},
1797	on_login => sub {
1798	my ($pl) = @_;
1799		2350
1800	# try to abort aborted map switching on player login :)
1801	# should happen only on crashes
1802	if ($pl->ob->{_link_pos}) {
1803	$pl->ob->enter_link;
1804	(async {
1805	# we need this sleep as the login has a concurrent enter_exit running
1806	# and this sleep increases chances of the player not ending up in scorn
1807	$pl->ob->reply (undef,
1808	"There was an internal problem at your last logout, "
1809	. "the server will try to bring you to your intended destination in a second.",
1810	cf::NDI_RED);
1811	Coro::Timer::sleep 1;
1812	$pl->ob->leave_link;
1813	})->prio (2);
1814	}
1815	},
1816	);
1817
1818	=item $player_object->goto ($path, $x, $y)
1819
1820	=cut	2351	=cut
		2352
		2353	our $GOTOGEN;
1821		2354
1822	sub cf::object::player::goto {	2355	sub cf::object::player::goto {
1823	my ($self, $path, $x, $y) = @_;	2356	my ($self, $path, $x, $y, $check, $done) = @_;
		2357
		2358	# do generation counting so two concurrent goto's will be executed in-order
		2359	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1824		2360
1825	$self->enter_link;	2361	$self->enter_link;
1826		2362
1827	(async {	2363	(async {
		2364	my $map = eval {
1828	my $map = cf::map::find $path;	2365	my $map = cf::map::find $path;
		2366
		2367	if ($map) {
1829	$map = $map->customise_for ($self) if $map;	2368	$map = $map->customise_for ($self);
1830		2369	$map = $check->($map) if $check && $map;
1831	# warn "entering ", $map->path, " at ($x, $y)\n"	2370	} else {
1832	# if $map;
1833
1834	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2371	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2372	}
1835		2373
		2374	$map
		2375	};
		2376
		2377	if ($@) {
		2378	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2379	LOG llevError | logBacktrace, Carp::longmess $@;
		2380	}
		2381
		2382	if ($gen == $self->{_goto_generation}) {
		2383	delete $self->{_goto_generation};
1836	$self->leave_link ($map, $x, $y);	2384	$self->leave_link ($map, $x, $y);
		2385	}
		2386
		2387	$done->() if $done;
1837	})->prio (1);	2388	})->prio (1);
1838	}	2389	}
1839		2390
1840	=item $player_object->enter_exit ($exit_object)	2391	=item $player_object->enter_exit ($exit_object)
1841		2392
…		…
1870	# that depends on the exit object	2421	# that depends on the exit object
1871		2422
1872	my $rmp = parse_random_map_params $exit->msg;	2423	my $rmp = parse_random_map_params $exit->msg;
1873		2424
1874	if ($exit->map) {	2425	if ($exit->map) {
1875	$rmp->{region} = $exit->map->region_name;	2426	$rmp->{region} = $exit->region->name;
1876	$rmp->{origin_map} = $exit->map->path;	2427	$rmp->{origin_map} = $exit->map->path;
1877	$rmp->{origin_x} = $exit->x;	2428	$rmp->{origin_x} = $exit->x;
1878	$rmp->{origin_y} = $exit->y;	2429	$rmp->{origin_y} = $exit->y;
1879	}	2430	}
1880		2431
1881	$rmp->{random_seed} ||= $exit->random_seed;	2432	$rmp->{random_seed} ||= $exit->random_seed;
1882		2433
1883	my $data = cf::to_json $rmp;	2434	my $data = cf::to_json $rmp;
1884	my $md5 = Digest::MD5::md5_hex $data;	2435	my $md5 = Digest::MD5::md5_hex $data;
1885	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2436	my $meta = "$RANDOMDIR/$md5.meta";
1886		2437
1887	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2438	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1888	aio_write $fh, 0, (length $data), $data, 0;	2439	aio_write $fh, 0, (length $data), $data, 0;
1889	undef $fh;	2440	undef $fh;
1890	aio_rename "$meta~", $meta;	2441	aio_rename "$meta~", $meta;
…		…
1897	sub cf::object::player::enter_exit {	2448	sub cf::object::player::enter_exit {
1898	my ($self, $exit) = @_;	2449	my ($self, $exit) = @_;
1899		2450
1900	return unless $self->type == cf::PLAYER;	2451	return unless $self->type == cf::PLAYER;
1901		2452
		2453	if ($exit->slaying eq "/!") {
		2454	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2455	# the problem is that $exit might not survive long enough
		2456	# so it needs to be done right now, right here
		2457	cf::sync_job { prepare_random_map $exit };
		2458	}
		2459
		2460	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2461	my $hp = $exit->stats->hp;
		2462	my $sp = $exit->stats->sp;
		2463
1902	$self->enter_link;	2464	$self->enter_link;
		2465
		2466	# if exit is damned, update players death & WoR home-position
		2467	$self->contr->savebed ($slaying, $hp, $sp)
		2468	if $exit->flag (FLAG_DAMNED);
1903		2469
1904	(async {	2470	(async {
1905	$self->deactivate_recursive; # just to be sure	2471	$self->deactivate_recursive; # just to be sure
1906	unless (eval {	2472	unless (eval {
1907	prepare_random_map $exit	2473	$self->goto ($slaying, $hp, $sp);
1908	if $exit->slaying eq "/!";
1909
1910	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1911	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1912		2474
1913	1;	2475	1;
1914	}) {	2476	}) {
1915	$self->message ("Something went wrong deep within the crossfire server. "	2477	$self->message ("Something went wrong deep within the crossfire server. "
1916	. "I'll try to bring you back to the map you were before. "	2478	. "I'll try to bring you back to the map you were before. "
1917	. "Please report this to the dungeon master!",	2479	. "Please report this to the dungeon master!",
1918	cf::NDI_UNIQUE | cf::NDI_RED);	2480	cf::NDI_UNIQUE | cf::NDI_RED);
1919		2481
1920	warn "ERROR in enter_exit: $@";	2482	warn "ERROR in enter_exit: $@";
1921	$self->leave_link;	2483	$self->leave_link;
1922	}	2484	}
1923	})->prio (1);	2485	})->prio (1);
…		…
1936		2498
1937	sub cf::client::send_drawinfo {	2499	sub cf::client::send_drawinfo {
1938	my ($self, $text, $flags) = @_;	2500	my ($self, $text, $flags) = @_;
1939		2501
1940	utf8::encode $text;	2502	utf8::encode $text;
1941	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2503	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1942	}	2504	}
1943		2505
		2506	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	Send a drawinfo or msg packet to the client, formatting the msg for the
		2509	client if neccessary. C<$type> should be a string identifying the type of
		2510	the message, with C<log> being the default. If C<$color> is negative, suppress
		2511	the message unless the client supports the msg packet.
		2512
		2513	=cut
		2514
		2515	sub cf::client::send_msg {
		2516	my ($self, $channel, $msg, $color, @extra) = @_;
		2517
		2518	$msg = $self->pl->expand_cfpod ($msg);
		2519
		2520	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2521
		2522	if (ref $channel) {
		2523	# send meta info to client, if not yet sent
		2524	unless (exists $self->{channel}{$channel->{id}}) {
		2525	$self->{channel}{$channel->{id}} = $channel;
		2526	$self->ext_msg (channel_info => $channel);
		2527	}
		2528
		2529	$channel = $channel->{id};
		2530	}
		2531
		2532	return unless @extra || length $msg;
		2533
		2534	if ($self->can_msg) {
		2535	# default colour, mask it out
		2536	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2537	if $color & cf::NDI_DEF;
		2538
		2539	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2540	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2541	} else {
		2542	if ($color >= 0) {
		2543	# replace some tags by gcfclient-compatible ones
		2544	for ($msg) {
		2545	1 while
		2546	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2547	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2548	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2549	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2550	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2551	}
		2552
		2553	$color &= cf::NDI_COLOR_MASK;
		2554
		2555	if (0 && $msg =~ /\[/) {
		2556	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2557	} else {
		2558	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2559	$self->send_packet ("drawinfo $color $msg")
		2560	}
		2561	}
		2562	}
		2563	}
		2564
		2565	=item $client->ext_msg ($type, @msg)
		2566
		2567	Sends an ext event to the client.
		2568
		2569	=cut
		2570
		2571	sub cf::client::ext_msg($$@) {
		2572	my ($self, $type, @msg) = @_;
		2573
		2574	my $extcmd = $self->extcmd;
		2575
		2576	if ($extcmd == 2) {
		2577	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2578	} elsif ($extcmd == 1) { # TODO: remove
		2579	push @msg, msgtype => "event_$type";
		2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
		2582	}
1944		2583
1945	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
1946		2585
1947	Queues a query to the client, calling the given callback with	2586	Queues a query to the client, calling the given callback with
1948	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2587	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1949	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1950		2589
1951	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
1952	reliable at some point in the future.	2591	become reliable at some point in the future.
1953		2592
1954	=cut	2593	=cut
1955		2594
1956	sub cf::client::query {	2595	sub cf::client::query {
1957	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
1965	utf8::encode $text;	2604	utf8::encode $text;
1966	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1967		2606
1968	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
1969	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
1970	}	2611	}
1971		2612
1972	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
1973	on_reply => sub {	2619	on_reply => sub {
1974	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
1975		2621
1976	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
1977	# get handled first	2623	# get handled first
1978	my $queue = delete $ns->{query_queue}	2624	my $queue = delete $ns->{query_queue}
1979	or return; # be conservative, not sure how that can happen, but we saw a crash here	2625	or return; # be conservative, not sure how that can happen, but we saw a crash here
1980		2626
1981	(shift @$queue)->[1]->($msg);	2627	(shift @$queue)->[1]->($msg);
		2628	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1982		2629
1983	push @{ $ns->{query_queue} }, @$queue;	2630	push @{ $ns->{query_queue} }, @$queue;
1984		2631
1985	if (@{ $ns->{query_queue} } == @$queue) {	2632	if (@{ $ns->{query_queue} } == @$queue) {
1986	if (@$queue) {	2633	if (@$queue) {
…		…
1988	} else {	2635	} else {
1989	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1990	}	2637	}
1991	}	2638	}
1992	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
1993	);	2663	);
1994		2664
1995	=item $client->async (\&cb)	2665	=item $client->async (\&cb)
1996		2666
1997	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
…		…
2044		2714
2045	# here we export the classes and methods available to script code	2715	# here we export the classes and methods available to script code
2046		2716
2047	=pod	2717	=pod
2048		2718
2049	The following fucntions and emthods are available within a safe environment:	2719	The following functions and methods are available within a safe environment:
2050		2720
2051	cf::object contr pay_amount pay_player map	2721	cf::object
		2722	contr pay_amount pay_player map x y force_find force_add
		2723	insert remove
		2724
2052	cf::object::player player	2725	cf::object::player
2053	cf::player peaceful	2726	player
2054	cf::map trigger	2727
		2728	cf::player
		2729	peaceful
		2730
		2731	cf::map
		2732	trigger
2055		2733
2056	=cut	2734	=cut
2057		2735
2058	for (	2736	for (
2059	["cf::object" => qw(contr pay_amount pay_player map)],	2737	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2738	insert remove)],
2060	["cf::object::player" => qw(player)],	2739	["cf::object::player" => qw(player)],
2061	["cf::player" => qw(peaceful)],	2740	["cf::player" => qw(peaceful)],
2062	["cf::map" => qw(trigger)],	2741	["cf::map" => qw(trigger)],
2063	) {	2742	) {
2064	no strict 'refs';	2743	no strict 'refs';
…		…
2135	=back	2814	=back
2136		2815
2137	=cut	2816	=cut
2138		2817
2139	#############################################################################	2818	#############################################################################
		2819	# the server's init and main functions
2140		2820
2141	=head2 EXTENSION DATABASE SUPPORT	2821	sub load_facedata($) {
		2822	my ($path) = @_;
2142		2823
2143	Crossfire maintains a very simple database for extension use. It can	2824	warn "loading facedata from $path\n";
2144	currently store anything that can be serialised using Storable, which
2145	excludes objects.
2146		2825
2147	The parameter C<$family> should best start with the name of the extension	2826	my $facedata;
2148	using it, it should be unique.	2827	0 < aio_load $path, $facedata
		2828	or die "$path: $!";
2149		2829
2150	=over 4	2830	$facedata = Coro::Storable::thaw $facedata;
2151		2831
2152	=item $hashref = cf::db_get $family	2832	$facedata->{version} == 2
		2833	or cf::cleanup "$path: version mismatch, cannot proceed.";
2153		2834
2154	Return a hashref for use by the extension C<$family>, which can be
2155	modified. After modifications, you have to call C<cf::db_dirty> or
2156	C<cf::db_sync>.
2157
2158	=item $value = cf::db_get $family => $key
2159
2160	Returns a single value from the database
2161
2162	=item cf::db_put $family => $hashref
2163
2164	Stores the given family hashref into the database. Updates are delayed, if
2165	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2166
2167	=item cf::db_put $family => $key => $value
2168
2169	Stores the given C<$value> in the family hash. Updates are delayed, if you
2170	want the data to be synced to disk immediately, use C<cf::db_sync>.
2171
2172	=item cf::db_dirty
2173
2174	Marks the database as dirty, to be updated at a later time.
2175
2176	=item cf::db_sync
2177
2178	Immediately write the database to disk I<if it is dirty>.
2179
2180	=cut
2181
2182	our $DB;
2183
2184	{
2185	my $path = cf::localdir . "/database.pst";
2186
2187	sub db_load() {
2188	$DB = stat $path ? Storable::retrieve $path : { };
2189	}	2835	{
		2836	my $faces = $facedata->{faceinfo};
2190		2837
2191	my $pid;	2838	while (my ($face, $info) = each %$faces) {
		2839	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2840	cf::face::set_visibility $idx, $info->{visibility};
		2841	cf::face::set_magicmap $idx, $info->{magicmap};
		2842	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2843	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2192		2844
2193	sub db_save() {	2845	cf::cede_to_tick;
2194	waitpid $pid, 0 if $pid;
2195	if (0 == ($pid = fork)) {
2196	$DB->{_meta}{version} = 1;
2197	Storable::nstore $DB, "$path~";
2198	rename "$path~", $path;
2199	cf::_exit 0 if defined $pid;
2200	}
2201	}
2202
2203	my $dirty;
2204
2205	sub db_sync() {
2206	db_save if $dirty;
2207	undef $dirty;
2208	}
2209
2210	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2211	db_sync;
2212	});
2213
2214	sub db_dirty() {
2215	$dirty = 1;
2216	$idle->start;
2217	}
2218
2219	sub db_get($;$) {
2220	@_ >= 2
2221	? $DB->{$_[0]}{$_[1]}
2222	: ($DB->{$_[0]} ||= { })
2223	}
2224
2225	sub db_put($$;$) {
2226	if (@_ >= 3) {
2227	$DB->{$_[0]}{$_[1]} = $_[2];
2228	} else {
2229	$DB->{$_[0]} = $_[1];
2230	}
2231	db_dirty;
2232	}
2233
2234	cf::global->attach (
2235	prio => 10000,
2236	on_cleanup => sub {
2237	db_sync;
2238	},	2846	}
2239	);
2240	}
2241		2847
2242	#############################################################################	2848	while (my ($face, $info) = each %$faces) {
2243	# the server's main()	2849	next unless $info->{smooth};
		2850	my $idx = cf::face::find $face
		2851	or next;
		2852	if (my $smooth = cf::face::find $info->{smooth}) {
		2853	cf::face::set_smooth $idx, $smooth;
		2854	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2855	} else {
		2856	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2857	}
		2858
		2859	cf::cede_to_tick;
		2860	}
		2861	}
		2862
		2863	{
		2864	my $anims = $facedata->{animinfo};
		2865
		2866	while (my ($anim, $info) = each %$anims) {
		2867	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2868	cf::cede_to_tick;
		2869	}
		2870
		2871	cf::anim::invalidate_all; # d'oh
		2872	}
		2873
		2874	{
		2875	# TODO: for gcfclient pleasure, we should give resources
		2876	# that gcfclient doesn't grok a >10000 face index.
		2877	my $res = $facedata->{resource};
		2878	my $enc = JSON::XS->new->utf8->canonical;
		2879
		2880	my $soundconf = delete $res->{"res/sound.conf"};
		2881
		2882	while (my ($name, $info) = each %$res) {
		2883	my $meta = $enc->encode ({
		2884	name => $name,
		2885	%{ $info->{meta} || {} },
		2886	});
		2887
		2888	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2889
		2890	if ($info->{type} & 1) {
		2891	# prepend meta info
		2892
		2893	my $data = pack "(w/a*)*", $meta, $info->{data};
		2894	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2895
		2896	cf::face::set_data $idx, 0, $data, $chk;
		2897	} else {
		2898	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2899	}
		2900
		2901	cf::face::set_type $idx, $info->{type};
		2902
		2903	cf::cede_to_tick;
		2904	}
		2905
		2906	if ($soundconf) {
		2907	$soundconf = $enc->decode (delete $soundconf->{data});
		2908
		2909	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2910	my $sound = $soundconf->{compat}[$_]
		2911	or next;
		2912
		2913	my $face = cf::face::find "sound/$sound->[1]";
		2914
		2915	cf::sound::set $sound->[0] => $face;
		2916	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2917	}
		2918
		2919	#TODO
		2920	}
		2921	}
		2922
		2923	1
		2924	}
		2925
		2926	register_exticmd fx_want => sub {
		2927	my ($ns, $want) = @_;
		2928
		2929	while (my ($k, $v) = each %$want) {
		2930	$ns->fx_want ($k, $v);
		2931	}
		2932	};
		2933
		2934	sub reload_regions {
		2935	load_resource_file "$MAPDIR/regions"
		2936	or die "unable to load regions file\n";
		2937
		2938	for (cf::region::list) {
		2939	$_->{match} = qr/$_->{match}/
		2940	if exists $_->{match};
		2941	}
		2942	}
		2943
		2944	sub reload_facedata {
		2945	load_facedata "$DATADIR/facedata"
		2946	or die "unable to load facedata\n";
		2947	}
		2948
		2949	sub reload_archetypes {
		2950	load_resource_file "$DATADIR/archetypes"
		2951	or die "unable to load archetypes\n";
		2952	#d# NEED to laod twice to resolve forward references
		2953	# this really needs to be done in an extra post-pass
		2954	# (which needs to be synchronous, so solve it differently)
		2955	load_resource_file "$DATADIR/archetypes"
		2956	or die "unable to load archetypes\n";
		2957	}
		2958
		2959	sub reload_treasures {
		2960	load_resource_file "$DATADIR/treasures"
		2961	or die "unable to load treasurelists\n";
		2962	}
		2963
		2964	sub reload_resources {
		2965	warn "reloading resource files...\n";
		2966
		2967	reload_regions;
		2968	reload_facedata;
		2969	#reload_archetypes;#d#
		2970	reload_archetypes;
		2971	reload_treasures;
		2972
		2973	warn "finished reloading resource files\n";
		2974	}
		2975
		2976	sub init {
		2977	reload_resources;
		2978	}
2244		2979
2245	sub cfg_load {	2980	sub cfg_load {
2246	open my $fh, "<:utf8", cf::confdir . "/config"	2981	open my $fh, "<:utf8", "$CONFDIR/config"
2247	or return;	2982	or return;
2248		2983
2249	local $/;	2984	local $/;
2250	*CFG = YAML::Syck::Load <$fh>;	2985	*CFG = YAML::Syck::Load <$fh>;
2251		2986
…		…
2271	Event::one_event;	3006	Event::one_event;
2272	})->prio (Coro::PRIO_MAX);	3007	})->prio (Coro::PRIO_MAX);
2273	};	3008	};
2274		3009
2275	cfg_load;	3010	cfg_load;
2276	db_load;	3011	db_init;
2277	load_extensions;	3012	load_extensions;
2278		3013
2279	$TICK_WATCHER->start;	3014	$TICK_WATCHER->start;
2280	Event::loop;	3015	Event::loop;
2281	}	3016	}
…		…
2285		3020
2286	# install some emergency cleanup handlers	3021	# install some emergency cleanup handlers
2287	BEGIN {	3022	BEGIN {
2288	for my $signal (qw(INT HUP TERM)) {	3023	for my $signal (qw(INT HUP TERM)) {
2289	Event->signal (	3024	Event->signal (
		3025	reentrant => 0,
2290	data => WF_AUTOCANCEL,	3026	data => WF_AUTOCANCEL,
2291	signal => $signal,	3027	signal => $signal,
		3028	prio => 0,
2292	cb => sub {	3029	cb => sub {
2293	cf::cleanup "SIG$signal";	3030	cf::cleanup "SIG$signal";
2294	},	3031	},
2295	);	3032	);
2296	}	3033	}
		3034	}
		3035
		3036	sub write_runtime {
		3037	my $runtime = "$LOCALDIR/runtime";
		3038
		3039	# first touch the runtime file to show we are still running:
		3040	# the fsync below can take a very very long time.
		3041
		3042	IO::AIO::aio_utime $runtime, undef, undef;
		3043
		3044	my $guard = cf::lock_acquire "write_runtime";
		3045
		3046	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3047	or return;
		3048
		3049	my $value = $cf::RUNTIME + 90 + 10;
		3050	# 10 is the runtime save interval, for a monotonic clock
		3051	# 60 allows for the watchdog to kill the server.
		3052
		3053	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3054	and return;
		3055
		3056	# always fsync - this file is important
		3057	aio_fsync $fh
		3058	and return;
		3059
		3060	# touch it again to show we are up-to-date
		3061	aio_utime $fh, undef, undef;
		3062
		3063	close $fh
		3064	or return;
		3065
		3066	aio_rename "$runtime~", $runtime
		3067	and return;
		3068
		3069	warn "runtime file written.\n";
		3070
		3071	1
2297	}	3072	}
2298		3073
2299	sub emergency_save() {	3074	sub emergency_save() {
2300	my $freeze_guard = cf::freeze_mainloop;	3075	my $freeze_guard = cf::freeze_mainloop;
2301		3076
…		…
2318	my $map = $cf::MAP{$path} or next;	3093	my $map = $cf::MAP{$path} or next;
2319	$map->valid or next;	3094	$map->valid or next;
2320	$map->save;	3095	$map->save;
2321	}	3096	}
2322	warn "end emergency map save\n";	3097	warn "end emergency map save\n";
		3098
		3099	warn "begin emergency database checkpoint\n";
		3100	BDB::db_env_txn_checkpoint $DB_ENV;
		3101	warn "end emergency database checkpoint\n";
2323	};	3102	};
2324		3103
2325	warn "leave emergency perl save\n";	3104	warn "leave emergency perl save\n";
2326	}	3105	}
2327		3106
		3107	sub post_cleanup {
		3108	my ($make_core) = @_;
		3109
		3110	warn Carp::longmess "post_cleanup backtrace"
		3111	if $make_core;
		3112	}
		3113
2328	sub reload() {	3114	sub do_reload_perl() {
2329	# can/must only be called in main	3115	# can/must only be called in main
2330	if ($Coro::current != $Coro::main) {	3116	if ($Coro::current != $Coro::main) {
2331	warn "can only reload from main coroutine";	3117	warn "can only reload from main coroutine";
2332	return;	3118	return;
2333	}	3119	}
2334		3120
2335	warn "reloading...";	3121	warn "reloading...";
2336		3122
2337	warn "cancelling server ticker";	3123	warn "entering sync_job";
2338	$TICK_WATCHER->cancel;
2339		3124
		3125	cf::sync_job {
		3126	cf::write_runtime; # external watchdog should not bark
2340	cf::emergency_save;	3127	cf::emergency_save;
		3128	cf::write_runtime; # external watchdog should not bark
2341		3129
2342	eval {	3130	warn "syncing database to disk";
		3131	BDB::db_env_txn_checkpoint $DB_ENV;
		3132
2343	# if anything goes wrong in here, we should simply crash as we already saved	3133	# if anything goes wrong in here, we should simply crash as we already saved
2344
2345	warn "syncing database to disk";
2346	cf::db_sync;
2347		3134
2348	warn "cancelling all WF_AUTOCANCEL watchers";	3135	warn "cancelling all WF_AUTOCANCEL watchers";
2349	for (Event::all_watchers) {	3136	for (Event::all_watchers) {
2350	$_->cancel if $_->data & WF_AUTOCANCEL;	3137	$_->cancel if $_->data & WF_AUTOCANCEL;
2351	}	3138	}
2352		3139
2353	warn "flushing outstanding aio requests";	3140	warn "flushing outstanding aio requests";
2354	for (;;) {	3141	for (;;) {
		3142	BDB::flush;
2355	IO::AIO::flush;	3143	IO::AIO::flush;
2356	Coro::cede;	3144	Coro::cede;
2357	last unless IO::AIO::nreqs;	3145	last unless IO::AIO::nreqs || BDB::nreqs;
2358	warn "iterate...";	3146	warn "iterate...";
2359	}	3147	}
		3148
		3149	++$RELOAD;
2360		3150
2361	warn "cancelling all extension coros";	3151	warn "cancelling all extension coros";
2362	$_->cancel for values %EXT_CORO;	3152	$_->cancel for values %EXT_CORO;
2363	%EXT_CORO = ();	3153	%EXT_CORO = ();
2364		3154
2365	warn "removing commands";	3155	warn "removing commands";
2366	%COMMAND = ();	3156	%COMMAND = ();
2367		3157
2368	warn "removing ext commands";	3158	warn "removing ext/exti commands";
2369	%EXTCMD = ();	3159	%EXTCMD = ();
		3160	%EXTICMD = ();
2370		3161
2371	warn "unloading/nuking all extensions";	3162	warn "unloading/nuking all extensions";
2372	for my $pkg (@EXTS) {	3163	for my $pkg (@EXTS) {
2373	warn "... unloading $pkg";	3164	warn "... unloading $pkg";
2374		3165
…		…
2404	Symbol::delete_package "safe::$_"	3195	Symbol::delete_package "safe::$_"
2405	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3196	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2406		3197
2407	warn "unloading cf.pm \"a bit\"";	3198	warn "unloading cf.pm \"a bit\"";
2408	delete $INC{"cf.pm"};	3199	delete $INC{"cf.pm"};
		3200	delete $INC{"cf/pod.pm"};
2409		3201
2410	# don't, removes xs symbols, too,	3202	# don't, removes xs symbols, too,
2411	# and global variables created in xs	3203	# and global variables created in xs
2412	#Symbol::delete_package __PACKAGE__;	3204	#Symbol::delete_package __PACKAGE__;
2413		3205
…		…
2417	require cf;	3209	require cf;
2418	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3210	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2419		3211
2420	warn "loading config and database again";	3212	warn "loading config and database again";
2421	cf::cfg_load;	3213	cf::cfg_load;
2422	cf::db_load;
2423		3214
2424	warn "loading extensions";	3215	warn "loading extensions";
2425	cf::load_extensions;	3216	cf::load_extensions;
2426		3217
2427	warn "reattaching attachments to objects/players";	3218	warn "reattaching attachments to objects/players";
2428	_global_reattach;	3219	_global_reattach; # objects, sockets
2429	warn "reattaching attachments to maps";	3220	warn "reattaching attachments to maps";
2430	reattach $_ for values %MAP;	3221	reattach $_ for values %MAP;
		3222	warn "reattaching attachments to players";
		3223	reattach $_ for values %PLAYER;
2431		3224
2432	warn "restarting server ticker";	3225	warn "leaving sync_job";
2433		3226
2434	$TICK_WATCHER->start;	3227	1
2435	};	3228	} or do {
2436
2437	if ($@) {
2438	warn $@;	3229	warn $@;
2439	warn "error while reloading, exiting.";	3230	warn "error while reloading, exiting.";
2440	exit 1;	3231	exit 1;
2441	}	3232	};
2442		3233
2443	warn "reloaded";	3234	warn "reloaded";
2444	};	3235	};
2445		3236
2446	our $RELOAD_WATCHER; # used only during reload	3237	our $RELOAD_WATCHER; # used only during reload
2447		3238
		3239	sub reload_perl() {
		3240	# doing reload synchronously and two reloads happen back-to-back,
		3241	# coro crashes during coro_state_free->destroy here.
		3242
		3243	$RELOAD_WATCHER ||= Event->timer (
		3244	reentrant => 0,
		3245	after => 0,
		3246	data => WF_AUTOCANCEL,
		3247	cb => sub {
		3248	do_reload_perl;
		3249	undef $RELOAD_WATCHER;
		3250	},
		3251	);
		3252	}
		3253
2448	register_command "reload" => sub {	3254	register_command "reload" => sub {
2449	my ($who, $arg) = @_;	3255	my ($who, $arg) = @_;
2450		3256
2451	if ($who->flag (FLAG_WIZ)) {	3257	if ($who->flag (FLAG_WIZ)) {
2452	$who->message ("reloading server.");	3258	$who->message ("reloading server.");
2453		3259	async { reload_perl };
2454	# doing reload synchronously and two reloads happen back-to-back,
2455	# coro crashes during coro_state_free->destroy here.
2456
2457	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2458	reload;
2459	undef $RELOAD_WATCHER;
2460	});
2461	}	3260	}
2462	};	3261	};
2463		3262
2464	unshift @INC, $LIBDIR;	3263	unshift @INC, $LIBDIR;
2465		3264
2466	my $bug_warning = 0;	3265	my $bug_warning = 0;
2467		3266
		3267	our @WAIT_FOR_TICK;
		3268	our @WAIT_FOR_TICK_BEGIN;
		3269
		3270	sub wait_for_tick {
		3271	return unless $TICK_WATCHER->is_active;
		3272	return if $Coro::current == $Coro::main;
		3273
		3274	my $signal = new Coro::Signal;
		3275	push @WAIT_FOR_TICK, $signal;
		3276	$signal->wait;
		3277	}
		3278
		3279	sub wait_for_tick_begin {
		3280	return unless $TICK_WATCHER->is_active;
		3281	return if $Coro::current == $Coro::main;
		3282
		3283	my $signal = new Coro::Signal;
		3284	push @WAIT_FOR_TICK_BEGIN, $signal;
		3285	$signal->wait;
		3286	}
		3287
		3288	my $min = 1e6;#d#
		3289	my $avg = 10;
2468	$TICK_WATCHER = Event->timer (	3290	$TICK_WATCHER = Event->timer (
2469	reentrant => 0,	3291	reentrant => 0,
2470	parked => 1,	3292	parked => 1,
2471	prio => 0,	3293	prio => 0,
2472	at => $NEXT_TICK || $TICK,	3294	at => $NEXT_TICK || $TICK,
…		…
2476	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3298	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2477	unless ++$bug_warning > 10;	3299	unless ++$bug_warning > 10;
2478	return;	3300	return;
2479	}	3301	}
2480		3302
2481	$NOW = Event::time;	3303	$NOW = $tick_start = Event::time;
2482		3304
2483	cf::server_tick; # one server iteration	3305	cf::server_tick; # one server iteration
		3306
		3307	0 && sync_job {#d#
		3308	for(1..10) {
		3309	my $t = Event::time;
		3310	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3311	or die;
		3312
		3313	$map->width (50);
		3314	$map->height (50);
		3315	$map->alloc;
		3316	$map->_load_objects ("/tmp/x.map", 1);
		3317	my $t = Event::time - $t;
		3318
		3319	#next unless $t < 0.0013;#d#
		3320	if ($t < $min) {
		3321	$min = $t;
		3322	}
		3323	$avg = $avg * 0.99 + $t * 0.01;
		3324	}
		3325	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3326	exit 0;
		3327	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3328	};
		3329
2484	$RUNTIME += $TICK;	3330	$RUNTIME += $TICK;
2485	$NEXT_TICK += $TICK;	3331	$NEXT_TICK += $TICK;
2486		3332
2487	$WAIT_FOR_TICK->broadcast;	3333	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2488	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3334	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3335	Coro::async_pool {
		3336	write_runtime
		3337	or warn "ERROR: unable to write runtime file: $!";
		3338	};
		3339	}
		3340
		3341	# my $AFTER = Event::time;
		3342	# warn $AFTER - $NOW;#d#
		3343
		3344	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3345	$sig->send;
		3346	}
		3347	while (my $sig = shift @WAIT_FOR_TICK) {
		3348	$sig->send;
		3349	}
		3350
		3351	$NOW = Event::time;
2489		3352
2490	# if we are delayed by four ticks or more, skip them all	3353	# if we are delayed by four ticks or more, skip them all
2491	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3354	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2492		3355
2493	$TICK_WATCHER->at ($NEXT_TICK);	3356	$TICK_WATCHER->at ($NEXT_TICK);
2494	$TICK_WATCHER->start;	3357	$TICK_WATCHER->start;
		3358
		3359	$LOAD = ($NOW - $tick_start) / $TICK;
		3360	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3361
		3362	_post_tick;
		3363
		3364
2495	},	3365	},
2496	);	3366	);
2497		3367
		3368	{
		3369	BDB::max_poll_time $TICK * 0.1;
		3370	$BDB_POLL_WATCHER = Event->io (
		3371	reentrant => 0,
		3372	fd => BDB::poll_fileno,
		3373	poll => 'r',
		3374	prio => 0,
		3375	data => WF_AUTOCANCEL,
		3376	cb => \&BDB::poll_cb,
		3377	);
		3378	BDB::min_parallel 8;
		3379
		3380	BDB::set_sync_prepare {
		3381	my $status;
		3382	my $current = $Coro::current;
		3383	(
		3384	sub {
		3385	$status = $!;
		3386	$current->ready; undef $current;
		3387	},
		3388	sub {
		3389	Coro::schedule while defined $current;
		3390	$! = $status;
		3391	},
		3392	)
		3393	};
		3394
		3395	unless ($DB_ENV) {
		3396	$DB_ENV = BDB::db_env_create;
		3397
		3398	cf::sync_job {
		3399	eval {
		3400	BDB::db_env_open
		3401	$DB_ENV,
		3402	$BDBDIR,
		3403	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3404	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3405	0666;
		3406
		3407	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3408
		3409	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3410	$DB_ENV->set_lk_detect;
		3411	};
		3412
		3413	cf::cleanup "db_env_open(db): $@" if $@;
		3414	};
		3415	}
		3416	}
		3417
		3418	{
		3419	IO::AIO::min_parallel 8;
		3420
		3421	undef $Coro::AIO::WATCHER;
2498	IO::AIO::max_poll_time $TICK * 0.2;	3422	IO::AIO::max_poll_time $TICK * 0.1;
2499
2500	$AIO_POLL_WATCHER = Event->io (	3423	$AIO_POLL_WATCHER = Event->io (
2501	fd => IO::AIO::poll_fileno,	3424	reentrant => 0,
2502	poll => 'r',
2503	prio => 5,
2504	data => WF_AUTOCANCEL,
2505	cb => \&IO::AIO::poll_cb,
2506	);
2507
2508	$WRITE_RUNTIME_WATCHER = Event->timer (
2509	data => WF_AUTOCANCEL,	3425	data => WF_AUTOCANCEL,
2510	after => 1,	3426	fd => IO::AIO::poll_fileno,
2511	interval => 10,	3427	poll => 'r',
2512	prio => 6, # keep it lowest so it acts like a watchdog	3428	prio => 6,
2513	cb => Coro::unblock_sub {	3429	cb => \&IO::AIO::poll_cb,
2514	write_runtime	3430	);
2515	or warn "ERROR: unable to write runtime file: $!";	3431	}
		3432
		3433	my $_log_backtrace;
		3434
		3435	sub _log_backtrace {
		3436	my ($msg, @addr) = @_;
		3437
		3438	$msg =~ s/\n//;
		3439
		3440	# limit the # of concurrent backtraces
		3441	if ($_log_backtrace < 2) {
		3442	++$_log_backtrace;
		3443	async {
		3444	my @bt = fork_call {
		3445	@addr = map { sprintf "%x", $_ } @addr;
		3446	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3447	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3448	or die "addr2line: $!";
		3449
		3450	my @funcs;
		3451	my @res = <$fh>;
		3452	chomp for @res;
		3453	while (@res) {
		3454	my ($func, $line) = splice @res, 0, 2, ();
		3455	push @funcs, "[$func] $line";
		3456	}
		3457
		3458	@funcs
		3459	};
		3460
		3461	LOG llevInfo, "[ABT] $msg\n";
		3462	LOG llevInfo, "[ABT] $_\n" for @bt;
		3463	--$_log_backtrace;
		3464	};
		3465	} else {
		3466	LOG llevInfo, "[ABT] $msg\n";
		3467	LOG llevInfo, "[ABT] [suppressed]\n";
2516	},	3468	}
2517	);	3469	}
		3470
		3471	# load additional modules
		3472	use cf::pod;
2518		3473
2519	END { cf::emergency_save }	3474	END { cf::emergency_save }
2520		3475
2521	1	3476	1
2522		3477

Diff Legend

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