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.203 by root, Thu Feb 1 19:40:42 2007 UTC vs.
Revision 1.322 by root, Fri Jul 27 10:10:51 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	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;
87		116
88	sub cf::map::normalise;	117	sub cf::map::normalise;
89		118
…		…
100	=item $cf::RUNTIME	129	=item $cf::RUNTIME
101		130
102	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
103	every server tick.	132	every server tick.
104		133
105	=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
106		137
107	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
108	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.
109		142
110	=item $cf::NOW	143	=item $cf::NOW
111		144
112	The time of the last (current) server tick.	145	The time of the last (current) server tick.
113		146
114	=item $cf::TICK	147	=item $cf::TICK
115		148
116	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.
117		160
118	=item %cf::CFG	161	=item %cf::CFG
119		162
120	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
121	from wherever your confdir points to.	164	from wherever your confdir points to.
122		165
123	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
124		167
125	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
126	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
127	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.
128	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.
129		177
130	=back	178	=back
131		179
132	=cut	180	=cut
133		181
134	BEGIN {	182	BEGIN {
135	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
136	my $msg = join "", @_;	184	my $msg = join "", @_;
137	utf8::encode $msg;
138		185
139	$msg .= "\n"	186	$msg .= "\n"
140	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
141		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
142	LOG llevError, $msg;	192	LOG llevError, $msg;
143	};	193	};
144	}	194	}
145		195
146	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150	@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';
151	@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)
152		203
153	# 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
154	# within the Safe compartment.	205	# within the Safe compartment.
155	for my $pkg (qw(	206	for my $pkg (qw(
156	cf::global cf::attachable	207	cf::global cf::attachable
…		…
164	}	215	}
165		216
166	$Event::DIED = sub {	217	$Event::DIED = sub {
167	warn "error in event callback: @_";	218	warn "error in event callback: @_";
168	};	219	};
		220
		221	#############################################################################
169		222
170	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
171		224
172	=over 4	225	=over 4
173		226
…		…
192	$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;
193	$d	246	$d
194	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
195	}	248	}
196		249
197	use JSON::Syck (); # TODO# replace by JSON::PC once working
198
199	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
200		251
201	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
202		253
203	=cut
204
205	sub from_json($) {
206	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207	JSON::Syck::Load $_[0]
208	}
209
210	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
211		255
212	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
213		257
214	=cut	258	=cut
215		259
216	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
217	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
218	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
219	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
220		264
221	=item cf::lock_wait $string	265	=item cf::lock_wait $string
222		266
223	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
224		268
…		…
230	returned.	274	returned.
231		275
232	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
233	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
234		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
235	=cut	283	=cut
236		284
237	our %LOCK;	285	our %LOCK;
238		286
239	sub lock_wait($) {	287	sub lock_wait($) {
…		…
258	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
259	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
260	}	308	}
261	}	309	}
262		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
		315	}
		316
263	sub freeze_mainloop {	317	sub freeze_mainloop {
264	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
265		319
266	my $guard = Coro::guard {	320	my $guard = Coro::guard {
267	$TICK_WATCHER->start;	321	$TICK_WATCHER->start;
268	$WRITE_RUNTIME_WATCHER->start;
269	};	322	};
270	$WRITE_RUNTIME_WATCHER->stop;
271	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
272	$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;
273	}	381	}
274		382
275	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
276		384
277	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
…		…
282		390
283	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
284		392
285	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
286		394
287	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)
288	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
289	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.
290		399
291	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
292	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
293	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
294	fast or be very important.	403	fast or be very important.
…		…
297		406
298	sub sync_job(&) {	407	sub sync_job(&) {
299	my ($job) = @_;	408	my ($job) = @_;
300		409
301	if ($Coro::current == $Coro::main) {	410	if ($Coro::current == $Coro::main) {
		411	my $time = Event::time;
		412
302	# this is the main coro, too bad, we have to block	413	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	414	# till the operation succeeds, freezing the server :/
304		415
305	# TODO: use suspend/resume instead	416	# TODO: use suspend/resume instead
306	# (but this is cancel-safe)	417	# (but this is cancel-safe)
…		…
317		428
318	while ($busy) {	429	while ($busy) {
319	Coro::cede or Event::one_event;	430	Coro::cede or Event::one_event;
320	}	431	}
321		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
322	wantarray ? @res : $res[0]	440	wantarray ? @res : $res[0]
323	} else {	441	} else {
324	# we are in another coroutine, how wonderful, everything just works	442	# we are in another coroutine, how wonderful, everything just works
325		443
326	$job->()	444	$job->()
…		…
345	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
346		464
347	$coro	465	$coro
348	}	466	}
349		467
350	sub write_runtime {	468	=item fork_call { }, $args
351	my $runtime = cf::localdir . "/runtime";
352		469
353	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	470	Executes the given code block with the given arguments in a seperate
354	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.
355		474
356	my $value = $cf::RUNTIME + 90 + 10;	475	=cut
357	# 10 is the runtime save interval, for a monotonic clock
358	# 60 allows for the watchdog to kill the server.
359		476
360	(aio_write $fh, 0, (length $value), $value, 0) <= 0	477	sub _store_scalar {
361	and return;	478	open my $fh, ">", \my $buf
362		479	or die "fork_call: cannot open fh-to-buf in child : $!";
363	aio_fsync $fh	480	Storable::store_fd $_[0], $fh;
364	and return;
365
366	close $fh	481	close $fh;
367	or return;
368		482
369	aio_rename "$runtime~", $runtime	483	$buf
370	and return;	484	}
371		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;
372	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 });
373	}	655	}
374		656
375	=back	657	=back
376		658
377	=cut	659	=cut
…		…
384	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")
385	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
386		668
387	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>
388	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
389	crossfire+).	671	Crossfire TRT).
390		672
391	=over 4	673	=over 4
392		674
393	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
394		676
…		…
557	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
558		840
559	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
560	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
561	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
562	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563		845
564	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
565	my $pkg = shift @arg;	847	my $pkg = shift @arg;
566		848
567	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
596	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
597	}	879	}
598		880
599	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
600	} else {	882	} else {
601	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
602	}	884	}
603		885
604	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
605	}	887	}
606		888
…		…
608	if (ref $_[0]) {	890	if (ref $_[0]) {
609	_object_attach @_;	891	_object_attach @_;
610	} else {	892	} else {
611	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
612	}	894	}
		895	_recalc_want;
613	};	896	};
614		897
615	# all those should be optimised	898	# all those should be optimised
616	sub cf::attachable::detach {	899	sub cf::attachable::detach {
617	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
620	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
621	reattach ($obj);	904	reattach ($obj);
622	} else {	905	} else {
623	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
624	}	907	}
		908	_recalc_want;
