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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 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	}
…		…
1018	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1019		1373
1020	$self	1374	$self
1021	}	1375	}
1022		1376
		1377	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1378
		1379	=cut
		1380
		1381	sub send_msg {
		1382	my $ns = shift->ns
		1383	or return;
		1384	$ns->send_msg (@_);
		1385	}
		1386
1023	=item $pl->quit_character	1387	=item $pl->quit_character
1024		1388
1025	Nukes the player without looking back. If logged in, the connection will	1389	Nukes the player without looking back. If logged in, the connection will
1026	be destroyed. May block for a long time.	1390	be destroyed. May block for a long time.
1027		1391
1028	=cut	1392	=cut
1029		1393
1030	sub quit_character {	1394	sub quit_character {
1031	my ($pl) = @_;	1395	my ($pl) = @_;
		1396
		1397	my $name = $pl->ob->name;
1032		1398
1033	$pl->{deny_save} = 1;	1399	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1400	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1401
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1402	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1407	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1408	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1409	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1410	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1411	$pl->destroy;
		1412
		1413	my $prefix = qr<^~\Q$name\E/>;
		1414
		1415	# nuke player maps
		1416	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1417
1046	IO::AIO::aio_rmtree $temp;	1418	IO::AIO::aio_rmtree $temp;
		1419	}
		1420
		1421	=item $pl->kick
		1422
		1423	Kicks a player out of the game. This destroys the connection.
		1424
		1425	=cut
		1426
		1427	sub kick {
		1428	my ($pl, $kicker) = @_;
		1429
		1430	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1431	$pl->killer ("kicked");
		1432	$pl->ns->destroy;
1047	}	1433	}
1048		1434
1049	=item cf::player::list_logins	1435	=item cf::player::list_logins
1050		1436
1051	Returns am arrayref of all valid playernames in the system, can take a	1437	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1438	while and may block, so not sync_job-capable, ever.
1053		1439
1054	=cut	1440	=cut
1055		1441
1056	sub list_logins {	1442	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1443	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1444	or return [];
1059		1445
1060	my @logins;	1446	my @logins;
1061		1447
1062	for my $login (@$dirs) {	1448	for my $login (@$dirs) {
…		…
1079	=cut	1465	=cut
1080		1466
1081	sub maps($) {	1467	sub maps($) {
1082	my ($pl) = @_;	1468	my ($pl) = @_;
1083		1469
		1470	$pl = ref $pl ? $pl->ob->name : $pl;
		1471
1084	my $files = aio_readdir playerdir $pl	1472	my $files = aio_readdir playerdir $pl
1085	or return;	1473	or return;
1086		1474
1087	my @paths;	1475	my @paths;
1088		1476
1089	for (@$files) {	1477	for (@$files) {
1090	utf8::decode $_;	1478	utf8::decode $_;
1091	next if /\.(?:pl|pst)$/;	1479	next if /\.(?:pl|pst)$/;
1092	next unless /^$PATH_SEP/o;	1480	next unless /^$PATH_SEP/o;
1093		1481
1094	push @paths, cf::map::normalise "~" . $pl->ob->name . "/" . $_;	1482	push @paths, cf::map::normalise "~$pl/$_";
1095	}	1483	}
1096		1484
1097	\@paths	1485	\@paths
1098	}	1486	}
1099		1487
		1488	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1489
		1490	Expand crossfire pod fragments into protocol xml.
		1491
		1492	=cut
		1493
		1494	sub expand_cfpod {
		1495	((my $self), (local $_)) = @_;
		1496
		1497	# escape & and <
		1498	s/&/&amp;/g;
		1499	s/(?<![BIUGH])</&lt;/g;
		1500
		1501	# this is buggy, it needs to properly take care of nested <'s
		1502
		1503	1 while
		1504	# replace B<>, I<>, U<> etc.
		1505	s/B<([^\>]*)>/<b>$1<\/b>/
		1506	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1507	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1508	# replace G<male|female> tags
		1509	|| s{G<([^>|]*)\|([^>]*)>}{
		1510	$self->gender ? $2 : $1
		1511	}ge
		1512	# replace H<hint text>
		1513	|| s{H<([^\>]*)>}
		1514	{
		1515	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1516	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1517	"")
		1518	[$self->{hintmode}]
		1519	}ge;
		1520
		1521	# create single paragraphs (very hackish)
		1522	s/(?<=\S)\n(?=\w)/ /g;
		1523
		1524	# compress some whitespace
		1525	s/\s+\n/\n/g; # ws line-ends
		1526	s/\n\n+/\n/g; # double lines
		1527	s/^\n+//; # beginning lines
		1528	s/\n+$//; # ending lines
		1529
		1530	$_
		1531	}
		1532
		1533	sub hintmode {
		1534	$_[0]{hintmode} = $_[1] if @_ > 1;
		1535	$_[0]{hintmode}
		1536	}
		1537
1100	=item $player->ext_reply ($msgid, $msgtype, %msg)	1538	=item $player->ext_reply ($msgid, @msg)
1101		1539
1102	Sends an ext reply to the player.	1540	Sends an ext reply to the player.
1103		1541
1104	=cut	1542	=cut
1105		1543
1106	sub ext_reply($$$%) {	1544	sub ext_reply($$@) {
1107	my ($self, $id, %msg) = @_;	1545	my ($self, $id, @msg) = @_;
1108		1546
1109	$msg{msgid} = $id;	1547	if ($self->ns->extcmd == 2) {
1110		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1111	$self->send ("ext " . cf::to_json \%msg);	1549	} elsif ($self->ns->extcmd == 1) {
		1550	#TODO: version 1, remove
		1551	unshift @msg, msgtype => "reply", msgid => $id;
		1552	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1553	}
1112	}	1554	}
1113		1555
1114	package cf;	1556	=item $player->ext_msg ($type, @msg)
		1557
		1558	Sends an ext event to the client.
		1559
		1560	=cut
		1561
		1562	sub ext_msg($$@) {
		1563	my ($self, $type, @msg) = @_;
		1564
		1565	$self->ns->ext_msg ($type, @msg);
		1566	}
		1567
		1568	=head3 cf::region
		1569
		1570	=over 4
		1571
		1572	=cut
		1573
		1574	package cf::region;
		1575
		1576	=item cf::region::find_by_path $path
		1577
		1578	Tries to decuce the likely region for a map knowing only its path.
		1579
		1580	=cut
		1581
		1582	sub find_by_path($) {
		1583	my ($path) = @_;
		1584
		1585	my ($match, $specificity);
		1586
		1587	for my $region (list) {
		1588	if ($region->{match} && $path =~ $region->{match}) {
		1589	($match, $specificity) = ($region, $region->specificity)
		1590	if $region->specificity > $specificity;
		1591	}
		1592	}
		1593
		1594	$match
		1595	}
1115		1596
1116	=back	1597	=back
1117
1118		1598
1119	=head3 cf::map	1599	=head3 cf::map
1120		1600
1121	=over 4	1601	=over 4
1122		1602
…		…
1177	my ($self, $merge) = @_;	1657	my ($self, $merge) = @_;
1178		1658
1179	# we have to keep some variables in memory intact	1659	# we have to keep some variables in memory intact
1180	local $self->{path};	1660	local $self->{path};
1181	local $self->{load_path};	1661	local $self->{load_path};
1182	local $self->{deny_save};
1183	local $self->{deny_reset};
1184		1662
1185	$self->SUPER::thawer_merge ($merge);	1663	$self->SUPER::thawer_merge ($merge);
1186	}	1664	}
1187		1665
1188	sub normalise {	1666	sub normalise {
…		…
1235	$self->init; # pass $1 etc.	1713	$self->init; # pass $1 etc.
1236	return $self;	1714	return $self;
1237	}	1715	}
1238	}	1716	}
1239		1717
1240	Carp::carp "unable to resolve path '$path' (base '$base').";	1718	Carp::cluck "unable to resolve path '$path' (base '$base').";
1241	()	1719	()
1242	}	1720	}
1243		1721
1244	sub init {	1722	sub init {
1245	my ($self) = @_;	1723	my ($self) = @_;
…		…
1260		1738
1261	# the original (read-only) location	1739	# the original (read-only) location
1262	sub load_path {	1740	sub load_path {
1263	my ($self) = @_;	1741	my ($self) = @_;
1264		1742
1265	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1743	"$MAPDIR/$self->{path}.map"
1266	}	1744	}
1267		1745
1268	# the temporary/swap location	1746	# the temporary/swap location
1269	sub save_path {	1747	sub save_path {
1270	my ($self) = @_;	1748	my ($self) = @_;
1271		1749
1272	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1750	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1273	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1751	"$TMPDIR/$path.map"
1274	}	1752	}
1275		1753
1276	# the unique path, undef == no special unique path	1754	# the unique path, undef == no special unique path
1277	sub uniq_path {	1755	sub uniq_path {
1278	my ($self) = @_;	1756	my ($self) = @_;
1279		1757
1280	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1758	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1281	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1759	"$UNIQUEDIR/$path"
1282	}	1760	}
1283		1761
1284	# and all this just because we cannot iterate over	1762	# and all this just because we cannot iterate over
1285	# all maps in C++...	1763	# all maps in C++...
1286	sub change_all_map_light {	1764	sub change_all_map_light {
…		…
1288		1766
1289	$_->change_map_light ($change)	1767	$_->change_map_light ($change)
1290	for grep $_->outdoor, values %cf::MAP;	1768	for grep $_->outdoor, values %cf::MAP;
1291	}	1769	}
1292		1770
		1771	sub decay_objects {
		1772	my ($self) = @_;
		1773
		1774	return if $self->{deny_reset};
		1775
		1776	$self->do_decay_objects;
		1777	}
		1778
1293	sub unlink_save {	1779	sub unlink_save {
1294	my ($self) = @_;	1780	my ($self) = @_;
1295		1781
1296	utf8::encode (my $save = $self->save_path);	1782	utf8::encode (my $save = $self->save_path);
1297	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1783	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1298	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1784	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1299
1300	#d#TODO remove .map and also nuke
1301	$save =~ s/\.map// or return;#d#
1302	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1303	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1304	}	1785	}
1305		1786
1306	sub load_header_from($) {	1787	sub load_header_from($) {
1307	my ($self, $path) = @_;	1788	my ($self, $path) = @_;
1308		1789
…		…
1358	$self->load_header_orig	1839	$self->load_header_orig
1359	or return;	1840	or return;
1360	$self->prepare_orig;	1841	$self->prepare_orig;
1361	}	1842	}
1362		1843
		1844	$self->{deny_reset} = 1
		1845	if $self->no_reset;
		1846
		1847	$self->default_region (cf::region::find_by_path $self->{path})
		1848	unless $self->default_region;
		1849
1363	1	1850	1
1364	}	1851	}
1365		1852
1366	sub find;	1853	sub find;
1367	sub find {	1854	sub find {
…		…
1379	$map->{last_save} = $cf::RUNTIME;	1866	$map->{last_save} = $cf::RUNTIME;
1380		1867
1381	$map->load_header	1868	$map->load_header
1382	or return;	1869	or return;
1383		1870
1384	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1871	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1385	# doing this can freeze the server in a sync job, obviously	1872	# doing this can freeze the server in a sync job, obviously
1386	#$cf::WAIT_FOR_TICK->wait;	1873	#$cf::WAIT_FOR_TICK->wait;
1387	$map->reset;	1874	$map->reset;
1388	undef $guard;	1875	undef $guard;
1389	return find $path;	1876	return find $path;
…		…
1400	my ($self) = @_;	1887	my ($self) = @_;
1401		1888
1402	local $self->{deny_reset} = 1; # loading can take a long time	1889	local $self->{deny_reset} = 1; # loading can take a long time
1403		1890
1404	my $path = $self->{path};	1891	my $path = $self->{path};
		1892
		1893	{
1405	my $guard = cf::lock_acquire "map_load:$path";	1894	my $guard = cf::lock_acquire "map_load:$path";
1406		1895
1407	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1408		1897
1409	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1410		1899
1411	$self->alloc;	1900	$self->alloc;
1412		1901
1413	$self->pre_load;	1902	$self->pre_load;
1414
1415	$self->_load_objects ($self->{load_path}, 1)
1416	or return;
1417
1418	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1419	if delete $self->{load_original};
1420
1421	if (my $uniq = $self->uniq_path) {
1422	utf8::encode $uniq;
1423	if (aio_open $uniq, O_RDONLY, 0) {
1424	$self->clear_unique_items;
1425	$self->_load_objects ($uniq, 0);
1426	}
1427	}
1428
1429	Coro::cede;
1430
1431	# now do the right thing for maps
1432	$self->link_multipart_objects;
1433
1434	unless ($self->{deny_activate}) {
1435	$self->decay_objects;
1436	$self->fix_auto_apply;
1437	$self->update_buttons;
1438	Coro::cede;	1903	Coro::cede;
1439	$self->set_darkness_map;	1904
		1905	$self->_load_objects ($self->{load_path}, 1)
		1906	or return;
		1907
		1908	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1909	if delete $self->{load_original};
		1910
		1911	if (my $uniq = $self->uniq_path) {
		1912	utf8::encode $uniq;
		1913	if (aio_open $uniq, O_RDONLY, 0) {
		1914	$self->clear_unique_items;
		1915	$self->_load_objects ($uniq, 0);
		1916	}
		1917	}
		1918
		1919	Coro::cede;
		1920	# now do the right thing for maps
		1921	$self->link_multipart_objects;
1440	$self->difficulty ($self->estimate_difficulty)	1922	$self->difficulty ($self->estimate_difficulty)
1441	unless $self->difficulty;	1923	unless $self->difficulty;
1442	Coro::cede;	1924	Coro::cede;
		1925
		1926	unless ($self->{deny_activate}) {
		1927	$self->decay_objects;
		1928	$self->fix_auto_apply;
		1929	$self->update_buttons;
		1930	Coro::cede;
		1931	$self->set_darkness_map;
		1932	Coro::cede;
1443	$self->activate;	1933	$self->activate;
		1934	}
		1935
		1936	$self->{last_save} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938
		1939	$self->in_memory (cf::MAP_IN_MEMORY);
1444	}	1940	}
1445		1941
1446	$self->post_load;	1942	$self->post_load;
1447
1448	$self->in_memory (cf::MAP_IN_MEMORY);
1449	}	1943	}
1450		1944
1451	sub customise_for {	1945	sub customise_for {
1452	my ($self, $ob) = @_;	1946	my ($self, $ob) = @_;
1453		1947
1454	return find "~" . $ob->name . "/" . $self->{path}	1948	return find "~" . $ob->name . "/" . $self->{path}
1455	if $self->per_player;	1949	if $self->per_player;
		1950
		1951	# return find "?party/" . $ob->name . "/" . $self->{path}
		1952	# if $self->per_party;
1456		1953
1457	$self	1954	$self
1458	}	1955	}
1459		1956
1460	# find and load all maps in the 3x3 area around a map	1957	# find and load all maps in the 3x3 area around a map
…		…
1507		2004
1508	undef $MAP_PREFETCH{$path};	2005	undef $MAP_PREFETCH{$path};
1509	$MAP_PREFETCHER ||= cf::async {	2006	$MAP_PREFETCHER ||= cf::async {
1510	while (%MAP_PREFETCH) {	2007	while (%MAP_PREFETCH) {
1511	for my $path (keys %MAP_PREFETCH) {	2008	for my $path (keys %MAP_PREFETCH) {
1512	my $map = find $path	2009	if (my $map = find $path) {
1513	or next;
1514	$map->load;	2010	$map->load;
		2011	}
1515		2012
1516	delete $MAP_PREFETCH{$path};	2013	delete $MAP_PREFETCH{$path};
1517	}	2014	}
1518	}	2015	}
1519	undef $MAP_PREFETCHER;	2016	undef $MAP_PREFETCHER;
…		…
1571		2068
1572	sub reset_at {	2069	sub reset_at {
1573	my ($self) = @_;	2070	my ($self) = @_;
1574		2071
1575	# TODO: safety, remove and allow resettable per-player maps	2072	# TODO: safety, remove and allow resettable per-player maps
1576	return 1e99 if $self->isa ("ext::map_per_player");#d#
1577	return 1e99 if $self->{deny_reset};	2073	return 1e99 if $self->{deny_reset};
1578		2074
1579	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2075	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1580	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2076	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1581		2077
…		…
1592	my ($self) = @_;	2088	my ($self) = @_;
1593		2089
1594	my $lock = cf::lock_acquire "map_data:$self->{path}";	2090	my $lock = cf::lock_acquire "map_data:$self->{path}";
1595		2091
1596	return if $self->players;	2092	return if $self->players;
1597	return if $self->isa ("ext::map_per_player");#d#
1598		2093
1599	warn "resetting map ", $self->path;#d#	2094	warn "resetting map ", $self->path;
		2095
		2096	$self->in_memory (cf::MAP_SWAPPED);
		2097
		2098	# need to save uniques path
		2099	unless ($self->{deny_save}) {
		2100	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2101
		2102	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2103	if $uniq;
		2104	}
1600		2105
1601	delete $cf::MAP{$self->path};	2106	delete $cf::MAP{$self->path};
1602		2107
1603	$self->in_memory (cf::MAP_SWAPPED);
1604	$self->clear;	2108	$self->clear;
1605		2109
1606	$_->clear_links_to ($self) for values %cf::MAP;	2110	$_->clear_links_to ($self) for values %cf::MAP;
1607		2111
1608	$self->unlink_save;	2112	$self->unlink_save;
…		…
1627	$cf::MAP{$self->path} = $self;	2131	$cf::MAP{$self->path} = $self;
1628		2132
1629	$self->reset; # polite request, might not happen	2133	$self->reset; # polite request, might not happen
1630	}	2134	}
1631		2135
		2136	=item $maps = cf::map::tmp_maps
		2137
		2138	Returns an arrayref with all map paths of currently instantiated and saved
		2139	maps. May block.
		2140
		2141	=cut
		2142
		2143	sub tmp_maps() {
		2144	[
		2145	map {
		2146	utf8::decode $_;
		2147	/\.map$/
		2148	? normalise $_
		2149	: ()
		2150	} @{ aio_readdir $TMPDIR or [] }
		2151	]
		2152	}
		2153
		2154	=item $maps = cf::map::random_maps
		2155
		2156	Returns an arrayref with all map paths of currently instantiated and saved
		2157	random maps. May block.
		2158
		2159	=cut
		2160
		2161	sub random_maps() {
		2162	[
		2163	map {
		2164	utf8::decode $_;
		2165	/\.map$/
		2166	? normalise "?random/$_"
		2167	: ()
		2168	} @{ aio_readdir $RANDOMDIR or [] }
		2169	]
		2170	}
		2171
1632	=item cf::map::unique_maps	2172	=item cf::map::unique_maps
1633		2173
1634	Returns an arrayref of paths of all shared maps that have	2174	Returns an arrayref of paths of all shared maps that have
1635	instantiated unique items. May block.	2175	instantiated unique items. May block.
1636		2176
1637	=cut	2177	=cut
1638		2178
1639	sub unique_maps() {	2179	sub unique_maps() {
1640	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2180	[
1641	or return;	2181	map {
1642
1643	my @paths;
1644
1645	for (@$files) {
1646	utf8::decode $_;	2182	utf8::decode $_;
1647	next if /\.pst$/;	2183	/\.map$/
1648	next unless /^$PATH_SEP/o;	2184	? normalise $_
1649		2185	: ()
1650	push @paths, cf::map::normalise $_;	2186	} @{ aio_readdir $UNIQUEDIR or [] }
1651	}	2187	]
1652
1653	\@paths
1654	}	2188	}
1655		2189
1656	package cf;	2190	package cf;
1657		2191
1658	=back	2192	=back
…		…
1704		2238
1705	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1706		2240
1707	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1708	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1709	} else {	2244	} else {
		2245	my $pl = $self->contr;
		2246
		2247	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2248	my $dialog = $pl->{npc_dialog};
		2249	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2250
		2251	} else {
1710	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1711	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1712	}	2255	}
		2256	}
		2257
		2258	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2259
		2260	=cut
		2261
		2262	sub cf::object::send_msg {
		2263	my $pl = shift->contr
		2264	or return;
		2265	$pl->send_msg (@_);
1713	}	2266	}
1714		2267
1715	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1716		2269
1717	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1764	$self->deactivate_recursive;	2317	$self->deactivate_recursive;
1765		2318
1766	return if UNIVERSAL::isa $self->map, "ext::map_link";	2319	return if UNIVERSAL::isa $self->map, "ext::map_link";
1767		2320
1768	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2321	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1769	if $self->map;	2322	if $self->map && $self->map->{path} ne "{link}";
1770		2323
1771	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2324	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1772	}	2325	}
1773		2326
1774	sub cf::object::player::leave_link {	2327	sub cf::object::player::leave_link {
1775	my ($self, $map, $x, $y) = @_;	2328	my ($self, $map, $x, $y) = @_;
		2329
		2330	return unless $self->contr->active;
1776		2331
1777	my $link_pos = delete $self->{_link_pos};	2332	my $link_pos = delete $self->{_link_pos};
1778		2333
1779	unless ($map) {	2334	unless ($map) {
1780	# restore original map position	2335	# restore original map position
…		…
1798	$map->load;	2353	$map->load;
1799	$map->load_diag;	2354	$map->load_diag;
1800		2355
1801	return unless $self->contr->active;	2356	return unless $self->contr->active;
1802	$self->activate_recursive;	2357	$self->activate_recursive;
		2358
		2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1803	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1804	}	2361	}
1805		2362
1806	cf::player->attach (	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1807	on_logout => sub {
1808	my ($pl) = @_;
1809		2364
1810	# abort map switching before logout	2365	Moves the player to the given map-path and coordinates by first freezing
1811	if ($pl->ob->{_link_pos}) {	2366	her, loading and preparing them map, calling the provided $check callback
1812	cf::sync_job {	2367	that has to return the map if sucecssful, and then unfreezes the player on
1813	$pl->ob->leave_link	2368	the new (success) or old (failed) map position. In either case, $done will
1814	};	2369	be called at the end of this process.
1815	}
1816	},
1817	on_login => sub {
1818	my ($pl) = @_;
1819		2370
1820	# try to abort aborted map switching on player login :)
1821	# should happen only on crashes
1822	if ($pl->ob->{_link_pos}) {
1823	$pl->ob->enter_link;
1824	(async {
1825	# we need this sleep as the login has a concurrent enter_exit running
1826	# and this sleep increases chances of the player not ending up in scorn
1827	$pl->ob->reply (undef,
1828	"There was an internal problem at your last logout, "
1829	. "the server will try to bring you to your intended destination in a second.",
1830	cf::NDI_RED);
1831	Coro::Timer::sleep 1;
1832	$pl->ob->leave_link;
1833	})->prio (2);
1834	}
1835	},
1836	);
1837
1838	=item $player_object->goto ($path, $x, $y)
1839
1840	=cut	2371	=cut
		2372
		2373	our $GOTOGEN;
1841		2374
1842	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1843	my ($self, $path, $x, $y) = @_;	2376	my ($self, $path, $x, $y, $check, $done) = @_;
		2377
		2378	# do generation counting so two concurrent goto's will be executed in-order
		2379	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1844		2380
1845	$self->enter_link;	2381	$self->enter_link;
1846		2382
1847	(async {	2383	(async {
1848	my $map = eval {	2384	my $map = eval {
1849	my $map = cf::map::find $path;	2385	my $map = cf::map::find $path;
		2386
		2387	if ($map) {
1850	$map = $map->customise_for ($self) if $map;	2388	$map = $map->customise_for ($self);
		2389	$map = $check->($map) if $check && $map;
		2390	} else {
		2391	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2392	}
		2393
1851	$map	2394	$map
		2395	};
		2396
		2397	if ($@) {
		2398	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2399	LOG llevError | logBacktrace, Carp::longmess $@;
1852	} or	2400	}
1853	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1854		2401
		2402	if ($gen == $self->{_goto_generation}) {
		2403	delete $self->{_goto_generation};
1855	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
		2405	}
		2406
		2407	$done->() if $done;
1856	})->prio (1);	2408	})->prio (1);
1857	}	2409	}
1858		2410
1859	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
1860		2412
…		…
1899		2451
1900	$rmp->{random_seed} ||= $exit->random_seed;	2452	$rmp->{random_seed} ||= $exit->random_seed;
1901		2453
1902	my $data = cf::to_json $rmp;	2454	my $data = cf::to_json $rmp;
1903	my $md5 = Digest::MD5::md5_hex $data;	2455	my $md5 = Digest::MD5::md5_hex $data;
1904	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2456	my $meta = "$RANDOMDIR/$md5.meta";
1905		2457
1906	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2458	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1907	aio_write $fh, 0, (length $data), $data, 0;	2459	aio_write $fh, 0, (length $data), $data, 0;
1908	undef $fh;	2460	undef $fh;
1909	aio_rename "$meta~", $meta;	2461	aio_rename "$meta~", $meta;
…		…
1918		2470
1919	return unless $self->type == cf::PLAYER;	2471	return unless $self->type == cf::PLAYER;
1920		2472
1921	if ($exit->slaying eq "/!") {	2473	if ($exit->slaying eq "/!") {
1922	#TODO: this should de-fi-ni-te-ly not be a sync-job	2474	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2475	# the problem is that $exit might not survive long enough
		2476	# so it needs to be done right now, right here
1923	cf::sync_job { prepare_random_map $exit };	2477	cf::sync_job { prepare_random_map $exit };
1924	}	2478	}
1925		2479
1926	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2480	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1927	my $hp = $exit->stats->hp;	2481	my $hp = $exit->stats->hp;
1928	my $sp = $exit->stats->sp;	2482	my $sp = $exit->stats->sp;
1929		2483
1930	$self->enter_link;	2484	$self->enter_link;
		2485
		2486	# if exit is damned, update players death & WoR home-position
		2487	$self->contr->savebed ($slaying, $hp, $sp)
		2488	if $exit->flag (FLAG_DAMNED);
