ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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