625	};	909	};
626		910
627	sub cf::attachable::attached {	911	sub cf::attachable::attached {
628	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
629		913
…		…
644	";	928	";
645	die if $@;	929	die if $@;
646	}	930	}
647		931
648	our $override;	932	our $override;
649	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?
650		934
651	sub override {	935	sub override {
652	$override = 1;	936	$override = 1;
653	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
654	}	938	}
655		939
656	sub do_invoke {	940	sub do_invoke {
657	my $event = shift;	941	my $event = shift;
658	my $callbacks = shift;	942	my $callbacks = shift;
659		943
660	@invoke_results = ();	944	@INVOKE_RESULTS = ();
661		945
662	local $override;	946	local $override;
663		947
664	for (@$callbacks) {	948	for (@$callbacks) {
665	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
682		966
683	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
684		968
685	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
686	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
687	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
688		972
689	=back	973	=back
690		974
691	=cut	975	=cut
692		976
693	#############################################################################	977	#############################################################################
694	# 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	}
695		990
696	sub reattach {	991	sub reattach {
697	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
698	my ($obj) = @_;	993	my ($obj) = @_;
699		994
…		…
752	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
753		1048
754	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
756	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
758	close $fh;	1053	close $fh;
759		1054
760	if (@$objs) {	1055	if (@$objs) {
761	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) {
762	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
763	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
764	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
765	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
766	close $fh;	1061	close $fh;
767	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
768	}	1063	}
769	} else {	1064	} else {
770	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
776	}	1071	}
777	} else {	1072	} else {
778	aio_unlink $filename;	1073	aio_unlink $filename;
779	aio_unlink "$filename.pst";	1074	aio_unlink "$filename.pst";
780	}	1075	}
781
782	#d##TODO# nuke non .map-files if exist
783	if ($filename =~ s/\.map$//) {
784	aio_unlink $filename;
785	aio_unlink "$filename.pst";
786	}
787	}	1076	}
788	}	1077	}
789		1078
790	sub object_freezer_as_string {	1079	sub object_freezer_as_string {
791	my ($rdata, $objs) = @_;	1080	my ($rdata, $objs) = @_;
…		…
797		1086
798	sub object_thawer_load {	1087	sub object_thawer_load {
799	my ($filename) = @_;	1088	my ($filename) = @_;
800		1089
801	my ($data, $av);	1090	my ($data, $av);
802
803	#d#TODO remove .map if file does not exist
804	aio_stat $filename and $filename =~ s/\.map$//;
805		1091
806	(aio_load $filename, $data) >= 0	1092	(aio_load $filename, $data) >= 0
807	or return;	1093	or return;
808		1094
809	unless (aio_stat "$filename.pst") {	1095	unless (aio_stat "$filename.pst") {
…		…
811	or return;	1097	or return;
812	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
813	}	1099	}
814		1100
815	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
816	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
817	return ($data, $av);	1103	return ($data, $av);
818	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
819		1111
820	#############################################################################	1112	#############################################################################
821	# command handling &c	1113	# command handling &c
822		1114
823	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
836	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
837	}	1129	}
838		1130
839	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
840		1132
841	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.
842		1138
843	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
844	called.	1140	called.
845		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
846	=cut	1153	=cut
847		1154
848	sub register_extcmd {	1155	sub register_extcmd {
849	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
850		1157
851	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
852	}	1165	}
853		1166
854	cf::player->attach (	1167	cf::player->attach (
855	on_command => sub {	1168	on_command => sub {
856	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
865	cf::override;	1178	cf::override;
866	},	1179	},
867	on_extcmd => sub {	1180	on_extcmd => sub {
868	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
869		1182
870	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871		1184
872	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
873	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
874	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
875	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
876	}	1195	if $reply;
877	}	1196	}
878	} else {	1197	} else {
879	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
880	}	1199	}
881		1200
882	cf::override;	1201	cf::override;
883	},	1202	},
884	);	1203	);
885		1204
886	sub load_extension {
887	my ($path) = @_;
888
889	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
890	my $base = $1;
891	my $pkg = $1;
892	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "ext::$pkg";
894
895	warn "... loading '$path' into '$pkg'\n";
896
897	open my $fh, "<:utf8", $path
898	or die "$path: $!";
899
900	my $source =
901	"package $pkg; use strict; use utf8;\n"
902	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })
904	. "\n};\n1";
905
906	unless (eval $source) {
907	my $msg = $@ ? "$path: $@\n"
908	: "extension disabled.\n";
909	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910	warn $@;
911	warn "mandatory extension failed to load, exiting.\n";
912	exit 1;
913	}
914	die $@;
915	}
916
917	push @EXTS, $pkg;
918	}
919
920	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
921	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
922	next unless -r $ext;	1210	next unless -r $path;
923	eval {	1211
924	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;
925	1	1269	}
926	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
927	}	1275	};
928	}	1276	}
929		1277
930	#############################################################################	1278	#############################################################################
931		1279
		1280	=back
		1281