1931		2489
1932	(async {	2490	(async {
1933	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
1934	unless (eval {	2492	unless (eval {
1935	$self->goto ($slaying, $hp, $sp);	2493	$self->goto ($slaying, $hp, $sp);
1936		2494
1937	1;	2495	1;
1938	}) {	2496	}) {
1939	$self->message ("Something went wrong deep within the crossfire server. "	2497	$self->message ("Something went wrong deep within the crossfire server. "
1940	. "I'll try to bring you back to the map you were before. "	2498	. "I'll try to bring you back to the map you were before. "
1941	. "Please report this to the dungeon master!",	2499	. "Please report this to the dungeon master!",
1942	cf::NDI_UNIQUE | cf::NDI_RED);	2500	cf::NDI_UNIQUE | cf::NDI_RED);
1943		2501
1944	warn "ERROR in enter_exit: $@";	2502	warn "ERROR in enter_exit: $@";
1945	$self->leave_link;	2503	$self->leave_link;
1946	}	2504	}
1947	})->prio (1);	2505	})->prio (1);
…		…
1960		2518
1961	sub cf::client::send_drawinfo {	2519	sub cf::client::send_drawinfo {
1962	my ($self, $text, $flags) = @_;	2520	my ($self, $text, $flags) = @_;
1963		2521
1964	utf8::encode $text;	2522	utf8::encode $text;
1965	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1966	}	2524	}
1967		2525
		2526	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2527
		2528	Send a drawinfo or msg packet to the client, formatting the msg for the
		2529	client if neccessary. C<$type> should be a string identifying the type of
		2530	the message, with C<log> being the default. If C<$color> is negative, suppress
		2531	the message unless the client supports the msg packet.
		2532
		2533	=cut
		2534
		2535	sub cf::client::send_msg {
		2536	my ($self, $channel, $msg, $color, @extra) = @_;
		2537
		2538	$msg = $self->pl->expand_cfpod ($msg);
		2539
		2540	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2541
		2542	if (ref $channel) {
		2543	# send meta info to client, if not yet sent
		2544	unless (exists $self->{channel}{$channel->{id}}) {
		2545	$self->{channel}{$channel->{id}} = $channel;
		2546	$self->ext_msg (channel_info => $channel);
		2547	}
		2548
		2549	$channel = $channel->{id};
		2550	}
		2551
		2552	return unless @extra || length $msg;
		2553
		2554	if ($self->can_msg) {
		2555	# default colour, mask it out
		2556	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2557	if $color & cf::NDI_DEF;
		2558
		2559	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2560	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2561	} else {
		2562	if ($color >= 0) {
		2563	# replace some tags by gcfclient-compatible ones
		2564	for ($msg) {
		2565	1 while
		2566	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2567	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2568	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2569	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2570	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2571	}
		2572
		2573	$color &= cf::NDI_COLOR_MASK;
		2574
		2575	utf8::encode $msg;
		2576
		2577	if (0 && $msg =~ /\[/) {
		2578	# COMMAND/INFO
		2579	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2580	} else {
		2581	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2582	$self->send_packet ("drawinfo $color $msg")
		2583	}
		2584	}
		2585	}
		2586	}
		2587
		2588	=item $client->ext_msg ($type, @msg)
		2589
		2590	Sends an ext event to the client.
		2591
		2592	=cut
		2593
		2594	sub cf::client::ext_msg($$@) {
		2595	my ($self, $type, @msg) = @_;
		2596
		2597	my $extcmd = $self->extcmd;
		2598
		2599	if ($extcmd == 2) {
		2600	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2601	} elsif ($extcmd == 1) { # TODO: remove
		2602	push @msg, msgtype => "event_$type";
		2603	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2604	}
		2605	}
1968		2606
1969	=item $success = $client->query ($flags, "text", \&cb)	2607	=item $success = $client->query ($flags, "text", \&cb)
1970		2608
1971	Queues a query to the client, calling the given callback with	2609	Queues a query to the client, calling the given callback with
1972	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2610	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1973	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2611	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1974		2612
1975	Queries can fail, so check the return code. Or don't, as queries will become	2613	Queries can fail, so check the return code. Or don't, as queries will
1976	reliable at some point in the future.	2614	become reliable at some point in the future.
1977		2615
1978	=cut	2616	=cut
1979		2617
1980	sub cf::client::query {	2618	sub cf::client::query {
1981	my ($self, $flags, $text, $cb) = @_;	2619	my ($self, $flags, $text, $cb) = @_;
…		…
1989	utf8::encode $text;	2627	utf8::encode $text;
1990	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2628	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1991		2629
1992	$self->send_packet ($self->{query_queue}[0][0])	2630	$self->send_packet ($self->{query_queue}[0][0])
1993	if @{ $self->{query_queue} } == 1;	2631	if @{ $self->{query_queue} } == 1;
		2632
		2633	1
1994	}	2634	}
1995		2635
1996	cf::client->attach (	2636	cf::client->attach (
		2637	on_connect => sub {
		2638	my ($ns) = @_;
		2639
		2640	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2641	},
1997	on_reply => sub {	2642	on_reply => sub {
1998	my ($ns, $msg) = @_;	2643	my ($ns, $msg) = @_;
1999		2644
2000	# this weird shuffling is so that direct followup queries	2645	# this weird shuffling is so that direct followup queries
2001	# get handled first	2646	# get handled first
2002	my $queue = delete $ns->{query_queue}	2647	my $queue = delete $ns->{query_queue}
2003	or return; # be conservative, not sure how that can happen, but we saw a crash here	2648	or return; # be conservative, not sure how that can happen, but we saw a crash here
2004		2649
2005	(shift @$queue)->[1]->($msg);	2650	(shift @$queue)->[1]->($msg);
		2651	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2006		2652
2007	push @{ $ns->{query_queue} }, @$queue;	2653	push @{ $ns->{query_queue} }, @$queue;
2008		2654
2009	if (@{ $ns->{query_queue} } == @$queue) {	2655	if (@{ $ns->{query_queue} } == @$queue) {
2010	if (@$queue) {	2656	if (@$queue) {
…		…
2012	} else {	2658	} else {
2013	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2659	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2014	}	2660	}
2015	}	2661	}
2016	},	2662	},
		2663	on_exticmd => sub {
		2664	my ($ns, $buf) = @_;
		2665
		2666	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2667
		2668	if (ref $msg) {
		2669	my ($type, $reply, @payload) =
		2670	"ARRAY" eq ref $msg
		2671	? @$msg
		2672	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2673
		2674	if (my $cb = $EXTICMD{$type}) {
		2675	my @reply = $cb->($ns, @payload);
		2676
		2677	$ns->ext_reply ($reply, @reply)
		2678	if $reply;
		2679	}
		2680	} else {
		2681	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2682	}
		2683
		2684	cf::override;
		2685	},
2017	);	2686	);
2018		2687
2019	=item $client->async (\&cb)	2688	=item $client->async (\&cb)
2020		2689
2021	Create a new coroutine, running the specified callback. The coroutine will	2690	Create a new coroutine, running the specified callback. The coroutine will
…		…
2062	our $safe = new Safe "safe";	2731	our $safe = new Safe "safe";
2063	our $safe_hole = new Safe::Hole;	2732	our $safe_hole = new Safe::Hole;
2064		2733
2065	$SIG{FPE} = 'IGNORE';	2734	$SIG{FPE} = 'IGNORE';
2066		2735
2067	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2736	$safe->permit_only (Opcode::opset qw(
		2737	:base_core :base_mem :base_orig :base_math
		2738	grepstart grepwhile mapstart mapwhile
		2739	sort time
		2740	));
2068		2741
2069	# here we export the classes and methods available to script code	2742	# here we export the classes and methods available to script code
2070		2743
2071	=pod	2744	=pod
2072		2745
2073	The following fucntions and emthods are available within a safe environment:	2746	The following functions and methods are available within a safe environment:
2074		2747
2075	cf::object contr pay_amount pay_player map	2748	cf::object
		2749	contr pay_amount pay_player map x y force_find force_add
		2750	insert remove name archname title slaying race
		2751
2076	cf::object::player player	2752	cf::object::player
2077	cf::player peaceful	2753	player
2078	cf::map trigger	2754
		2755	cf::player
		2756	peaceful
		2757
		2758	cf::map
		2759	trigger
2079		2760
2080	=cut	2761	=cut
2081		2762
2082	for (	2763	for (
2083	["cf::object" => qw(contr pay_amount pay_player map)],	2764	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2765	insert remove inv name archname title slaying race)],
2084	["cf::object::player" => qw(player)],	2766	["cf::object::player" => qw(player)],
2085	["cf::player" => qw(peaceful)],	2767	["cf::player" => qw(peaceful)],
2086	["cf::map" => qw(trigger)],	2768	["cf::map" => qw(trigger)],
2087	) {	2769	) {
2088	no strict 'refs';	2770	no strict 'refs';
…		…
2159	=back	2841	=back
2160		2842
2161	=cut	2843	=cut
2162		2844
2163	#############################################################################	2845	#############################################################################
		2846	# the server's init and main functions
2164		2847
2165	=head2 EXTENSION DATABASE SUPPORT	2848	sub load_facedata($) {
		2849	my ($path) = @_;
2166		2850
2167	Crossfire maintains a very simple database for extension use. It can	2851	warn "loading facedata from $path\n";
2168	currently store anything that can be serialised using Storable, which
2169	excludes objects.
2170		2852
2171	The parameter C<$family> should best start with the name of the extension	2853	my $facedata;
2172	using it, it should be unique.	2854	0 < aio_load $path, $facedata
		2855	or die "$path: $!";
2173		2856
2174	=over 4	2857	$facedata = Coro::Storable::thaw $facedata;
2175		2858
2176	=item $hashref = cf::db_get $family	2859	$facedata->{version} == 2
		2860	or cf::cleanup "$path: version mismatch, cannot proceed.";
2177		2861
2178	Return a hashref for use by the extension C<$family>, which can be
2179	modified. After modifications, you have to call C<cf::db_dirty> or
2180	C<cf::db_sync>.
2181
2182	=item $value = cf::db_get $family => $key
2183
2184	Returns a single value from the database
2185
2186	=item cf::db_put $family => $hashref
2187
2188	Stores the given family hashref into the database. Updates are delayed, if
2189	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2190
2191	=item cf::db_put $family => $key => $value
2192
2193	Stores the given C<$value> in the family hash. Updates are delayed, if you
2194	want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196	=item cf::db_dirty
2197
2198	Marks the database as dirty, to be updated at a later time.
2199
2200	=item cf::db_sync
2201
2202	Immediately write the database to disk I<if it is dirty>.
2203
2204	=cut
2205
2206	our $DB;
2207
2208	{
2209	my $path = cf::localdir . "/database.pst";
2210
2211	sub db_load() {
2212	$DB = stat $path ? Storable::retrieve $path : { };
2213	}	2862	{
		2863	my $faces = $facedata->{faceinfo};
2214		2864
2215	my $pid;	2865	while (my ($face, $info) = each %$faces) {
		2866	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2867	cf::face::set_visibility $idx, $info->{visibility};
		2868	cf::face::set_magicmap $idx, $info->{magicmap};
		2869	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2870	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2216		2871
2217	sub db_save() {	2872	cf::cede_to_tick;
2218	waitpid $pid, 0 if $pid;
2219	if (0 == ($pid = fork)) {
2220	$DB->{_meta}{version} = 1;
2221	Storable::nstore $DB, "$path~";
2222	rename "$path~", $path;
2223	cf::_exit 0 if defined $pid;
2224	}
2225	}
2226
2227	my $dirty;
2228
2229	sub db_sync() {
2230	db_save if $dirty;
2231	undef $dirty;
2232	}
2233
2234	my $idle = Event->idle (
2235	reentrant => 0,
2236	min => 10,
2237	max => 20,
2238	repeat => 0,
2239	data => WF_AUTOCANCEL,
2240	cb => \&db_sync,
2241	);
2242
2243	sub db_dirty() {
2244	$dirty = 1;
2245	$idle->start;
2246	}
2247
2248	sub db_get($;$) {
2249	@_ >= 2
2250	? $DB->{$_[0]}{$_[1]}
2251	: ($DB->{$_[0]} ||= { })
2252	}
2253
2254	sub db_put($$;$) {
2255	if (@_ >= 3) {
2256	$DB->{$_[0]}{$_[1]} = $_[2];
2257	} else {
2258	$DB->{$_[0]} = $_[1];
2259	}
2260	db_dirty;
2261	}
2262
2263	cf::global->attach (
2264	prio => 10000,
2265	on_cleanup => sub {
2266	db_sync;
2267	},	2873	}
2268	);
2269	}
2270		2874
2271	#############################################################################	2875	while (my ($face, $info) = each %$faces) {
2272	# the server's main()	2876	next unless $info->{smooth};
		2877	my $idx = cf::face::find $face
		2878	or next;
		2879	if (my $smooth = cf::face::find $info->{smooth}) {
		2880	cf::face::set_smooth $idx, $smooth;
		2881	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2882	} else {
		2883	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2884	}
		2885
		2886	cf::cede_to_tick;
		2887	}
		2888	}
		2889
		2890	{
		2891	my $anims = $facedata->{animinfo};
		2892
		2893	while (my ($anim, $info) = each %$anims) {
		2894	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2895	cf::cede_to_tick;
		2896	}
		2897
		2898	cf::anim::invalidate_all; # d'oh
		2899	}
		2900
		2901	{
		2902	# TODO: for gcfclient pleasure, we should give resources
		2903	# that gcfclient doesn't grok a >10000 face index.
		2904	my $res = $facedata->{resource};
		2905	my $enc = JSON::XS->new->utf8->canonical;
		2906
		2907	my $soundconf = delete $res->{"res/sound.conf"};
		2908
		2909	while (my ($name, $info) = each %$res) {
		2910	my $meta = $enc->encode ({
		2911	name => $name,
		2912	%{ $info->{meta} || {} },
		2913	});
		2914
		2915	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2916
		2917	if ($info->{type} & 1) {
		2918	# prepend meta info
		2919
		2920	my $data = pack "(w/a*)*", $meta, $info->{data};
		2921	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2922
		2923	cf::face::set_data $idx, 0, $data, $chk;
		2924	} else {
		2925	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2926	}
		2927
		2928	cf::face::set_type $idx, $info->{type};
		2929
		2930	cf::cede_to_tick;
		2931	}
		2932
		2933	if ($soundconf) {
		2934	$soundconf = $enc->decode (delete $soundconf->{data});
		2935
		2936	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2937	my $sound = $soundconf->{compat}[$_]
		2938	or next;
		2939
		2940	my $face = cf::face::find "sound/$sound->[1]";
		2941	cf::sound::set $sound->[0] => $face;
		2942	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2943	}
		2944
		2945	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2946	my $face = cf::face::find "sound/$v";
		2947	cf::sound::set $k => $face;
		2948	}
		2949	}
		2950	}
		2951
		2952	1
		2953	}
		2954
		2955	register_exticmd fx_want => sub {
		2956	my ($ns, $want) = @_;
		2957
		2958	while (my ($k, $v) = each %$want) {
		2959	$ns->fx_want ($k, $v);
		2960	}
		2961	};
		2962
		2963	sub reload_regions {
		2964	load_resource_file "$MAPDIR/regions"
		2965	or die "unable to load regions file\n";
		2966
		2967	for (cf::region::list) {
		2968	$_->{match} = qr/$_->{match}/
		2969	if exists $_->{match};
		2970	}
		2971	}
		2972
		2973	sub reload_facedata {
		2974	load_facedata "$DATADIR/facedata"
		2975	or die "unable to load facedata\n";
		2976	}
		2977
		2978	sub reload_archetypes {
		2979	load_resource_file "$DATADIR/archetypes"
		2980	or die "unable to load archetypes\n";
		2981	#d# NEED to laod twice to resolve forward references
		2982	# this really needs to be done in an extra post-pass
		2983	# (which needs to be synchronous, so solve it differently)
		2984	load_resource_file "$DATADIR/archetypes"
		2985	or die "unable to load archetypes\n";
		2986	}
		2987
		2988	sub reload_treasures {
		2989	load_resource_file "$DATADIR/treasures"
		2990	or die "unable to load treasurelists\n";
		2991	}
		2992
		2993	sub reload_resources {
		2994	warn "reloading resource files...\n";
		2995
		2996	reload_regions;
		2997	reload_facedata;
		2998	#reload_archetypes;#d#
		2999	reload_archetypes;
		3000	reload_treasures;
		3001
		3002	warn "finished reloading resource files\n";
		3003	}
		3004
		3005	sub init {
		3006	reload_resources;
		3007	}