932	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
933		1283
934	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
935		1285
936	=cut	1286	=cut
…		…
948	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
949		1299
950	=cut	1300	=cut
951		1301
952	sub playerdir($) {	1302	sub playerdir($) {
953	cf::localdir	1303	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1305	}
959		1306
960	sub path($) {	1307	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1309
963	(playerdir $login) . "/$login.pl"	1310	(playerdir $login) . "/playerdata"
964	}	1311	}
965		1312
966	sub find_active($) {	1313	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1314	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1315	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1328	my $login = $_[0];
982		1329
983	my $guard = cf::lock_acquire "user_find:$login";	1330	my $guard = cf::lock_acquire "user_find:$login";
984		1331
985	$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
986	my $pl = load_pl path $login	1340	my $pl = load_pl path $login
987	or return;	1341	or return;
988	$cf::PLAYER{$login} = $pl	1342	$cf::PLAYER{$login} = $pl
989	}	1343	}
990	}	1344	}
…		…
1027		1381
1028	=cut	1382	=cut
1029		1383
1030	sub quit_character {	1384	sub quit_character {
1031	my ($pl) = @_;	1385	my ($pl) = @_;
		1386
		1387	my $name = $pl->ob->name;
1032		1388
1033	$pl->{deny_save} = 1;	1389	$pl->{deny_save} = 1;
1034	$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
1035		1391
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1392	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1397	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1398	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1399	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1400	delete $cf::PLAYER{$pl->ob->name};
1045	$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
1046	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;
1047	}	1423	}
1048		1424
1049	=item cf::player::list_logins	1425	=item cf::player::list_logins
1050		1426
1051	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
1052	while and may block, so not sync_job-capable, ever.	1428	while and may block, so not sync_job-capable, ever.
1053		1429
1054	=cut	1430	=cut
1055		1431
1056	sub list_logins {	1432	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1433	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1434	or return [];
1059		1435
1060	my @logins;	1436	my @logins;
1061		1437
1062	for my $login (@$dirs) {	1438	for my $login (@$dirs) {
…		…
1097	}	1473	}
1098		1474
1099	\@paths	1475	\@paths
1100	}	1476	}
1101		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
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1103		1529
1104	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1105		1531
1106	=cut	1532	=cut
1107		1533
1108	sub ext_reply($$$%) {	1534	sub ext_reply($$@) {
1109	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1110		1536
1111	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1112		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1113	$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	}
1114	}	1544	}
1115		1545
1116	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	}
1117		1586
1118	=back	1587	=back
1119
1120		1588
1121	=head3 cf::map	1589	=head3 cf::map
1122		1590
1123	=over 4	1591	=over 4
1124		1592
…		…
1179	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1180		1648
1181	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1182	local $self->{path};	1650	local $self->{path};
1183	local $self->{load_path};	1651	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1652
1187	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1188	}	1654	}
1189		1655
1190	sub normalise {	1656	sub normalise {
…		…
1237	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1238	return $self;	1704	return $self;
1239	}	1705	}
1240	}	1706	}
1241		1707
1242	Carp::carp "unable to resolve path '$path' (base '$base').";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1243	()	1709	()
1244	}	1710	}
1245		1711
1246	sub init {	1712	sub init {
1247	my ($self) = @_;	1713	my ($self) = @_;
…		…
1262		1728
1263	# the original (read-only) location	1729	# the original (read-only) location
1264	sub load_path {	1730	sub load_path {
1265	my ($self) = @_;	1731	my ($self) = @_;
1266		1732
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1733	"$MAPDIR/$self->{path}.map"
1268	}	1734	}
1269		1735
1270	# the temporary/swap location	1736	# the temporary/swap location
1271	sub save_path {	1737	sub save_path {
1272	my ($self) = @_;	1738	my ($self) = @_;
1273		1739
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1740	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1741	"$TMPDIR/$path.map"
1276	}	1742	}
1277		1743
1278	# the unique path, undef == no special unique path	1744	# the unique path, undef == no special unique path
1279	sub uniq_path {	1745	sub uniq_path {
1280	my ($self) = @_;	1746	my ($self) = @_;
1281		1747
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1748	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1749	"$UNIQUEDIR/$path"
1284	}	1750	}
1285		1751
1286	# and all this just because we cannot iterate over	1752	# and all this just because we cannot iterate over
1287	# all maps in C++...	1753	# all maps in C++...
1288	sub change_all_map_light {	1754	sub change_all_map_light {
…		…
1290		1756
1291	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1292	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
1293	}	1759	}
1294		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
		1767	}
		1768
1295	sub unlink_save {	1769	sub unlink_save {
1296	my ($self) = @_;	1770	my ($self) = @_;
1297		1771
1298	utf8::encode (my $save = $self->save_path);	1772	utf8::encode (my $save = $self->save_path);
1299	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1773	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1300	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1774	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1301
1302	#d#TODO remove .map and also nuke
1303	$save =~ s/\.map// or return;#d#
1304	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1305	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1306	}	1775	}
1307		1776
1308	sub load_header_from($) {	1777	sub load_header_from($) {
1309	my ($self, $path) = @_;	1778	my ($self, $path) = @_;
1310		1779
…		…
1360	$self->load_header_orig	1829	$self->load_header_orig
1361	or return;	1830	or return;
1362	$self->prepare_orig;	1831	$self->prepare_orig;
1363	}	1832	}
1364		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
1365	1	1840	1
1366	}	1841	}
1367		1842
1368	sub find;	1843	sub find;
1369	sub find {	1844	sub find {
…		…
1381	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1382		1857
1383	$map->load_header	1858	$map->load_header
1384	or return;	1859	or return;
1385		1860
1386	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1387	# doing this can freeze the server in a sync job, obviously	1862	# doing this can freeze the server in a sync job, obviously
1388	#$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1389	$map->reset;	1864	$map->reset;
1390	undef $guard;	1865	undef $guard;
1391	return find $path;	1866	return find $path;
…		…
1402	my ($self) = @_;	1877	my ($self) = @_;
1403		1878
1404	local $self->{deny_reset} = 1; # loading can take a long time	1879	local $self->{deny_reset} = 1; # loading can take a long time
1405		1880
1406	my $path = $self->{path};	1881	my $path = $self->{path};
		1882
		1883	{
1407	my $guard = cf::lock_acquire "map_load:$path";	1884	my $guard = cf::lock_acquire "map_load:$path";
1408		1885
1409	return if $self->in_memory != cf::MAP_SWAPPED;	1886	return if $self->in_memory != cf::MAP_SWAPPED;
1410		1887
1411	$self->in_memory (cf::MAP_LOADING);	1888	$self->in_memory (cf::MAP_LOADING);
1412		1889
1413	$self->alloc;	1890	$self->alloc;
1414		1891
1415	$self->pre_load;	1892	$self->pre_load;
1416
1417	$self->_load_objects ($self->{load_path}, 1)
1418	or return;
1419
1420	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1421	if delete $self->{load_original};
1422
1423	if (my $uniq = $self->uniq_path) {
1424	utf8::encode $uniq;
1425	if (aio_open $uniq, O_RDONLY, 0) {
1426	$self->clear_unique_items;
1427	$self->_load_objects ($uniq, 0);
1428	}
1429	}
1430
1431	Coro::cede;
1432
1433	# now do the right thing for maps
1434	$self->link_multipart_objects;
1435
1436	unless ($self->{deny_activate}) {
1437	$self->decay_objects;
1438	$self->fix_auto_apply;
1439	$self->update_buttons;
1440	Coro::cede;	1893	Coro::cede;
1441	$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;
1442	$self->difficulty ($self->estimate_difficulty)	1912	$self->difficulty ($self->estimate_difficulty)
1443	unless $self->difficulty;	1913	unless $self->difficulty;
1444	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;
1445	$self->activate;	1923	$self->activate;
		1924	}
		1925
		1926	$self->in_memory (cf::MAP_IN_MEMORY);
1446	}	1927	}
1447		1928
1448	$self->post_load;	1929	$self->post_load;
1449
1450	$self->in_memory (cf::MAP_IN_MEMORY);
1451	}	1930	}
1452		1931
1453	sub customise_for {	1932	sub customise_for {
1454	my ($self, $ob) = @_;	1933	my ($self, $ob) = @_;
1455		1934
1456	return find "~" . $ob->name . "/" . $self->{path}	1935	return find "~" . $ob->name . "/" . $self->{path}
1457	if $self->per_player;	1936	if $self->per_player;
		1937
		1938	# return find "?party/" . $ob->name . "/" . $self->{path}
		1939	# if $self->per_party;
1458		1940
1459	$self	1941	$self
1460	}	1942	}
1461		1943
1462	# find and load all maps in the 3x3 area around a map	1944	# find and load all maps in the 3x3 area around a map
…		…
1509		1991
1510	undef $MAP_PREFETCH{$path};	1992	undef $MAP_PREFETCH{$path};
1511	$MAP_PREFETCHER ||= cf::async {	1993	$MAP_PREFETCHER ||= cf::async {
1512	while (%MAP_PREFETCH) {	1994	while (%MAP_PREFETCH) {
1513	for my $path (keys %MAP_PREFETCH) {	1995	for my $path (keys %MAP_PREFETCH) {
1514	my $map = find $path	1996	if (my $map = find $path) {
1515	or next;
1516	$map->load;	1997	$map->load;
		1998	}
1517		1999
1518	delete $MAP_PREFETCH{$path};	2000	delete $MAP_PREFETCH{$path};
1519	}	2001	}
1520	}	2002	}
1521	undef $MAP_PREFETCHER;	2003	undef $MAP_PREFETCHER;
…		…
1573		2055
1574	sub reset_at {	2056	sub reset_at {
1575	my ($self) = @_;	2057	my ($self) = @_;
1576		2058
1577	# TODO: safety, remove and allow resettable per-player maps	2059	# TODO: safety, remove and allow resettable per-player maps
1578	return 1e99 if $self->isa ("ext::map_per_player");#d#
1579	return 1e99 if $self->{deny_reset};	2060	return 1e99 if $self->{deny_reset};
1580		2061
1581	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2062	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1582	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2063	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1583		2064
…		…
1594	my ($self) = @_;	2075	my ($self) = @_;
1595		2076
1596	my $lock = cf::lock_acquire "map_data:$self->{path}";	2077	my $lock = cf::lock_acquire "map_data:$self->{path}";
1597		2078
1598	return if $self->players;	2079	return if $self->players;
1599	return if $self->isa ("ext::map_per_player");#d#
1600		2080
1601	warn "resetting map ", $self->path;#d#	2081	warn "resetting map ", $self->path;
		2082
		2083	$self->in_memory (cf::MAP_SWAPPED);
		2084
		2085	# need to save uniques path
		2086	unless ($self->{deny_save}) {
		2087	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2088
		2089	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2090	if $uniq;
		2091	}
1602		2092
1603	delete $cf::MAP{$self->path};	2093	delete $cf::MAP{$self->path};
1604		2094
1605	$self->in_memory (cf::MAP_SWAPPED);
1606	$self->clear;	2095	$self->clear;
1607		2096
1608	$_->clear_links_to ($self) for values %cf::MAP;	2097	$_->clear_links_to ($self) for values %cf::MAP;
1609		2098
1610	$self->unlink_save;	2099	$self->unlink_save;
…		…
1629	$cf::MAP{$self->path} = $self;	2118	$cf::MAP{$self->path} = $self;
1630		2119
1631	$self->reset; # polite request, might not happen	2120	$self->reset; # polite request, might not happen
1632	}	2121	}
1633		2122
		2123	=item $maps = cf::map::tmp_maps
		2124
		2125	Returns an arrayref with all map paths of currently instantiated and saved
		2126	maps. May block.
		2127
		2128	=cut
		2129
		2130	sub tmp_maps() {
		2131	[
		2132	map {
		2133	utf8::decode $_;
		2134	/\.map$/
		2135	? normalise $_
		2136	: ()
		2137	} @{ aio_readdir $TMPDIR or [] }
		2138	]
		2139	}
		2140
		2141	=item $maps = cf::map::random_maps
		2142
		2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	random maps. May block.
		2145
		2146	=cut
		2147
		2148	sub random_maps() {
		2149	[
		2150	map {
		2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise "?random/$_"
		2154	: ()
		2155	} @{ aio_readdir $RANDOMDIR or [] }
		2156	]
		2157	}
		2158
1634	=item cf::map::unique_maps	2159	=item cf::map::unique_maps
1635		2160
1636	Returns an arrayref of paths of all shared maps that have	2161	Returns an arrayref of paths of all shared maps that have
1637	instantiated unique items. May block.	2162	instantiated unique items. May block.
1638		2163
1639	=cut	2164	=cut
1640		2165
1641	sub unique_maps() {	2166	sub unique_maps() {
1642	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2167	[
1643	or return;	2168	map {
1644
1645	my @paths;
1646
1647	for (@$files) {
1648	utf8::decode $_;	2169	utf8::decode $_;
1649	next if /\.pst$/;	2170	/\.map$/
1650	next unless /^$PATH_SEP/o;	2171	? normalise $_
1651		2172	: ()
1652	push @paths, cf::map::normalise $_;	2173	} @{ aio_readdir $UNIQUEDIR or [] }
1653	}	2174	]
1654
1655	\@paths
1656	}	2175	}
1657		2176
1658	package cf;	2177	package cf;
1659		2178
1660	=back	2179	=back
…		…
1706		2225
1707	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2226	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1708		2227
1709	if ($self->{record_replies}) {	2228	if ($self->{record_replies}) {
1710	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2229	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2230
1711	} else {	2231	} else {
		2232	my $pl = $self->contr;
		2233
		2234	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2235	my $dialog = $pl->{npc_dialog};
		2236	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2237
		2238	} else {
1712	$msg = $npc->name . " says: $msg" if $npc;	2239	$msg = $npc->name . " says: $msg" if $npc;
1713	$self->message ($msg, $flags);	2240	$self->message ($msg, $flags);
		2241	}
1714	}	2242	}
1715	}	2243	}
1716		2244
1717	=item $player_object->may ("access")	2245	=item $player_object->may ("access")
1718		2246
…		…
1766	$self->deactivate_recursive;	2294	$self->deactivate_recursive;
1767		2295
1768	return if UNIVERSAL::isa $self->map, "ext::map_link";	2296	return if UNIVERSAL::isa $self->map, "ext::map_link";
1769		2297
1770	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2298	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1771	if $self->map;	2299	if $self->map && $self->map->{path} ne "{link}";
1772		2300
1773	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2301	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1774	}	2302	}
1775		2303
1776	sub cf::object::player::leave_link {	2304	sub cf::object::player::leave_link {
1777	my ($self, $map, $x, $y) = @_;	2305	my ($self, $map, $x, $y) = @_;
		2306
		2307	return unless $self->contr->active;
1778		2308
1779	my $link_pos = delete $self->{_link_pos};	2309	my $link_pos = delete $self->{_link_pos};
1780		2310
1781	unless ($map) {	2311	unless ($map) {
1782	# restore original map position	2312	# restore original map position
…		…
1800	$map->load;	2330	$map->load;
1801	$map->load_diag;	2331	$map->load_diag;
1802		2332
1803	return unless $self->contr->active;	2333	return unless $self->contr->active;
1804	$self->activate_recursive;	2334	$self->activate_recursive;
		2335
		2336	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1805	$self->enter_map ($map, $x, $y);	2337	$self->enter_map ($map, $x, $y);
1806	}	2338	}
1807		2339
1808	cf::player->attach (	2340	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1809	on_logout => sub {
1810	my ($pl) = @_;
1811		2341
1812	# abort map switching before logout	2342	Moves the player to the given map-path and coordinates by first freezing
1813	if ($pl->ob->{_link_pos}) {	2343	her, loading and preparing them map, calling the provided $check callback
1814	cf::sync_job {	2344	that has to return the map if sucecssful, and then unfreezes the player on
1815	$pl->ob->leave_link	2345	the new (success) or old (failed) map position. In either case, $done will
1816	};	2346	be called at the end of this process.
1817	}
1818	},
1819	on_login => sub {
1820	my ($pl) = @_;
1821		2347
1822	# try to abort aborted map switching on player login :)
1823	# should happen only on crashes
1824	if ($pl->ob->{_link_pos}) {
1825	$pl->ob->enter_link;
1826	(async {
1827	# we need this sleep as the login has a concurrent enter_exit running
1828	# and this sleep increases chances of the player not ending up in scorn
1829	$pl->ob->reply (undef,
1830	"There was an internal problem at your last logout, "
1831	. "the server will try to bring you to your intended destination in a second.",
1832	cf::NDI_RED);
1833	Coro::Timer::sleep 1;
1834	$pl->ob->leave_link;
1835	})->prio (2);
1836	}
1837	},
1838	);
1839
1840	=item $player_object->goto ($path, $x, $y)
1841
1842	=cut	2348	=cut
		2349
		2350	our $GOTOGEN;
1843		2351
1844	sub cf::object::player::goto {	2352	sub cf::object::player::goto {
1845	my ($self, $path, $x, $y) = @_;	2353	my ($self, $path, $x, $y, $check, $done) = @_;
		2354
		2355	# do generation counting so two concurrent goto's will be executed in-order
		2356	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1846		2357
1847	$self->enter_link;	2358	$self->enter_link;
1848		2359
1849	(async {	2360	(async {
1850	my $map = eval {	2361	my $map = eval {
1851	my $map = cf::map::find $path;	2362	my $map = cf::map::find $path;
		2363
		2364	if ($map) {
1852	$map = $map->customise_for ($self) if $map;	2365	$map = $map->customise_for ($self);
		2366	$map = $check->($map) if $check && $map;
		2367	} else {
		2368	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	}
		2370
1853	$map	2371	$map
		2372	};
		2373
		2374	if ($@) {
		2375	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2376	LOG llevError | logBacktrace, Carp::longmess $@;
1854	} or	2377	}
1855	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1856		2378
		2379	if ($gen == $self->{_goto_generation}) {
		2380	delete $self->{_goto_generation};
1857	$self->leave_link ($map, $x, $y);	2381	$self->leave_link ($map, $x, $y);
		2382	}
		2383
		2384	$done->() if $done;
1858	})->prio (1);	2385	})->prio (1);
1859	}	2386	}
1860		2387
1861	=item $player_object->enter_exit ($exit_object)	2388	=item $player_object->enter_exit ($exit_object)
1862		2389
…		…
1901		2428
1902	$rmp->{random_seed} ||= $exit->random_seed;	2429	$rmp->{random_seed} ||= $exit->random_seed;
1903		2430
1904	my $data = cf::to_json $rmp;	2431	my $data = cf::to_json $rmp;
1905	my $md5 = Digest::MD5::md5_hex $data;	2432	my $md5 = Digest::MD5::md5_hex $data;
1906	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2433	my $meta = "$RANDOMDIR/$md5.meta";
1907		2434
1908	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2435	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1909	aio_write $fh, 0, (length $data), $data, 0;	2436	aio_write $fh, 0, (length $data), $data, 0;
1910	undef $fh;	2437	undef $fh;
1911	aio_rename "$meta~", $meta;	2438	aio_rename "$meta~", $meta;
…		…
1920		2447
1921	return unless $self->type == cf::PLAYER;	2448	return unless $self->type == cf::PLAYER;
1922		2449
1923	if ($exit->slaying eq "/!") {	2450	if ($exit->slaying eq "/!") {
1924	#TODO: this should de-fi-ni-te-ly not be a sync-job	2451	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2452	# the problem is that $exit might not survive long enough
		2453	# so it needs to be done right now, right here
1925	cf::sync_job { prepare_random_map $exit };	2454	cf::sync_job { prepare_random_map $exit };
1926	}	2455	}
1927		2456
1928	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2457	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1929	my $hp = $exit->stats->hp;	2458	my $hp = $exit->stats->hp;
1930	my $sp = $exit->stats->sp;	2459	my $sp = $exit->stats->sp;
1931		2460
1932	$self->enter_link;	2461	$self->enter_link;
		2462
		2463	# if exit is damned, update players death & WoR home-position
		2464	$self->contr->savebed ($slaying, $hp, $sp)
		2465	if $exit->flag (FLAG_DAMNED);
1933		2466
1934	(async {	2467	(async {
1935	$self->deactivate_recursive; # just to be sure	2468	$self->deactivate_recursive; # just to be sure
1936	unless (eval {	2469	unless (eval {
1937	$self->goto ($slaying, $hp, $sp);	2470	$self->goto ($slaying, $hp, $sp);
1938		2471
1939	1;	2472	1;
1940	}) {	2473	}) {
1941	$self->message ("Something went wrong deep within the crossfire server. "	2474	$self->message ("Something went wrong deep within the crossfire server. "
1942	. "I'll try to bring you back to the map you were before. "	2475	. "I'll try to bring you back to the map you were before. "
1943	. "Please report this to the dungeon master!",	2476	. "Please report this to the dungeon master!",
1944	cf::NDI_UNIQUE | cf::NDI_RED);	2477	cf::NDI_UNIQUE | cf::NDI_RED);
1945		2478
1946	warn "ERROR in enter_exit: $@";	2479	warn "ERROR in enter_exit: $@";
1947	$self->leave_link;	2480	$self->leave_link;
1948	}	2481	}
1949	})->prio (1);	2482	})->prio (1);
…		…
1962		2495
1963	sub cf::client::send_drawinfo {	2496	sub cf::client::send_drawinfo {
1964	my ($self, $text, $flags) = @_;	2497	my ($self, $text, $flags) = @_;
1965		2498
1966	utf8::encode $text;	2499	utf8::encode $text;
1967	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2500	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1968	}	2501	}
1969		2502
		2503	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2504
		2505	Send a drawinfo or msg packet to the client, formatting the msg for the
		2506	client if neccessary. C<$type> should be a string identifying the type of
		2507	the message, with C<log> being the default. If C<$color> is negative, suppress
		2508	the message unless the client supports the msg packet.
		2509
		2510	=cut
		2511
		2512	sub cf::client::send_msg {
		2513	my ($self, $channel, $msg, $color, @extra) = @_;
		2514
		2515	$msg = $self->pl->expand_cfpod ($msg);
		2516
		2517	$color &= ~cf::NDI_UNIQUE; # just in case...
		2518
		2519	if (ref $channel) {
		2520	# send meta info to client, if not yet sent
		2521	unless (exists $self->{channel}{$channel->{id}}) {
		2522	$self->{channel}{$channel->{id}} = $channel;
		2523	$self->ext_msg (channel_info => $channel);
		2524	}
		2525
		2526	$channel = $channel->{id};
		2527	}
		2528
		2529	return unless @extra || length $msg;
		2530
		2531	if ($self->can_msg) {
		2532	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2533	} else {
		2534	# replace some tags by gcfclient-compatible ones
		2535	for ($msg) {
		2536	1 while
		2537	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2538	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2539	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2540	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2541	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2542	}
		2543
		2544	if ($color >= 0) {
		2545	if (0 && $msg =~ /\[/) {
		2546	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
		2555	=item $client->ext_msg ($type, @msg)
		2556
		2557	Sends an ext event to the client.
		2558
		2559	=cut
		2560
		2561	sub cf::client::ext_msg($$@) {
		2562	my ($self, $type, @msg) = @_;
		2563
		2564	my $extcmd = $self->extcmd;
		2565
		2566	if ($extcmd == 2) {
		2567	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2568	} elsif ($extcmd == 1) { # TODO: remove
		2569	push @msg, msgtype => "event_$type";
		2570	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2571	}
		2572	}
1970		2573
1971	=item $success = $client->query ($flags, "text", \&cb)	2574	=item $success = $client->query ($flags, "text", \&cb)
1972		2575
1973	Queues a query to the client, calling the given callback with	2576	Queues a query to the client, calling the given callback with
1974	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1975	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2578	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1976		2579
1977	Queries can fail, so check the return code. Or don't, as queries will become	2580	Queries can fail, so check the return code. Or don't, as queries will
1978	reliable at some point in the future.	2581	become reliable at some point in the future.
1979		2582
1980	=cut	2583	=cut
1981		2584
1982	sub cf::client::query {	2585	sub cf::client::query {
1983	my ($self, $flags, $text, $cb) = @_;	2586	my ($self, $flags, $text, $cb) = @_;
…		…
1991	utf8::encode $text;	2594	utf8::encode $text;
1992	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1993		2596
1994	$self->send_packet ($self->{query_queue}[0][0])	2597	$self->send_packet ($self->{query_queue}[0][0])
1995	if @{ $self->{query_queue} } == 1;	2598	if @{ $self->{query_queue} } == 1;
		2599
		2600	1
1996	}	2601	}
1997		2602
1998	cf::client->attach (	2603	cf::client->attach (
		2604	on_connect => sub {
		2605	my ($ns) = @_;
		2606
		2607	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2608	},
1999	on_reply => sub {	2609	on_reply => sub {
2000	my ($ns, $msg) = @_;	2610	my ($ns, $msg) = @_;
2001		2611
2002	# this weird shuffling is so that direct followup queries	2612	# this weird shuffling is so that direct followup queries
2003	# get handled first	2613	# get handled first
…		…
2015	} else {	2625	} else {
2016	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2626	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2017	}	2627	}
2018	}	2628	}
2019	},	2629	},
		2630	on_exticmd => sub {
		2631	my ($ns, $buf) = @_;
		2632
		2633	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2634
		2635	if (ref $msg) {
		2636	my ($type, $reply, @payload) =
		2637	"ARRAY" eq ref $msg
		2638	? @$msg
		2639	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2640
		2641	if (my $cb = $EXTICMD{$type}) {
		2642	my @reply = $cb->($ns, @payload);
		2643
		2644	$ns->ext_reply ($reply, @reply)
		2645	if $reply;
		2646	}
		2647	} else {
		2648	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2649	}
		2650
		2651	cf::override;
		2652	},
2020	);	2653	);
2021		2654
2022	=item $client->async (\&cb)	2655	=item $client->async (\&cb)
2023		2656
2024	Create a new coroutine, running the specified callback. The coroutine will	2657	Create a new coroutine, running the specified callback. The coroutine will
…		…
2071		2704
2072	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
2073		2706
2074	=pod	2707	=pod
2075		2708
2076	The following fucntions and emthods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2077		2710
2078	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove
		2714
2079	cf::object::player player	2715	cf::object::player
2080	cf::player peaceful	2716	player
2081	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2082		2723
2083	=cut	2724	=cut
2084		2725
2085	for (	2726	for (
2086	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove)],
2087	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2088	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2089	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2090	) {	2732	) {
2091	no strict 'refs';	2733	no strict 'refs';
…		…
2162	=back	2804	=back
2163		2805
2164	=cut	2806	=cut
2165		2807
2166	#############################################################################	2808	#############################################################################
2167
2168	=head2 EXTENSION DATABASE SUPPORT
2169
2170	Crossfire maintains a very simple database for extension use. It can
2171	currently store anything that can be serialised using Storable, which
2172	excludes objects.
2173
2174	The parameter C<$family> should best start with the name of the extension
2175	using it, it should be unique.
2176
2177	=over 4
2178
2179	=item $hashref = cf::db_get $family
2180
2181	Return a hashref for use by the extension C<$family>, which can be
2182	modified. After modifications, you have to call C<cf::db_dirty> or
2183	C<cf::db_sync>.
2184
2185	=item $value = cf::db_get $family => $key
2186
2187	Returns a single value from the database
2188
2189	=item cf::db_put $family => $hashref
2190
2191	Stores the given family hashref into the database. Updates are delayed, if
2192	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2193
2194	=item cf::db_put $family => $key => $value
2195
2196	Stores the given C<$value> in the family hash. Updates are delayed, if you
2197	want the data to be synced to disk immediately, use C<cf::db_sync>.
2198
2199	=item cf::db_dirty
2200
2201	Marks the database as dirty, to be updated at a later time.
2202
2203	=item cf::db_sync
2204
2205	Immediately write the database to disk I<if it is dirty>.
2206
2207	=cut
2208
2209	our $DB;
2210
2211	{
2212	my $path = cf::localdir . "/database.pst";
2213
2214	sub db_load() {
2215	$DB = stat $path ? Storable::retrieve $path : { };
2216	}
2217
2218	my $pid;
2219
2220	sub db_save() {
2221	waitpid $pid, 0 if $pid;
2222	if (0 == ($pid = fork)) {
2223	$DB->{_meta}{version} = 1;
2224	Storable::nstore $DB, "$path~";
2225	rename "$path~", $path;
2226	cf::_exit 0 if defined $pid;
2227	}
2228	}
2229
2230	my $dirty;
2231
2232	sub db_sync() {
2233	db_save if $dirty;
2234	undef $dirty;
2235	}
2236
2237	my $idle = Event->idle (
2238	reentrant => 0,
2239	min => 10,
2240	max => 20,
2241	repeat => 0,
2242	data => WF_AUTOCANCEL,
2243	cb => \&db_sync,
2244	);
2245
2246	sub db_dirty() {
2247	$dirty = 1;
2248	$idle->start;
2249	}
2250
2251	sub db_get($;$) {
2252	@_ >= 2
2253	? $DB->{$_[0]}{$_[1]}
2254	: ($DB->{$_[0]} ||= { })
2255	}
2256
2257	sub db_put($$;$) {
2258	if (@_ >= 3) {
2259	$DB->{$_[0]}{$_[1]} = $_[2];
2260	} else {
2261	$DB->{$_[0]} = $_[1];
2262	}
2263	db_dirty;
2264	}
2265
2266	cf::global->attach (
2267	prio => 10000,
2268	on_cleanup => sub {
2269	db_sync;
2270	},
2271	);
2272	}
2273
2274	#############################################################################
2275	# the server's init and main functions	2809	# the server's init and main functions
2276		2810
2277	sub load_resources {	2811	sub load_facedata($) {
2278	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2812	my ($path) = @_;
		2813
		2814	warn "loading facedata from $path\n";
		2815
		2816	my $facedata;
		2817	0 < aio_load $path, $facedata
		2818	or die "$path: $!";
		2819
		2820	$facedata = Coro::Storable::thaw $facedata;
		2821
		2822	$facedata->{version} == 2
		2823	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2824
		2825	{
		2826	my $faces = $facedata->{faceinfo};
		2827
		2828	while (my ($face, $info) = each %$faces) {
		2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
		2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2834
		2835	cf::cede_to_tick;
		2836	}
		2837
		2838	while (my ($face, $info) = each %$faces) {
		2839	next unless $info->{smooth};
		2840	my $idx = cf::face::find $face
		2841	or next;
		2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
		2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2845	} else {
		2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2847	}
		2848
		2849	cf::cede_to_tick;
		2850	}
		2851	}
		2852
		2853	{
		2854	my $anims = $facedata->{animinfo};
		2855
		2856	while (my ($anim, $info) = each %$anims) {
		2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2858	cf::cede_to_tick;
		2859	}
		2860
		2861	cf::anim::invalidate_all; # d'oh
		2862	}
		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	my $soundconf = delete $res->{"res/sound.conf"};
		2871
		2872	while (my ($name, $info) = each %$res) {
		2873	my $meta = $enc->encode ({
		2874	name => $name,
		2875	%{ $info->{meta} || {} },
		2876	});
		2877
		2878	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2879
		2880	if ($info->{type} & 1) {
		2881	# prepend meta info
		2882
		2883	my $data = pack "(w/a*)*", $meta, $info->{data};
		2884	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2885
		2886	cf::face::set_data $idx, 0, $data, $chk;
		2887	} else {
		2888	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2889	}
		2890
		2891	cf::face::set_type $idx, $info->{type};
		2892
		2893	cf::cede_to_tick;
		2894	}
		2895
		2896	if ($soundconf) {
		2897	$soundconf = $enc->decode (delete $soundconf->{data});
		2898
		2899	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2900	my $sound = $soundconf->{compat}[$_]
		2901	or next;
		2902
		2903	my $face = cf::face::find "sound/$sound->[1]";
		2904
		2905	cf::sound::set $sound->[0] => $face;
		2906	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2907	}
		2908
		2909	#TODO
		2910	}
		2911	}
		2912
		2913	1
		2914	}
		2915
		2916	register_exticmd fx_want => sub {
		2917	my ($ns, $want) = @_;
		2918
		2919	while (my ($k, $v) = each %$want) {
		2920	$ns->fx_want ($k, $v);
		2921	}
		2922	};
		2923
		2924	sub reload_regions {
		2925	load_resource_file "$MAPDIR/regions"
2279	or die "unable to load regions file\n";#d#	2926	or die "unable to load regions file\n";
		2927
		2928	for (cf::region::list) {
		2929	$_->{match} = qr/$_->{match}/
		2930	if exists $_->{match};
		2931	}
		2932	}
		2933
		2934	sub reload_facedata {
		2935	load_facedata "$DATADIR/facedata"
		2936	or die "unable to load facedata\n";
		2937	}
		2938
		2939	sub reload_archetypes {
		2940	load_resource_file "$DATADIR/archetypes"
		2941	or die "unable to load archetypes\n";
		2942	#d# NEED to laod twice to resolve forward references
		2943	# this really needs to be done in an extra post-pass
		2944	# (which needs to be synchronous, so solve it differently)
		2945	load_resource_file "$DATADIR/archetypes"
		2946	or die "unable to load archetypes\n";
		2947	}
		2948
		2949	sub reload_treasures {
		2950	load_resource_file "$DATADIR/treasures"
		2951	or die "unable to load treasurelists\n";
		2952	}
		2953
		2954	sub reload_resources {
		2955	warn "reloading resource files...\n";
		2956
		2957	reload_regions;
		2958	reload_facedata;
		2959	#reload_archetypes;#d#
		2960	reload_archetypes;
		2961	reload_treasures;
		2962
		2963	warn "finished reloading resource files\n";
		2964	}
		2965
		2966	sub init {
		2967	reload_resources;
2280	}	2968	}
2281		2969
2282	sub cfg_load {	2970	sub cfg_load {
2283	open my $fh, "<:utf8", cf::confdir . "/config"	2971	open my $fh, "<:utf8", "$CONFDIR/config"
2284	or return;	2972	or return;
2285		2973
2286	local $/;	2974	local $/;
2287	*CFG = YAML::Syck::Load <$fh>;	2975	*CFG = YAML::Syck::Load <$fh>;
2288		2976
…		…
2296	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2984	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2297	and die "WARNING: m(un)lockall failed: $!\n";	2985	and die "WARNING: m(un)lockall failed: $!\n";
2298	};	2986	};
2299	warn $@ if $@;	2987	warn $@ if $@;
2300	}	2988	}
2301	}
2302
2303	sub init {
2304	load_resources;
2305	}	2989	}
2306		2990
2307	sub main {	2991	sub main {
2308	# we must not ever block the main coroutine	2992	# we must not ever block the main coroutine
2309	local $Coro::idle = sub {	2993	local $Coro::idle = sub {
…		…
2312	Event::one_event;	2996	Event::one_event;
2313	})->prio (Coro::PRIO_MAX);	2997	})->prio (Coro::PRIO_MAX);
2314	};	2998	};
2315		2999
2316	cfg_load;	3000	cfg_load;
2317	db_load;	3001	db_init;
2318	load_extensions;	3002	load_extensions;
2319		3003
2320	$TICK_WATCHER->start;	3004	$TICK_WATCHER->start;
2321	Event::loop;	3005	Event::loop;
2322	}	3006	}
…		…
2337	},	3021	},
2338	);	3022	);
2339	}	3023	}
2340	}	3024	}
2341		3025
		3026	sub write_runtime {
		3027	my $runtime = "$LOCALDIR/runtime";
		3028
		3029	# first touch the runtime file to show we are still running:
		3030	# the fsync below can take a very very long time.
		3031
		3032	IO::AIO::aio_utime $runtime, undef, undef;
		3033
		3034	my $guard = cf::lock_acquire "write_runtime";
		3035
		3036	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3037	or return;
		3038
		3039	my $value = $cf::RUNTIME + 90 + 10;
		3040	# 10 is the runtime save interval, for a monotonic clock
		3041	# 60 allows for the watchdog to kill the server.
		3042
		3043	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3044	and return;
		3045
		3046	# always fsync - this file is important
		3047	aio_fsync $fh
		3048	and return;
		3049
		3050	# touch it again to show we are up-to-date
		3051	aio_utime $fh, undef, undef;
		3052
		3053	close $fh
		3054	or return;
		3055
		3056	aio_rename "$runtime~", $runtime
		3057	and return;
		3058
		3059	warn "runtime file written.\n";
		3060
		3061	1
		3062	}
		3063
2342	sub emergency_save() {	3064	sub emergency_save() {
2343	my $freeze_guard = cf::freeze_mainloop;	3065	my $freeze_guard = cf::freeze_mainloop;
2344		3066
2345	warn "enter emergency perl save\n";	3067	warn "enter emergency perl save\n";
2346		3068
…		…
2361	my $map = $cf::MAP{$path} or next;	3083	my $map = $cf::MAP{$path} or next;
2362	$map->valid or next;	3084	$map->valid or next;
2363	$map->save;	3085	$map->save;
2364	}	3086	}
2365	warn "end emergency map save\n";	3087	warn "end emergency map save\n";
		3088
		3089	warn "begin emergency database checkpoint\n";
		3090	BDB::db_env_txn_checkpoint $DB_ENV;
		3091	warn "end emergency database checkpoint\n";
2366	};	3092	};
2367		3093
2368	warn "leave emergency perl save\n";	3094	warn "leave emergency perl save\n";
2369	}	3095	}
2370		3096
		3097	sub post_cleanup {
		3098	my ($make_core) = @_;
		3099
		3100	warn Carp::longmess "post_cleanup backtrace"
		3101	if $make_core;
		3102	}
		3103
2371	sub reload() {	3104	sub do_reload_perl() {
2372	# can/must only be called in main	3105	# can/must only be called in main
2373	if ($Coro::current != $Coro::main) {	3106	if ($Coro::current != $Coro::main) {
2374	warn "can only reload from main coroutine";	3107	warn "can only reload from main coroutine";
2375	return;	3108	return;
2376	}	3109	}
2377		3110
2378	warn "reloading...";	3111	warn "reloading...";
2379		3112
2380	warn "cancelling server ticker";	3113	warn "entering sync_job";
2381	$TICK_WATCHER->cancel;
2382		3114
		3115	cf::sync_job {
		3116	cf::write_runtime; # external watchdog should not bark
2383	cf::emergency_save;	3117	cf::emergency_save;
		3118	cf::write_runtime; # external watchdog should not bark
2384		3119
2385	eval {	3120	warn "syncing database to disk";
		3121	BDB::db_env_txn_checkpoint $DB_ENV;
		3122
2386	# if anything goes wrong in here, we should simply crash as we already saved	3123	# if anything goes wrong in here, we should simply crash as we already saved
2387
2388	warn "syncing database to disk";
2389	cf::db_sync;
2390		3124
2391	warn "cancelling all WF_AUTOCANCEL watchers";	3125	warn "cancelling all WF_AUTOCANCEL watchers";
2392	for (Event::all_watchers) {	3126	for (Event::all_watchers) {
2393	$_->cancel if $_->data & WF_AUTOCANCEL;	3127	$_->cancel if $_->data & WF_AUTOCANCEL;
2394	}	3128	}
2395		3129
2396	warn "flushing outstanding aio requests";	3130	warn "flushing outstanding aio requests";
2397	for (;;) {	3131	for (;;) {
		3132	BDB::flush;
2398	IO::AIO::flush;	3133	IO::AIO::flush;
2399	Coro::cede;	3134	Coro::cede;
2400	last unless IO::AIO::nreqs;	3135	last unless IO::AIO::nreqs || BDB::nreqs;
2401	warn "iterate...";	3136	warn "iterate...";
2402	}	3137	}
		3138
		3139	++$RELOAD;
2403		3140
2404	warn "cancelling all extension coros";	3141	warn "cancelling all extension coros";
2405	$_->cancel for values %EXT_CORO;	3142	$_->cancel for values %EXT_CORO;
2406	%EXT_CORO = ();	3143	%EXT_CORO = ();
2407		3144
2408	warn "removing commands";	3145	warn "removing commands";
2409	%COMMAND = ();	3146	%COMMAND = ();
2410		3147
2411	warn "removing ext commands";	3148	warn "removing ext/exti commands";
2412	%EXTCMD = ();	3149	%EXTCMD = ();
		3150	%EXTICMD = ();
2413		3151
2414	warn "unloading/nuking all extensions";	3152	warn "unloading/nuking all extensions";
2415	for my $pkg (@EXTS) {	3153	for my $pkg (@EXTS) {
2416	warn "... unloading $pkg";	3154	warn "... unloading $pkg";
2417		3155
…		…
2447	Symbol::delete_package "safe::$_"	3185	Symbol::delete_package "safe::$_"
2448	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3186	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2449		3187
2450	warn "unloading cf.pm \"a bit\"";	3188	warn "unloading cf.pm \"a bit\"";
2451	delete $INC{"cf.pm"};	3189	delete $INC{"cf.pm"};
		3190	delete $INC{"cf/pod.pm"};
2452		3191
2453	# don't, removes xs symbols, too,	3192	# don't, removes xs symbols, too,
2454	# and global variables created in xs	3193	# and global variables created in xs
2455	#Symbol::delete_package __PACKAGE__;	3194	#Symbol::delete_package __PACKAGE__;
2456		3195
…		…
2460	require cf;	3199	require cf;
2461	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3200	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2462		3201
2463	warn "loading config and database again";	3202	warn "loading config and database again";
2464	cf::cfg_load;	3203	cf::cfg_load;
2465	cf::db_load;
2466		3204
2467	warn "loading extensions";	3205	warn "loading extensions";
2468	cf::load_extensions;	3206	cf::load_extensions;
2469		3207
2470	warn "reattaching attachments to objects/players";	3208	warn "reattaching attachments to objects/players";
2471	_global_reattach;	3209	_global_reattach; # objects, sockets
2472	warn "reattaching attachments to maps";	3210	warn "reattaching attachments to maps";
2473	reattach $_ for values %MAP;	3211	reattach $_ for values %MAP;
		3212	warn "reattaching attachments to players";
		3213	reattach $_ for values %PLAYER;
2474		3214
2475	warn "loading reloadable resources";	3215	warn "leaving sync_job";
2476	load_resources;
2477		3216
2478	warn "restarting server ticker";	3217	1
2479		3218	} or do {
2480	$TICK_WATCHER->start;
2481	};
2482
2483	if ($@) {
2484	warn $@;	3219	warn $@;
2485	warn "error while reloading, exiting.";	3220	warn "error while reloading, exiting.";
2486	exit 1;	3221	exit 1;
2487	}	3222	};
2488		3223
2489	warn "reloaded";	3224	warn "reloaded";
2490	};	3225	};
2491		3226
2492	our $RELOAD_WATCHER; # used only during reload	3227	our $RELOAD_WATCHER; # used only during reload
2493		3228
		3229	sub reload_perl() {
		3230	# doing reload synchronously and two reloads happen back-to-back,
		3231	# coro crashes during coro_state_free->destroy here.
		3232
		3233	$RELOAD_WATCHER ||= Event->timer (
		3234	reentrant => 0,
		3235	after => 0,
		3236	data => WF_AUTOCANCEL,
		3237	cb => sub {
		3238	do_reload_perl;
		3239	undef $RELOAD_WATCHER;
		3240	},
		3241	);
		3242	}
		3243
2494	register_command "reload" => sub {	3244	register_command "reload" => sub {
2495	my ($who, $arg) = @_;	3245	my ($who, $arg) = @_;
2496		3246
2497	if ($who->flag (FLAG_WIZ)) {	3247	if ($who->flag (FLAG_WIZ)) {
2498	$who->message ("reloading server.");	3248	$who->message ("reloading server.");
2499		3249	async { reload_perl };
2500	# doing reload synchronously and two reloads happen back-to-back,
2501	# coro crashes during coro_state_free->destroy here.
2502
2503	$RELOAD_WATCHER ||= Event->timer (
2504	reentrant => 0,
2505	after => 0,
2506	data => WF_AUTOCANCEL,
2507	cb => sub {
2508	reload;
2509	undef $RELOAD_WATCHER;
2510	},
2511	);
2512	}	3250	}
2513	};	3251	};
2514		3252
2515	unshift @INC, $LIBDIR;	3253	unshift @INC, $LIBDIR;
2516		3254
2517	my $bug_warning = 0;	3255	my $bug_warning = 0;
2518		3256
		3257	our @WAIT_FOR_TICK;
		3258	our @WAIT_FOR_TICK_BEGIN;
		3259
		3260	sub wait_for_tick {
		3261	return unless $TICK_WATCHER->is_active;
		3262	return if $Coro::current == $Coro::main;
		3263
		3264	my $signal = new Coro::Signal;
		3265	push @WAIT_FOR_TICK, $signal;
		3266	$signal->wait;
		3267	}
		3268
		3269	sub wait_for_tick_begin {
		3270	return unless $TICK_WATCHER->is_active;
		3271	return if $Coro::current == $Coro::main;
		3272
		3273	my $signal = new Coro::Signal;
		3274	push @WAIT_FOR_TICK_BEGIN, $signal;
		3275	$signal->wait;
		3276	}
		3277
		3278	my $min = 1e6;#d#
		3279	my $avg = 10;
2519	$TICK_WATCHER = Event->timer (	3280	$TICK_WATCHER = Event->timer (
2520	reentrant => 0,	3281	reentrant => 0,
2521	parked => 1,	3282	parked => 1,
2522	prio => 0,	3283	prio => 0,
2523	at => $NEXT_TICK || $TICK,	3284	at => $NEXT_TICK || $TICK,
…		…
2527	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3288	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2528	unless ++$bug_warning > 10;	3289	unless ++$bug_warning > 10;
2529	return;	3290	return;
2530	}	3291	}
2531		3292
2532	$NOW = Event::time;	3293	$NOW = $tick_start = Event::time;
2533		3294
2534	cf::server_tick; # one server iteration	3295	cf::server_tick; # one server iteration
		3296
		3297	0 && sync_job {#d#
		3298	for(1..10) {
		3299	my $t = Event::time;
		3300	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3301	or die;
		3302
		3303	$map->width (50);
		3304	$map->height (50);
		3305	$map->alloc;
		3306	$map->_load_objects ("/tmp/x.map", 1);
		3307	my $t = Event::time - $t;
		3308
		3309	#next unless $t < 0.0013;#d#
		3310	if ($t < $min) {
		3311	$min = $t;
		3312	}
		3313	$avg = $avg * 0.99 + $t * 0.01;
		3314	}
		3315	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3316	exit 0;
		3317	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3318	};
		3319
2535	$RUNTIME += $TICK;	3320	$RUNTIME += $TICK;
2536	$NEXT_TICK += $TICK;	3321	$NEXT_TICK += $TICK;
2537		3322
2538	$WAIT_FOR_TICK->broadcast;	3323	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2539	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3324	$NEXT_RUNTIME_WRITE = $NOW + 10;
2540		3325	Coro::async_pool {
2541	Event::sweep;	3326	write_runtime
2542	Coro::cede_notself;	3327	or warn "ERROR: unable to write runtime file: $!";
		3328	};
2543		3329	}
		3330
2544	# my $AFTER = Event::time;	3331	# my $AFTER = Event::time;
2545	# warn $AFTER - $NOW;#d#	3332	# warn $AFTER - $NOW;#d#
2546		3333
		3334	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3335	$sig->send;
		3336	}
		3337	while (my $sig = shift @WAIT_FOR_TICK) {
		3338	$sig->send;
		3339	}
		3340
		3341	$NOW = Event::time;
		3342