2273		3008
2274	sub cfg_load {	3009	sub cfg_load {
2275	open my $fh, "<:utf8", cf::confdir . "/config"	3010	open my $fh, "<:utf8", "$CONFDIR/config"
2276	or return;	3011	or return;
2277		3012
2278	local $/;	3013	local $/;
2279	*CFG = YAML::Syck::Load <$fh>;	3014	*CFG = YAML::Syck::Load <$fh>;
2280		3015
…		…
2300	Event::one_event;	3035	Event::one_event;
2301	})->prio (Coro::PRIO_MAX);	3036	})->prio (Coro::PRIO_MAX);
2302	};	3037	};
2303		3038
2304	cfg_load;	3039	cfg_load;
2305	db_load;	3040	db_init;
2306	load_extensions;	3041	load_extensions;
2307		3042
2308	$TICK_WATCHER->start;	3043	$TICK_WATCHER->start;
2309	Event::loop;	3044	Event::loop;
2310	}	3045	}
…		…
2325	},	3060	},
2326	);	3061	);
2327	}	3062	}
2328	}	3063	}
2329		3064
		3065	sub write_runtime {
		3066	my $runtime = "$LOCALDIR/runtime";
		3067
		3068	# first touch the runtime file to show we are still running:
		3069	# the fsync below can take a very very long time.
		3070
		3071	IO::AIO::aio_utime $runtime, undef, undef;
		3072
		3073	my $guard = cf::lock_acquire "write_runtime";
		3074
		3075	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3076	or return;
		3077
		3078	my $value = $cf::RUNTIME + 90 + 10;
		3079	# 10 is the runtime save interval, for a monotonic clock
		3080	# 60 allows for the watchdog to kill the server.
		3081
		3082	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3083	and return;
		3084
		3085	# always fsync - this file is important
		3086	aio_fsync $fh
		3087	and return;
		3088
		3089	# touch it again to show we are up-to-date
		3090	aio_utime $fh, undef, undef;
		3091
		3092	close $fh
		3093	or return;
		3094
		3095	aio_rename "$runtime~", $runtime
		3096	and return;
		3097
		3098	warn "runtime file written.\n";
		3099
		3100	1
		3101	}
		3102