2547	# if we are delayed by four ticks or more, skip them all	3343	# if we are delayed by four ticks or more, skip them all
2548	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3344	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2549		3345
2550	$TICK_WATCHER->at ($NEXT_TICK);	3346	$TICK_WATCHER->at ($NEXT_TICK);
2551	$TICK_WATCHER->start;	3347	$TICK_WATCHER->start;
		3348
		3349	$LOAD = ($NOW - $tick_start) / $TICK;
		3350	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3351
		3352	_post_tick;
		3353
		3354
2552	},	3355	},
2553	);	3356	);
2554		3357
		3358	{
		3359	BDB::max_poll_time $TICK * 0.1;
		3360	$BDB_POLL_WATCHER = Event->io (
		3361	reentrant => 0,
		3362	fd => BDB::poll_fileno,
		3363	poll => 'r',
		3364	prio => 0,
		3365	data => WF_AUTOCANCEL,
		3366	cb => \&BDB::poll_cb,
		3367	);
		3368	BDB::min_parallel 8;
		3369
		3370	BDB::set_sync_prepare {
		3371	my $status;
		3372	my $current = $Coro::current;
		3373	(
		3374	sub {
		3375	$status = $!;
		3376	$current->ready; undef $current;
		3377	},
		3378	sub {
		3379	Coro::schedule while defined $current;
		3380	$! = $status;
		3381	},
		3382	)
		3383	};
		3384
		3385	unless ($DB_ENV) {
		3386	$DB_ENV = BDB::db_env_create;
		3387
		3388	cf::sync_job {
		3389	eval {
		3390	BDB::db_env_open
		3391	$DB_ENV,
		3392	$BDBDIR,
		3393	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3394	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3395	0666;
		3396
		3397	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3398
		3399	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3400	$DB_ENV->set_lk_detect;
		3401	};
		3402
		3403	cf::cleanup "db_env_open(db): $@" if $@;
		3404	};
		3405	}
		3406	}
		3407
		3408	{
		3409	IO::AIO::min_parallel 8;
		3410
		3411	undef $Coro::AIO::WATCHER;
2555	IO::AIO::max_poll_time $TICK * 0.1;	3412	IO::AIO::max_poll_time $TICK * 0.1;
2556
2557	undef $Coro::AIO::WATCHER;
2558	$AIO_POLL_WATCHER = Event->io (	3413	$AIO_POLL_WATCHER = Event->io (
2559	reentrant => 0,	3414	reentrant => 0,
		3415	data => WF_AUTOCANCEL,
2560	fd => IO::AIO::poll_fileno,	3416	fd => IO::AIO::poll_fileno,
2561	poll => 'r',	3417	poll => 'r',
2562	prio => 6,	3418	prio => 6,
2563	data => WF_AUTOCANCEL,
2564	cb => \&IO::AIO::poll_cb,	3419	cb => \&IO::AIO::poll_cb,
2565	);	3420	);
		3421	}