2330	sub emergency_save() {	3103	sub emergency_save() {
2331	my $freeze_guard = cf::freeze_mainloop;	3104	my $freeze_guard = cf::freeze_mainloop;
2332		3105
2333	warn "enter emergency perl save\n";	3106	warn "enter emergency perl save\n";
2334		3107
…		…
2349	my $map = $cf::MAP{$path} or next;	3122	my $map = $cf::MAP{$path} or next;
2350	$map->valid or next;	3123	$map->valid or next;
2351	$map->save;	3124	$map->save;
2352	}	3125	}
2353	warn "end emergency map save\n";	3126	warn "end emergency map save\n";
		3127
		3128	warn "begin emergency database checkpoint\n";
		3129	BDB::db_env_txn_checkpoint $DB_ENV;
		3130	warn "end emergency database checkpoint\n";
2354	};	3131	};
2355		3132
2356	warn "leave emergency perl save\n";	3133	warn "leave emergency perl save\n";
2357	}	3134	}
2358		3135
		3136	sub post_cleanup {
		3137	my ($make_core) = @_;
		3138
		3139	warn Carp::longmess "post_cleanup backtrace"
		3140	if $make_core;
		3141	}
		3142
2359	sub reload() {	3143	sub do_reload_perl() {
2360	# can/must only be called in main	3144	# can/must only be called in main
2361	if ($Coro::current != $Coro::main) {	3145	if ($Coro::current != $Coro::main) {
2362	warn "can only reload from main coroutine";	3146	warn "can only reload from main coroutine";
2363	return;	3147	return;
2364	}	3148	}
2365		3149
2366	warn "reloading...";	3150	warn "reloading...";
2367		3151
2368	warn "cancelling server ticker";	3152	warn "entering sync_job";
2369	$TICK_WATCHER->cancel;
2370		3153
		3154	cf::sync_job {
		3155	cf::write_runtime; # external watchdog should not bark
2371	cf::emergency_save;	3156	cf::emergency_save;
		3157	cf::write_runtime; # external watchdog should not bark
2372		3158
2373	eval {	3159	warn "syncing database to disk";
		3160	BDB::db_env_txn_checkpoint $DB_ENV;
		3161
2374	# if anything goes wrong in here, we should simply crash as we already saved	3162	# if anything goes wrong in here, we should simply crash as we already saved
2375
2376	warn "syncing database to disk";
2377	cf::db_sync;
2378		3163
2379	warn "cancelling all WF_AUTOCANCEL watchers";	3164	warn "cancelling all WF_AUTOCANCEL watchers";
2380	for (Event::all_watchers) {	3165	for (Event::all_watchers) {
2381	$_->cancel if $_->data & WF_AUTOCANCEL;	3166	$_->cancel if $_->data & WF_AUTOCANCEL;
2382	}	3167	}
2383		3168
2384	warn "flushing outstanding aio requests";	3169	warn "flushing outstanding aio requests";
2385	for (;;) {	3170	for (;;) {
		3171	BDB::flush;
2386	IO::AIO::flush;	3172	IO::AIO::flush;
2387	Coro::cede;	3173	Coro::cede;
2388	last unless IO::AIO::nreqs;	3174	last unless IO::AIO::nreqs || BDB::nreqs;
2389	warn "iterate...";	3175	warn "iterate...";
2390	}	3176	}
		3177
		3178	++$RELOAD;
2391		3179
2392	warn "cancelling all extension coros";	3180	warn "cancelling all extension coros";
2393	$_->cancel for values %EXT_CORO;	3181	$_->cancel for values %EXT_CORO;
2394	%EXT_CORO = ();	3182	%EXT_CORO = ();
2395		3183
2396	warn "removing commands";	3184	warn "removing commands";
2397	%COMMAND = ();	3185	%COMMAND = ();
2398		3186
2399	warn "removing ext commands";	3187	warn "removing ext/exti commands";
2400	%EXTCMD = ();	3188	%EXTCMD = ();
		3189	%EXTICMD = ();
2401		3190
2402	warn "unloading/nuking all extensions";	3191	warn "unloading/nuking all extensions";
2403	for my $pkg (@EXTS) {	3192	for my $pkg (@EXTS) {
2404	warn "... unloading $pkg";	3193	warn "... unloading $pkg";
2405		3194
…		…
2435	Symbol::delete_package "safe::$_"	3224	Symbol::delete_package "safe::$_"
2436	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3225	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2437		3226
2438	warn "unloading cf.pm \"a bit\"";	3227	warn "unloading cf.pm \"a bit\"";
2439	delete $INC{"cf.pm"};	3228	delete $INC{"cf.pm"};
		3229	delete $INC{"cf/pod.pm"};
2440		3230
2441	# don't, removes xs symbols, too,	3231	# don't, removes xs symbols, too,
2442	# and global variables created in xs	3232	# and global variables created in xs
2443	#Symbol::delete_package __PACKAGE__;	3233	#Symbol::delete_package __PACKAGE__;
2444		3234
…		…
2448	require cf;	3238	require cf;
2449	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3239	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2450		3240
2451	warn "loading config and database again";	3241	warn "loading config and database again";
2452	cf::cfg_load;	3242	cf::cfg_load;
2453	cf::db_load;
2454		3243
2455	warn "loading extensions";	3244	warn "loading extensions";
2456	cf::load_extensions;	3245	cf::load_extensions;
2457		3246
2458	warn "reattaching attachments to objects/players";	3247	warn "reattaching attachments to objects/players";
2459	_global_reattach;	3248	_global_reattach; # objects, sockets
2460	warn "reattaching attachments to maps";	3249	warn "reattaching attachments to maps";
2461	reattach $_ for values %MAP;	3250	reattach $_ for values %MAP;
		3251	warn "reattaching attachments to players";
		3252	reattach $_ for values %PLAYER;
2462		3253
2463	warn "restarting server ticker";	3254	warn "leaving sync_job";
2464		3255
2465	$TICK_WATCHER->start;	3256	1
2466	};	3257	} or do {
2467
2468	if ($@) {
2469	warn $@;	3258	warn $@;
2470	warn "error while reloading, exiting.";	3259	warn "error while reloading, exiting.";
2471	exit 1;	3260	exit 1;
2472	}	3261	};
2473		3262
2474	warn "reloaded";	3263	warn "reloaded";
2475	};	3264	};
2476		3265
2477	our $RELOAD_WATCHER; # used only during reload	3266	our $RELOAD_WATCHER; # used only during reload
2478		3267
		3268	sub reload_perl() {
		3269	# doing reload synchronously and two reloads happen back-to-back,
		3270	# coro crashes during coro_state_free->destroy here.
		3271
		3272	$RELOAD_WATCHER ||= Event->timer (
		3273	reentrant => 0,
		3274	after => 0,
		3275	data => WF_AUTOCANCEL,
		3276	cb => sub {
		3277	do_reload_perl;
		3278	undef $RELOAD_WATCHER;
		3279	},
		3280	);
		3281	}
		3282
2479	register_command "reload" => sub {	3283	register_command "reload" => sub {
2480	my ($who, $arg) = @_;	3284	my ($who, $arg) = @_;
2481		3285
2482	if ($who->flag (FLAG_WIZ)) {	3286	if ($who->flag (FLAG_WIZ)) {
2483	$who->message ("reloading server.");	3287	$who->message ("reloading server.");
2484		3288	async { reload_perl };
2485	# doing reload synchronously and two reloads happen back-to-back,
2486	# coro crashes during coro_state_free->destroy here.
2487
2488	$RELOAD_WATCHER ||= Event->timer (
2489	reentrant => 0,
2490	after => 0,
2491	data => WF_AUTOCANCEL,
2492	cb => sub {
2493	reload;
2494	undef $RELOAD_WATCHER;
2495	},
2496	);
2497	}	3289	}
2498	};	3290	};
2499		3291
2500	unshift @INC, $LIBDIR;	3292	unshift @INC, $LIBDIR;
2501		3293
2502	my $bug_warning = 0;	3294	my $bug_warning = 0;
2503		3295
		3296	our @WAIT_FOR_TICK;
		3297	our @WAIT_FOR_TICK_BEGIN;
		3298
		3299	sub wait_for_tick {
		3300	return unless $TICK_WATCHER->is_active;
		3301	return if $Coro::current == $Coro::main;
		3302
		3303	my $signal = new Coro::Signal;
		3304	push @WAIT_FOR_TICK, $signal;
		3305	$signal->wait;
		3306	}
		3307
		3308	sub wait_for_tick_begin {
		3309	return unless $TICK_WATCHER->is_active;
		3310	return if $Coro::current == $Coro::main;
		3311
		3312	my $signal = new Coro::Signal;
		3313	push @WAIT_FOR_TICK_BEGIN, $signal;
		3314	$signal->wait;
		3315	}
		3316
		3317	my $min = 1e6;#d#
		3318	my $avg = 10;
2504	$TICK_WATCHER = Event->timer (	3319	$TICK_WATCHER = Event->timer (
2505	reentrant => 0,	3320	reentrant => 0,
2506	parked => 1,	3321	parked => 1,
2507	prio => 0,	3322	prio => 0,
2508	at => $NEXT_TICK || $TICK,	3323	at => $NEXT_TICK || $TICK,
…		…
2512	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3327	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2513	unless ++$bug_warning > 10;	3328	unless ++$bug_warning > 10;
2514	return;	3329	return;
2515	}	3330	}
2516		3331
2517	$NOW = Event::time;	3332	$NOW = $tick_start = Event::time;
2518		3333
2519	cf::server_tick; # one server iteration	3334	cf::server_tick; # one server iteration
		3335
		3336	0 && sync_job {#d#
		3337	for(1..10) {
		3338	my $t = Event::time;
		3339	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3340	or die;
		3341
		3342	$map->width (50);
		3343	$map->height (50);
		3344	$map->alloc;
		3345	$map->_load_objects ("/tmp/x.map", 1);
		3346	my $t = Event::time - $t;
		3347
		3348	#next unless $t < 0.0013;#d#
		3349	if ($t < $min) {
		3350	$min = $t;
		3351	}
		3352	$avg = $avg * 0.99 + $t * 0.01;
		3353	}
		3354	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3355	exit 0;
		3356	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3357	};
		3358
2520	$RUNTIME += $TICK;	3359	$RUNTIME += $TICK;
2521	$NEXT_TICK += $TICK;	3360	$NEXT_TICK += $TICK;
2522		3361
2523	$WAIT_FOR_TICK->broadcast;	3362	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2524	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3363	$NEXT_RUNTIME_WRITE = $NOW + 10;
2525		3364	Coro::async_pool {
2526	Event::sweep;	3365	write_runtime
2527	Coro::cede_notself;	3366	or warn "ERROR: unable to write runtime file: $!";
		3367	};
2528		3368	}
		3369
2529	# my $AFTER = Event::time;	3370	# my $AFTER = Event::time;
2530	# warn $AFTER - $NOW;#d#	3371	# warn $AFTER - $NOW;#d#
2531		3372
		3373	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3374	$sig->send;
		3375	}
		3376	while (my $sig = shift @WAIT_FOR_TICK) {
		3377	$sig->send;
		3378	}
		3379
		3380	$NOW = Event::time;
		3381