2566		3422
2567	$WRITE_RUNTIME_WATCHER = Event->timer (	3423	my $_log_backtrace;
2568	reentrant => 0,	3424
2569	data => WF_AUTOCANCEL,	3425	sub _log_backtrace {
2570	after => 1,	3426	my ($msg, @addr) = @_;
2571	interval => 10,	3427
2572	prio => 6, # keep it lowest so it acts like a watchdog	3428	$msg =~ s/\n//;
2573	cb => Coro::unblock_sub {	3429
2574	write_runtime	3430	# limit the # of concurrent backtraces
2575	or warn "ERROR: unable to write runtime file: $!";	3431	if ($_log_backtrace < 2) {
		3432	++$_log_backtrace;
		3433	async {
		3434	my @bt = fork_call {
		3435	@addr = map { sprintf "%x", $_ } @addr;
		3436	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3437	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3438	or die "addr2line: $!";
		3439
		3440	my @funcs;
		3441	my @res = <$fh>;
		3442	chomp for @res;
		3443	while (@res) {
		3444	my ($func, $line) = splice @res, 0, 2, ();
		3445	push @funcs, "[$func] $line";
		3446	}
		3447
		3448	@funcs
		3449	};
		3450
		3451	LOG llevInfo, "[ABT] $msg\n";
		3452	LOG llevInfo, "[ABT] $_\n" for @bt;
		3453	--$_log_backtrace;
		3454	};
		3455	} else {
		3456	LOG llevInfo, "[ABT] $msg\n";
		3457	LOG llevInfo, "[ABT] [suppressed]\n";
2576	},	3458	}
2577	);	3459	}
		3460
		3461	# load additional modules
		3462	use cf::pod;
2578		3463
2579	END { cf::emergency_save }	3464	END { cf::emergency_save }
2580		3465
2581	1	3466	1
2582		3467

Diff Legend

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