2532	# if we are delayed by four ticks or more, skip them all	3382	# if we are delayed by four ticks or more, skip them all
2533	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3383	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2534		3384
2535	$TICK_WATCHER->at ($NEXT_TICK);	3385	$TICK_WATCHER->at ($NEXT_TICK);
2536	$TICK_WATCHER->start;	3386	$TICK_WATCHER->start;
		3387
		3388	$LOAD = ($NOW - $tick_start) / $TICK;
		3389	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3390
		3391	_post_tick;
		3392
		3393
2537	},	3394	},
2538	);	3395	);
2539		3396
		3397	{
		3398	BDB::max_poll_time $TICK * 0.1;
		3399	$BDB_POLL_WATCHER = Event->io (
		3400	reentrant => 0,
		3401	fd => BDB::poll_fileno,
		3402	poll => 'r',
		3403	prio => 0,
		3404	data => WF_AUTOCANCEL,
		3405	cb => \&BDB::poll_cb,
		3406	);
		3407	BDB::min_parallel 8;
		3408
		3409	BDB::set_sync_prepare {
		3410	my $status;
		3411	my $current = $Coro::current;
		3412	(
		3413	sub {
		3414	$status = $!;
		3415	$current->ready; undef $current;
		3416	},
		3417	sub {
		3418	Coro::schedule while defined $current;
		3419	$! = $status;
		3420	},
		3421	)
		3422	};
		3423
		3424	unless ($DB_ENV) {
		3425	$DB_ENV = BDB::db_env_create;
		3426
		3427	cf::sync_job {
		3428	eval {
		3429	BDB::db_env_open
		3430	$DB_ENV,
		3431	$BDBDIR,
		3432	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3433	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3434	0666;
		3435
		3436	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3437
		3438	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3439	$DB_ENV->set_lk_detect;
		3440	};
		3441
		3442	cf::cleanup "db_env_open(db): $@" if $@;
		3443	};
		3444	}
		3445	}
		3446
		3447	{
		3448	IO::AIO::min_parallel 8;
		3449
		3450	undef $Coro::AIO::WATCHER;
2540	IO::AIO::max_poll_time $TICK * 0.1;	3451	IO::AIO::max_poll_time $TICK * 0.1;
2541
2542	undef $Coro::AIO::WATCHER;
2543	$AIO_POLL_WATCHER = Event->io (	3452	$AIO_POLL_WATCHER = Event->io (
2544	reentrant => 0,	3453	reentrant => 0,
		3454	data => WF_AUTOCANCEL,
2545	fd => IO::AIO::poll_fileno,	3455	fd => IO::AIO::poll_fileno,
2546	poll => 'r',	3456	poll => 'r',
2547	prio => 6,	3457	prio => 6,
2548	data => WF_AUTOCANCEL,
2549	cb => \&IO::AIO::poll_cb,	3458	cb => \&IO::AIO::poll_cb,
2550	);	3459	);
		3460	}
2551		3461
2552	$WRITE_RUNTIME_WATCHER = Event->timer (	3462	my $_log_backtrace;
2553	reentrant => 0,	3463
2554	data => WF_AUTOCANCEL,	3464	sub _log_backtrace {
2555	after => 1,	3465	my ($msg, @addr) = @_;
2556	interval => 10,	3466
2557	prio => 6, # keep it lowest so it acts like a watchdog	3467	$msg =~ s/\n//;
2558	cb => Coro::unblock_sub {	3468
2559	write_runtime	3469	# limit the # of concurrent backtraces
2560	or warn "ERROR: unable to write runtime file: $!";	3470	if ($_log_backtrace < 2) {
		3471	++$_log_backtrace;
		3472	async {
		3473	my @bt = fork_call {
		3474	@addr = map { sprintf "%x", $_ } @addr;
		3475	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3476	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3477	or die "addr2line: $!";
		3478
		3479	my @funcs;
		3480	my @res = <$fh>;
		3481	chomp for @res;
		3482	while (@res) {
		3483	my ($func, $line) = splice @res, 0, 2, ();
		3484	push @funcs, "[$func] $line";
		3485	}
		3486
		3487	@funcs
		3488	};
		3489
		3490	LOG llevInfo, "[ABT] $msg\n";
		3491	LOG llevInfo, "[ABT] $_\n" for @bt;
		3492	--$_log_backtrace;
		3493	};
		3494	} else {
		3495	LOG llevInfo, "[ABT] $msg\n";
		3496	LOG llevInfo, "[ABT] [suppressed]\n";
2561	},	3497	}
2562	);	3498	}
		3499
		3500	# load additional modules
		3501	use cf::pod;
2563		3502
2564	END { cf::emergency_save }	3503	END { cf::emergency_save }
2565		3504
2566	1	3505	1
2567		3506

Diff Legend

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