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.198 by root, Sun Jan 28 01:58:37 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use JSON::XS 1.4 ();
		26	use BDB ();
20	use Data::Dumper;	27	use Data::Dumper;
21	use Digest::MD5;	28	use Digest::MD5;
22	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
23	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	32	use Time::HiRes;
		33	use Compress::LZF;
		34	use Digest::MD5 ();
26		35
		36	# configure various modules to our taste
		37	#
		38	$Storable::canonical = 1; # reduce rsync transfers
		39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		40	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		41
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	42	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		43
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
33		46
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
36	our %COMMAND = ();	51	our %COMMAND = ();
37	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
38		53
39	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
43		59
		60	our $RELOAD; # number of reloads so far
44	our @EVENT;	61	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		62
47	our $TICK = MAX_TIME * 1e-6;	63	our $CONFDIR = confdir;
		64	our $DATADIR = datadir;
		65	our $LIBDIR = "$DATADIR/ext";
		66	our $PODDIR = "$DATADIR/pod";
		67	our $MAPDIR = "$DATADIR/" . mapdir;
		68	our $LOCALDIR = localdir;
		69	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		70	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		71	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		72	our $RANDOMDIR = "$LOCALDIR/random";
		73	our $BDBDIR = "$LOCALDIR/db";
		74
		75	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	76	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	79	our $NEXT_TICK;
52	our $NOW;	80	our $NOW;
		81	our $USE_FSYNC = 1; # use fsync to write maps - default off
		82
		83	our $BDB_POLL_WATCHER;
		84	our $DB_ENV;
53		85
54	our %CFG;	86	our %CFG;
55		87
56	our $UPTIME; $UPTIME ||= time;	88	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	89	our $RUNTIME;
58		90
59	our %PLAYER; # all users	91	our %PLAYER; # all users
60	our %MAP; # all maps	92	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	93	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		94
67	# used to convert map paths into valid unix filenames by replacing / by ∕	95	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		97
		98	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		99	our $LOADAVG; # same thing, but with alpha-smoothing
		100	our $tick_start; # for load detecting purposes
		101
70	binmode STDOUT;	102	binmode STDOUT;
71	binmode STDERR;	103	binmode STDERR;
72		104
73	# read virtual server time, if available	105	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
78	}	110	}
79		111
80	mkdir cf::localdir;	112	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		114
86	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
		116
		117	sub cf::map::normalise;
87		118
88	#############################################################################	119	#############################################################################
89		120
90	=head2 GLOBAL VARIABLES	121	=head2 GLOBAL VARIABLES
91		122
…		…
98	=item $cf::RUNTIME	129	=item $cf::RUNTIME
99		130
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	131	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	132	every server tick.
102		133
103	=item $cf::LIBDIR	134	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		135	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		136	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		137
105	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	139	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		140	unique-items directory, player file directory, random maps directory and
		141	database environment.
107		142
108	=item $cf::NOW	143	=item $cf::NOW
109		144
110	The time of the last (current) server tick.	145	The time of the last (current) server tick.
111		146
112	=item $cf::TICK	147	=item $cf::TICK
113		148
114	The interval between server ticks, in seconds.	149	The interval between server ticks, in seconds.
		150
		151	=item $cf::LOADAVG
		152
		153	The current CPU load on the server (alpha-smoothed), as a value between 0
		154	(none) and 1 (overloaded), indicating how much time is spent on processing
		155	objects per tick. Healthy values are < 0.5.
		156
		157	=item $cf::LOAD
		158
		159	The raw value load value from the last tick.
115		160
116	=item %cf::CFG	161	=item %cf::CFG
117		162
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	164	from wherever your confdir points to.
120		165
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		167
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	169	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
127		177
128	=back	178	=back
129		179
130	=cut	180	=cut
131		181
132	BEGIN {	182	BEGIN {
133	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	184	my $msg = join "", @_;
135	utf8::encode $msg;
136		185
137	$msg .= "\n"	186	$msg .= "\n"
138	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
139		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
140	LOG llevError, $msg;	192	LOG llevError, $msg;
141	};	193	};
142	}	194	}
143		195
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		203
151	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	205	# within the Safe compartment.
153	for my $pkg (qw(	206	for my $pkg (qw(
154	cf::global cf::attachable	207	cf::global cf::attachable
…		…
162	}	215	}
163		216
164	$Event::DIED = sub {	217	$Event::DIED = sub {
165	warn "error in event callback: @_";	218	warn "error in event callback: @_";
166	};	219	};
		220
		221	#############################################################################
167		222
168	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
169		224
170	=over 4	225	=over 4
171		226
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	246	$d
192	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
193	}	248	}
194		249
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
198		251
199	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
200		253
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
209		255
210	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
211		257
212	=cut	258	=cut
213		259
214	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
216	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
218		264
219	=item cf::lock_wait $string	265	=item cf::lock_wait $string
220		266
221	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
222		268
…		…
228	returned.	274	returned.
229		275
230	Lock names should begin with a unique identifier (for example, cf::map::find	276	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
232		278
		279	=item $locked = cf::lock_active $string
		280
		281	Return true if the lock is currently active, i.e. somebody has locked it.
		282
233	=cut	283	=cut
234		284
235	our %LOCK;	285	our %LOCK;
236		286
237	sub lock_wait($) {	287	sub lock_wait($) {
…		…
256	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
258	}	308	}
259	}	309	}
260		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
		315	}
		316
261	sub freeze_mainloop {	317	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
263		319
264	my $guard = Coro::guard {	320	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	321	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	322	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
270	$guard	324	$guard
		325	}
		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
271	}	381	}
272		382
273	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
274		384
275	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		390
281	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
282		392
283	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
284		394
285	The design of crossfire+ requires that the main coro ($Coro::main) is	395	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	396	is always able to handle events or runnable, as Crossfire TRT is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
288		399
289	If it must be done, put the blocking parts into C<sync_job>. This will run	400	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	401	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	402	server will be frozen during this time, so the block should either finish
292	fast or be very important.	403	fast or be very important.
…		…
295		406
296	sub sync_job(&) {	407	sub sync_job(&) {
297	my ($job) = @_;	408	my ($job) = @_;
298		409
299	if ($Coro::current == $Coro::main) {	410	if ($Coro::current == $Coro::main) {
		411	my $time = Event::time;
		412
300	# this is the main coro, too bad, we have to block	413	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	414	# till the operation succeeds, freezing the server :/
302		415
303	# TODO: use suspend/resume instead	416	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	417	# (but this is cancel-safe)
…		…
315		428
316	while ($busy) {	429	while ($busy) {
317	Coro::cede or Event::one_event;	430	Coro::cede or Event::one_event;
318	}	431	}
319		432
		433	$time = Event::time - $time;
		434
		435	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		436	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		437
		438	$tick_start += $time; # do not account sync jobs to server load
		439
320	wantarray ? @res : $res[0]	440	wantarray ? @res : $res[0]
321	} else {	441	} else {
322	# we are in another coroutine, how wonderful, everything just works	442	# we are in another coroutine, how wonderful, everything just works
323		443
324	$job->()	444	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
344		464
345	$coro	465	$coro
346	}	466	}
347		467
348	sub write_runtime {	468	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		469
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	470	Executes the given code block with the given arguments in a seperate
352	or return;	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
353		474
354	my $value = $cf::RUNTIME + 90 + 10;	475	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		476
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	477	sub _store_scalar {
359	and return;	478	open my $fh, ">", \my $buf
360		479	or die "fork_call: cannot open fh-to-buf in child : $!";
361	aio_fsync $fh	480	Storable::store_fd $_[0], $fh;
362	and return;
363
364	close $fh	481	close $fh;
365	or return;
366		482
367	aio_rename "$runtime~", $runtime	483	$buf
368	and return;	484	}
369		485
		486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
370	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
		644	}
		645
		646	=item cf::datalog type => key => value, ...
		647
		648	Log a datalog packet of the given type with the given key-value pairs.
		649
		650	=cut
		651
		652	sub datalog($@) {
		653	my ($type, %kv) = @_;
		654	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
371	}	655	}
372		656
373	=back	657	=back
374		658
375	=cut	659	=cut
…		…
382	attach callbacks/event handlers (a collection of which is called an "attachment")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
383	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
384		668
385	In the following description, CLASS can be any of C<global>, C<object>	669	In the following description, CLASS can be any of C<global>, C<object>
386	C<player>, C<client> or C<map> (i.e. the attachable objects in	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
387	crossfire+).	671	Crossfire TRT).
388		672
389	=over 4	673	=over 4
390		674
391	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
392		676
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
556		840
557	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		845
562	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	847	my $pkg = shift @arg;
564		848
565	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
595	}	879	}
596		880
597	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
598	} else {	882	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	884	}
601		885
602	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
603	}	887	}
604		888
…		…
606	if (ref $_[0]) {	890	if (ref $_[0]) {
607	_object_attach @_;	891	_object_attach @_;
608	} else {	892	} else {
609	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
610	}	894	}
		895	_recalc_want;
611	};	896	};
612		897
613	# all those should be optimised	898	# all those should be optimised
614	sub cf::attachable::detach {	899	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
619	reattach ($obj);	904	reattach ($obj);
620	} else {	905	} else {
621	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
622	}	907	}
		908	_recalc_want;
623	};	909	};
624		910
625	sub cf::attachable::attached {	911	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
627		913
…		…
642	";	928	";
643	die if $@;	929	die if $@;
644	}	930	}
645		931
646	our $override;	932	our $override;
647	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
648		934
649	sub override {	935	sub override {
650	$override = 1;	936	$override = 1;
651	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
652	}	938	}
653		939
654	sub do_invoke {	940	sub do_invoke {
655	my $event = shift;	941	my $event = shift;
656	my $callbacks = shift;	942	my $callbacks = shift;
657		943
658	@invoke_results = ();	944	@INVOKE_RESULTS = ();
659		945
660	local $override;	946	local $override;
661		947
662	for (@$callbacks) {	948	for (@$callbacks) {
663	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
680		966
681	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
682		968
683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
684	removed in future versions), and there is no public API to access override	970	removed in future versions), and there is no public API to access override
685	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		972
687	=back	973	=back
688		974
689	=cut	975	=cut
690		976
691	#############################################################################	977	#############################################################################
692	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
693		990
694	sub reattach {	991	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	993	my ($obj) = @_;
697		994
…		…
750	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
751		1048
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1053	close $fh;
757		1054
758	if (@$objs) {	1055	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1056	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1061	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
766	}	1063	}
767	} else {	1064	} else {
768	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
800	or return;	1097	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1099	}
803		1100
804	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1103	return ($data, $av);
807	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
808		1111
809	#############################################################################	1112	#############################################################################
810	# command handling &c	1113	# command handling &c
811		1114
812	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1129	}
827		1130
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1132
830	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
831		1138
832	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
833	called.	1140	called.
834		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
835	=cut	1153	=cut
836		1154
837	sub register_extcmd {	1155	sub register_extcmd {
838	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
839		1157
840	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
841	}	1165	}
842		1166
843	cf::player->attach (	1167	cf::player->attach (
844	on_command => sub {	1168	on_command => sub {
845	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1178	cf::override;
855	},	1179	},
856	on_extcmd => sub {	1180	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
858		1182
859	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1184
861	if (ref $msg) {	1185	if (ref $msg) {
		1186	my ($type, $reply, @payload) =
		1187	"ARRAY" eq ref $msg
		1188	? @$msg
		1189	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1190
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
864	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
865	}	1195	if $reply;
866	}	1196	}
867	} else {	1197	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1199	}
870		1200
871	cf::override;	1201	cf::override;
872	},	1202	},
873	);	1203	);
874		1204
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
910	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1210	next unless -r $path;
912	eval {	1211
913	load_extension $ext;	1212	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1213	my $base = $1;
		1214	my $pkg = $1;
		1215	$pkg =~ s/[^[:word:]]/_/g;
		1216	$pkg = "ext::$pkg";
		1217
		1218	open my $fh, "<:utf8", $path
		1219	or die "$path: $!";
		1220
		1221	my $source = do { local $/; <$fh> };
		1222
		1223	my %ext = (
		1224	path => $path,
		1225	base => $base,
		1226	pkg => $pkg,
		1227	);
		1228
		1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1231
		1232	$ext{source} =
		1233	"package $pkg; use strict; use utf8;\n"
		1234	. "#line 1 \"$path\"\n{\n"
		1235	. $source
		1236	. "\n};\n1";
		1237
		1238	$todo{$base} = \%ext;
		1239	}
		1240
		1241	my %done;
		1242	while (%todo) {
		1243	my $progress;
		1244
		1245	while (my ($k, $v) = each %todo) {
		1246	for (split /,\s*/, $v->{meta}{depends}) {
		1247	goto skip
		1248	unless exists $done{$_};
		1249	}
		1250
		1251	warn "... loading '$k' into '$v->{pkg}'\n";
		1252
		1253	unless (eval $v->{source}) {
		1254	my $msg = $@ ? "$v->{path}: $@\n"
		1255	: "$v->{base}: extension inactive.\n";
		1256
		1257	if (exists $v->{meta}{mandatory}) {
		1258	warn $msg;
		1259	warn "mandatory extension failed to load, exiting.\n";
		1260	exit 1;
		1261	}
		1262
		1263	warn $msg;
		1264	}
		1265
		1266	$done{$k} = delete $todo{$k};
		1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
914	1	1269	}
915	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
916	}	1275	};
917	}	1276	}
918		1277
919	#############################################################################	1278	#############################################################################
920		1279
		1280	=back
		1281
921	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
922		1283
923	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
924		1285
925	=cut	1286	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
938		1299
939	=cut	1300	=cut
940		1301
941	sub playerdir($) {	1302	sub playerdir($) {
942	cf::localdir	1303	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1305	}
948		1306
949	sub path($) {	1307	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1309
952	(playerdir $login) . "/$login.pl"	1310	(playerdir $login) . "/playerdata"
953	}	1311	}
954		1312
955	sub find_active($) {	1313	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1314	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1315	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1328	my $login = $_[0];
971		1329
972	my $guard = cf::lock_acquire "user_find:$login";	1330	my $guard = cf::lock_acquire "user_find:$login";
973		1331
974	$cf::PLAYER{$_[0]} || do {	1332	$cf::PLAYER{$_[0]} || do {
		1333	# rename old playerfiles to new ones
		1334	#TODO: remove when no longer required
		1335	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1336	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1337	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1338	aio_unlink +(playerdir $login) . "/$login.pl";
		1339
975	my $pl = load_pl path $login	1340	my $pl = load_pl path $login
976	or return;	1341	or return;
977	$cf::PLAYER{$login} = $pl	1342	$cf::PLAYER{$login} = $pl
978	}	1343	}
979	}	1344	}
…		…
1007	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1008		1373
1009	$self	1374	$self
1010	}	1375	}
1011		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
1012	=item $pl->quit_character	1387	=item $pl->quit_character
1013		1388
1014	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
1015	be destroyed. May block for a long time.	1390	be destroyed. May block for a long time.
1016		1391
1017	=cut	1392	=cut
1018		1393
1019	sub quit_character {	1394	sub quit_character {
1020	my ($pl) = @_;	1395	my ($pl) = @_;
		1396
		1397	my $name = $pl->ob->name;
1021		1398
1022	$pl->{deny_save} = 1;	1399	$pl->{deny_save} = 1;
1023	$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
1024		1401
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1402	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1407	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1408	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1409	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1410	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1433	}
1037		1434
1038	=item cf::player::list_logins	1435	=item cf::player::list_logins
1039		1436
1040	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
1041	while and may block, so not sync_job-capable, ever.	1438	while and may block, so not sync_job-capable, ever.
1042		1439
1043	=cut	1440	=cut
1044		1441
1045	sub list_logins {	1442	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1443	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1444	or return [];
1048		1445
1049	my @logins;	1446	my @logins;
1050		1447
1051	for my $login (@$dirs) {	1448	for my $login (@$dirs) {
…		…
1068	=cut	1465	=cut
1069		1466
1070	sub maps($) {	1467	sub maps($) {
1071	my ($pl) = @_;	1468	my ($pl) = @_;
1072		1469
		1470	$pl = ref $pl ? $pl->ob->name : $pl;
		1471
1073	my $files = aio_readdir playerdir $pl	1472	my $files = aio_readdir playerdir $pl
1074	or return;	1473	or return;
1075		1474
1076	my @paths;	1475	my @paths;
1077		1476
1078	for (@$files) {	1477	for (@$files) {
1079	utf8::decode $_;	1478	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1479	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1480	next unless /^$PATH_SEP/o;
1082		1481
1083	s/\.map$//;	1482	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1483	}
1086		1484
1087	\@paths	1485	\@paths
1088	}	1486	}
1089		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
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1538	=item $player->ext_reply ($msgid, @msg)
1091		1539
1092	Sends an ext reply to the player.	1540	Sends an ext reply to the player.
1093		1541
1094	=cut	1542	=cut
1095		1543
1096	sub ext_reply($$$%) {	1544	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1545	my ($self, $id, @msg) = @_;
1098		1546
1099	$msg{msgid} = $id;	1547	if ($self->ns->extcmd == 2) {
1100		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1101	$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	}
1102	}	1554	}
1103		1555
1104	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	}
1105		1596
1106	=back	1597	=back
1107
1108		1598
1109	=head3 cf::map	1599	=head3 cf::map
1110		1600
1111	=over 4	1601	=over 4
1112		1602
…		…
1167	my ($self, $merge) = @_;	1657	my ($self, $merge) = @_;
1168		1658
1169	# we have to keep some variables in memory intact	1659	# we have to keep some variables in memory intact
1170	local $self->{path};	1660	local $self->{path};
1171	local $self->{load_path};	1661	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1662
1175	$self->SUPER::thawer_merge ($merge);	1663	$self->SUPER::thawer_merge ($merge);
1176	}	1664	}
1177		1665
1178	sub normalise {	1666	sub normalise {
1179	my ($path, $base) = @_;	1667	my ($path, $base) = @_;
1180		1668
1181	$path = "$path"; # make sure its a string	1669	$path = "$path"; # make sure its a string
		1670
		1671	$path =~ s/\.map$//;
1182		1672
1183	# map plan:	1673	# map plan:
1184	#	1674	#
1185	# /! non-realised random map exit (special hack!)	1675	# /! non-realised random map exit (special hack!)
1186	# {... are special paths that are not being touched	1676	# {... are special paths that are not being touched
…		…
1223	$self->init; # pass $1 etc.	1713	$self->init; # pass $1 etc.
1224	return $self;	1714	return $self;
1225	}	1715	}
1226	}	1716	}
1227		1717
1228	Carp::carp "unable to resolve path '$path' (base '$base').";	1718	Carp::cluck "unable to resolve path '$path' (base '$base').";
1229	()	1719	()
1230	}	1720	}
1231		1721
1232	sub init {	1722	sub init {
1233	my ($self) = @_;	1723	my ($self) = @_;
…		…
1248		1738
1249	# the original (read-only) location	1739	# the original (read-only) location
1250	sub load_path {	1740	sub load_path {
1251	my ($self) = @_;	1741	my ($self) = @_;
1252		1742
1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1743	"$MAPDIR/$self->{path}.map"
1254	}	1744	}
1255		1745
1256	# the temporary/swap location	1746	# the temporary/swap location
1257	sub save_path {	1747	sub save_path {
1258	my ($self) = @_;	1748	my ($self) = @_;
1259		1749
1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1750	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1751	"$TMPDIR/$path.map"
1262	}	1752	}
1263		1753
1264	# the unique path, undef == no special unique path	1754	# the unique path, undef == no special unique path
1265	sub uniq_path {	1755	sub uniq_path {
1266	my ($self) = @_;	1756	my ($self) = @_;
1267		1757
1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1758	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1759	"$UNIQUEDIR/$path"
1270	}	1760	}
1271		1761
1272	# and all this just because we cannot iterate over	1762	# and all this just because we cannot iterate over
1273	# all maps in C++...	1763	# all maps in C++...
1274	sub change_all_map_light {	1764	sub change_all_map_light {
…		…
1276		1766
1277	$_->change_map_light ($change)	1767	$_->change_map_light ($change)
1278	for grep $_->outdoor, values %cf::MAP;	1768	for grep $_->outdoor, values %cf::MAP;
1279	}	1769	}
1280		1770
		1771	sub decay_objects {
		1772	my ($self) = @_;
		1773
		1774	return if $self->{deny_reset};
		1775
		1776	$self->do_decay_objects;
		1777	}
		1778
1281	sub unlink_save {	1779	sub unlink_save {
1282	my ($self) = @_;	1780	my ($self) = @_;
1283		1781
1284	utf8::encode (my $save = $self->save_path);	1782	utf8::encode (my $save = $self->save_path);
1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1783	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1288		1786
1289	sub load_header_from($) {	1787	sub load_header_from($) {
1290	my ($self, $path) = @_;	1788	my ($self, $path) = @_;
1291		1789
1292	utf8::encode $path;	1790	utf8::encode $path;
1293	aio_open $path, O_RDONLY, 0	1791	#aio_open $path, O_RDONLY, 0
1294	or return;	1792	# or return;
1295		1793
1296	$self->_load_header ($path)	1794	$self->_load_header ($path)
1297	or return;	1795	or return;
1298		1796
1299	$self->{load_path} = $path;	1797	$self->{load_path} = $path;
…		…
1341	$self->load_header_orig	1839	$self->load_header_orig
1342	or return;	1840	or return;
1343	$self->prepare_orig;	1841	$self->prepare_orig;
1344	}	1842	}
1345		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
1346	1	1850	1
1347	}	1851	}
1348		1852
1349	sub find;	1853	sub find;
1350	sub find {	1854	sub find {
…		…
1362	$map->{last_save} = $cf::RUNTIME;	1866	$map->{last_save} = $cf::RUNTIME;
1363		1867
1364	$map->load_header	1868	$map->load_header
1365	or return;	1869	or return;
1366		1870
1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1871	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368	# doing this can freeze the server in a sync job, obviously	1872	# doing this can freeze the server in a sync job, obviously
1369	#$cf::WAIT_FOR_TICK->wait;	1873	#$cf::WAIT_FOR_TICK->wait;
1370	$map->reset;	1874	$map->reset;
1371	undef $guard;	1875	undef $guard;
1372	return find $path;	1876	return find $path;
…		…
1383	my ($self) = @_;	1887	my ($self) = @_;
1384		1888
1385	local $self->{deny_reset} = 1; # loading can take a long time	1889	local $self->{deny_reset} = 1; # loading can take a long time
1386		1890
1387	my $path = $self->{path};	1891	my $path = $self->{path};
		1892
		1893	{
1388	my $guard = cf::lock_acquire "map_load:$path";	1894	my $guard = cf::lock_acquire "map_load:$path";
1389		1895
1390	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1391		1897
1392	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1393		1899
1394	$self->alloc;	1900	$self->alloc;
1395		1901
1396	$self->pre_load;	1902	$self->pre_load;
1397
1398	$self->_load_objects ($self->{load_path}, 1)
1399	or return;
1400
1401	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1402	if delete $self->{load_original};
1403
1404	if (my $uniq = $self->uniq_path) {
1405	utf8::encode $uniq;
1406	if (aio_open $uniq, O_RDONLY, 0) {
1407	$self->clear_unique_items;
1408	$self->_load_objects ($uniq, 0);
1409	}
1410	}
1411
1412	Coro::cede;
1413
1414	# now do the right thing for maps
1415	$self->link_multipart_objects;
1416
1417	unless ($self->{deny_activate}) {
1418	$self->decay_objects;
1419	$self->fix_auto_apply;
1420	$self->update_buttons;
1421	Coro::cede;	1903	Coro::cede;
1422	$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;
1423	$self->difficulty ($self->estimate_difficulty)	1922	$self->difficulty ($self->estimate_difficulty)
1424	unless $self->difficulty;	1923	unless $self->difficulty;
1425	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;
1426	$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);
1427	}	1940	}
1428		1941
1429	$self->post_load;	1942	$self->post_load;
1430
1431	$self->in_memory (cf::MAP_IN_MEMORY);
1432	}	1943	}
1433		1944
1434	sub customise_for {	1945	sub customise_for {
1435	my ($self, $ob) = @_;	1946	my ($self, $ob) = @_;
1436		1947
1437	return find "~" . $ob->name . "/" . $self->{path}	1948	return find "~" . $ob->name . "/" . $self->{path}
1438	if $self->per_player;	1949	if $self->per_player;
		1950
		1951	# return find "?party/" . $ob->name . "/" . $self->{path}
		1952	# if $self->per_party;
1439		1953
1440	$self	1954	$self
1441	}	1955	}
1442		1956
1443	# 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
…		…
1490		2004
1491	undef $MAP_PREFETCH{$path};	2005	undef $MAP_PREFETCH{$path};
1492	$MAP_PREFETCHER ||= cf::async {	2006	$MAP_PREFETCHER ||= cf::async {
1493	while (%MAP_PREFETCH) {	2007	while (%MAP_PREFETCH) {
1494	for my $path (keys %MAP_PREFETCH) {	2008	for my $path (keys %MAP_PREFETCH) {
1495	my $map = find $path	2009	if (my $map = find $path) {
1496	or next;
1497	$map->load;	2010	$map->load;
		2011	}
1498		2012
1499	delete $MAP_PREFETCH{$path};	2013	delete $MAP_PREFETCH{$path};
1500	}	2014	}
1501	}	2015	}
1502	undef $MAP_PREFETCHER;	2016	undef $MAP_PREFETCHER;
…		…
1554		2068
1555	sub reset_at {	2069	sub reset_at {
1556	my ($self) = @_;	2070	my ($self) = @_;
1557		2071
1558	# TODO: safety, remove and allow resettable per-player maps	2072	# TODO: safety, remove and allow resettable per-player maps
1559	return 1e99 if $self->isa ("ext::map_per_player");#d#
1560	return 1e99 if $self->{deny_reset};	2073	return 1e99 if $self->{deny_reset};
1561		2074
1562	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2075	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1563	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;
1564		2077
…		…
1575	my ($self) = @_;	2088	my ($self) = @_;
1576		2089
1577	my $lock = cf::lock_acquire "map_data:$self->{path}";	2090	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2091
1579	return if $self->players;	2092	return if $self->players;
1580	return if $self->isa ("ext::map_per_player");#d#
1581		2093
1582	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	}
1583		2105
1584	delete $cf::MAP{$self->path};	2106	delete $cf::MAP{$self->path};
1585		2107
1586	$self->in_memory (cf::MAP_SWAPPED);
1587	$self->clear;	2108	$self->clear;
1588		2109
1589	$_->clear_links_to ($self) for values %cf::MAP;	2110	$_->clear_links_to ($self) for values %cf::MAP;
1590		2111
1591	$self->unlink_save;	2112	$self->unlink_save;
…		…
1610	$cf::MAP{$self->path} = $self;	2131	$cf::MAP{$self->path} = $self;
1611		2132
1612	$self->reset; # polite request, might not happen	2133	$self->reset; # polite request, might not happen
1613	}	2134	}
1614		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
1615	=item cf::map::unique_maps	2172	=item cf::map::unique_maps
1616		2173
1617	Returns an arrayref of paths of all shared maps that have	2174	Returns an arrayref of paths of all shared maps that have
1618	instantiated unique items. May block.	2175	instantiated unique items. May block.
1619		2176
1620	=cut	2177	=cut
1621		2178
1622	sub unique_maps() {	2179	sub unique_maps() {
1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2180	[
1624	or return;	2181	map {
1625
1626	my @paths;
1627
1628	for (@$files) {
1629	utf8::decode $_;	2182	utf8::decode $_;
1630	next if /\.pst$/;
1631	next unless /^$PATH_SEP/o;
1632
1633	s/\.map$//;	2183	/\.map$/
1634	push @paths, $_;	2184	? normalise $_
		2185	: ()
		2186	} @{ aio_readdir $UNIQUEDIR or [] }
1635	}	2187	]
1636
1637	\@paths
1638	}	2188	}
1639		2189
1640	package cf;	2190	package cf;
1641		2191
1642	=back	2192	=back
…		…
1688		2238
1689	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1690		2240
1691	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1692	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1693	} 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 {
1694	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1695	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1696	}	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 (@_);
1697	}	2266	}
1698		2267
1699	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1700		2269
1701	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1748	$self->deactivate_recursive;	2317	$self->deactivate_recursive;
1749		2318
1750	return if UNIVERSAL::isa $self->map, "ext::map_link";	2319	return if UNIVERSAL::isa $self->map, "ext::map_link";
1751		2320
1752	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2321	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1753	if $self->map;	2322	if $self->map && $self->map->{path} ne "{link}";
1754		2323
1755	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2324	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1756	}	2325	}
1757		2326
1758	sub cf::object::player::leave_link {	2327	sub cf::object::player::leave_link {
1759	my ($self, $map, $x, $y) = @_;	2328	my ($self, $map, $x, $y) = @_;
		2329
		2330	return unless $self->contr->active;
1760		2331
1761	my $link_pos = delete $self->{_link_pos};	2332	my $link_pos = delete $self->{_link_pos};
1762		2333
1763	unless ($map) {	2334	unless ($map) {
1764	# restore original map position	2335	# restore original map position
…		…
1782	$map->load;	2353	$map->load;
1783	$map->load_diag;	2354	$map->load_diag;
1784		2355
1785	return unless $self->contr->active;	2356	return unless $self->contr->active;
1786	$self->activate_recursive;	2357	$self->activate_recursive;
		2358
		2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1787	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1788	}	2361	}
1789		2362
1790	cf::player->attach (	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1791	on_logout => sub {
1792	my ($pl) = @_;
1793		2364
1794	# abort map switching before logout	2365	Moves the player to the given map-path and coordinates by first freezing
1795	if ($pl->ob->{_link_pos}) {	2366	her, loading and preparing them map, calling the provided $check callback
1796	cf::sync_job {	2367	that has to return the map if sucecssful, and then unfreezes the player on
1797	$pl->ob->leave_link	2368	the new (success) or old (failed) map position. In either case, $done will
1798	};	2369	be called at the end of this process.
1799	}
1800	},
1801	on_login => sub {
1802	my ($pl) = @_;
1803		2370
1804	# try to abort aborted map switching on player login :)
1805	# should happen only on crashes
1806	if ($pl->ob->{_link_pos}) {
1807	$pl->ob->enter_link;
1808	(async {
1809	# we need this sleep as the login has a concurrent enter_exit running
1810	# and this sleep increases chances of the player not ending up in scorn
1811	$pl->ob->reply (undef,
1812	"There was an internal problem at your last logout, "
1813	. "the server will try to bring you to your intended destination in a second.",
1814	cf::NDI_RED);
1815	Coro::Timer::sleep 1;
1816	$pl->ob->leave_link;
1817	})->prio (2);
1818	}
1819	},
1820	);
1821
1822	=item $player_object->goto ($path, $x, $y)
1823
1824	=cut	2371	=cut
		2372
		2373	our $GOTOGEN;
1825		2374
1826	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1827	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;
1828		2380
1829	$self->enter_link;	2381	$self->enter_link;
1830		2382
1831	(async {	2383	(async {
1832	my $map = eval {	2384	my $map = eval {
1833	my $map = cf::map::find $path;	2385	my $map = cf::map::find $path;
		2386
		2387	if ($map) {
1834	$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
1835	$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 $@;
1836	} or	2400	}
1837	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1838		2401
		2402	if ($gen == $self->{_goto_generation}) {
		2403	delete $self->{_goto_generation};
1839	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
		2405	}
		2406
		2407	$done->() if $done;
1840	})->prio (1);	2408	})->prio (1);
1841	}	2409	}
1842		2410
1843	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
1844		2412
…		…
1883		2451
1884	$rmp->{random_seed} ||= $exit->random_seed;	2452	$rmp->{random_seed} ||= $exit->random_seed;
1885		2453
1886	my $data = cf::to_json $rmp;	2454	my $data = cf::to_json $rmp;
1887	my $md5 = Digest::MD5::md5_hex $data;	2455	my $md5 = Digest::MD5::md5_hex $data;
1888	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2456	my $meta = "$RANDOMDIR/$md5.meta";
1889		2457
1890	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2458	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1891	aio_write $fh, 0, (length $data), $data, 0;	2459	aio_write $fh, 0, (length $data), $data, 0;
1892	undef $fh;	2460	undef $fh;
1893	aio_rename "$meta~", $meta;	2461	aio_rename "$meta~", $meta;
…		…
1902		2470
1903	return unless $self->type == cf::PLAYER;	2471	return unless $self->type == cf::PLAYER;
1904		2472
1905	if ($exit->slaying eq "/!") {	2473	if ($exit->slaying eq "/!") {
1906	#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
1907	cf::sync_job { prepare_random_map $exit };	2477	cf::sync_job { prepare_random_map $exit };
1908	}	2478	}
1909		2479
1910	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;
1911	my $hp = $exit->stats->hp;	2481	my $hp = $exit->stats->hp;
1912	my $sp = $exit->stats->sp;	2482	my $sp = $exit->stats->sp;
1913		2483
1914	$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);
1915		2489
1916	(async {	2490	(async {
1917	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
1918	unless (eval {	2492	unless (eval {
1919	$self->goto ($slaying, $hp, $sp);	2493	$self->goto ($slaying, $hp, $sp);
1920		2494
1921	1;	2495	1;
1922	}) {	2496	}) {
1923	$self->message ("Something went wrong deep within the crossfire server. "	2497	$self->message ("Something went wrong deep within the crossfire server. "
1924	. "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. "
1925	. "Please report this to the dungeon master!",	2499	. "Please report this to the dungeon master!",
1926	cf::NDI_UNIQUE | cf::NDI_RED);	2500	cf::NDI_UNIQUE | cf::NDI_RED);
1927		2501
1928	warn "ERROR in enter_exit: $@";	2502	warn "ERROR in enter_exit: $@";
1929	$self->leave_link;	2503	$self->leave_link;
1930	}	2504	}
1931	})->prio (1);	2505	})->prio (1);
…		…
1944		2518
1945	sub cf::client::send_drawinfo {	2519	sub cf::client::send_drawinfo {
1946	my ($self, $text, $flags) = @_;	2520	my ($self, $text, $flags) = @_;
1947		2521
1948	utf8::encode $text;	2522	utf8::encode $text;
1949	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1950	}	2524	}
1951		2525
		2526	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2527
		2528	Send a drawinfo or msg packet to the client, formatting the msg for the
		2529	client if neccessary. C<$type> should be a string identifying the type of
		2530	the message, with C<log> being the default. If C<$color> is negative, suppress
		2531	the message unless the client supports the msg packet.
		2532
		2533	=cut
		2534
		2535	sub cf::client::send_msg {
		2536	my ($self, $channel, $msg, $color, @extra) = @_;
		2537
		2538	$msg = $self->pl->expand_cfpod ($msg);
		2539
		2540	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2541
		2542	if (ref $channel) {
		2543	# send meta info to client, if not yet sent
		2544	unless (exists $self->{channel}{$channel->{id}}) {
		2545	$self->{channel}{$channel->{id}} = $channel;
		2546	$self->ext_msg (channel_info => $channel);
		2547	}
		2548
		2549	$channel = $channel->{id};
		2550	}
		2551
		2552	return unless @extra || length $msg;
		2553
		2554	if ($self->can_msg) {
		2555	# default colour, mask it out
		2556	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2557	if $color & cf::NDI_DEF;
		2558
		2559	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2560	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2561	} else {
		2562	if ($color >= 0) {
		2563	# replace some tags by gcfclient-compatible ones
		2564	for ($msg) {
		2565	1 while
		2566	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2567	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2568	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2569	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2570	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2571	}
		2572
		2573	$color &= cf::NDI_COLOR_MASK;
		2574
		2575	utf8::encode $msg;
		2576
		2577	if (0 && $msg =~ /\[/) {
		2578	# COMMAND/INFO
		2579	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2580	} else {
		2581	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2582	$self->send_packet ("drawinfo $color $msg")
		2583	}
		2584	}
		2585	}
		2586	}
		2587
		2588	=item $client->ext_msg ($type, @msg)
		2589
		2590	Sends an ext event to the client.
		2591
		2592	=cut
		2593
		2594	sub cf::client::ext_msg($$@) {
		2595	my ($self, $type, @msg) = @_;
		2596
		2597	my $extcmd = $self->extcmd;
		2598
		2599	if ($extcmd == 2) {
		2600	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2601	} elsif ($extcmd == 1) { # TODO: remove
		2602	push @msg, msgtype => "event_$type";
		2603	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2604	}
		2605	}
1952		2606
1953	=item $success = $client->query ($flags, "text", \&cb)	2607	=item $success = $client->query ($flags, "text", \&cb)
1954		2608
1955	Queues a query to the client, calling the given callback with	2609	Queues a query to the client, calling the given callback with
1956	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2610	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1957	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2611	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1958		2612
1959	Queries can fail, so check the return code. Or don't, as queries will become	2613	Queries can fail, so check the return code. Or don't, as queries will
1960	reliable at some point in the future.	2614	become reliable at some point in the future.
1961		2615
1962	=cut	2616	=cut
1963		2617
1964	sub cf::client::query {	2618	sub cf::client::query {
1965	my ($self, $flags, $text, $cb) = @_;	2619	my ($self, $flags, $text, $cb) = @_;
…		…
1973	utf8::encode $text;	2627	utf8::encode $text;
1974	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2628	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1975		2629
1976	$self->send_packet ($self->{query_queue}[0][0])	2630	$self->send_packet ($self->{query_queue}[0][0])
1977	if @{ $self->{query_queue} } == 1;	2631	if @{ $self->{query_queue} } == 1;
		2632
		2633	1
1978	}	2634	}
1979		2635
1980	cf::client->attach (	2636	cf::client->attach (
		2637	on_connect => sub {
		2638	my ($ns) = @_;
		2639
		2640	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2641	},
1981	on_reply => sub {	2642	on_reply => sub {
1982	my ($ns, $msg) = @_;	2643	my ($ns, $msg) = @_;
1983		2644
1984	# this weird shuffling is so that direct followup queries	2645	# this weird shuffling is so that direct followup queries
1985	# get handled first	2646	# get handled first
1986	my $queue = delete $ns->{query_queue}	2647	my $queue = delete $ns->{query_queue}
1987	or return; # be conservative, not sure how that can happen, but we saw a crash here	2648	or return; # be conservative, not sure how that can happen, but we saw a crash here
1988		2649
1989	(shift @$queue)->[1]->($msg);	2650	(shift @$queue)->[1]->($msg);
		2651	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1990		2652
1991	push @{ $ns->{query_queue} }, @$queue;	2653	push @{ $ns->{query_queue} }, @$queue;
1992		2654
1993	if (@{ $ns->{query_queue} } == @$queue) {	2655	if (@{ $ns->{query_queue} } == @$queue) {
1994	if (@$queue) {	2656	if (@$queue) {
…		…
1996	} else {	2658	} else {
1997	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2659	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1998	}	2660	}
1999	}	2661	}
2000	},	2662	},
		2663	on_exticmd => sub {
		2664	my ($ns, $buf) = @_;
		2665
		2666	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2667
		2668	if (ref $msg) {
		2669	my ($type, $reply, @payload) =
		2670	"ARRAY" eq ref $msg
		2671	? @$msg
		2672	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2673
		2674	if (my $cb = $EXTICMD{$type}) {
		2675	my @reply = $cb->($ns, @payload);
		2676
		2677	$ns->ext_reply ($reply, @reply)
		2678	if $reply;
		2679	}
		2680	} else {
		2681	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2682	}
		2683
		2684	cf::override;
		2685	},
2001	);	2686	);
2002		2687
2003	=item $client->async (\&cb)	2688	=item $client->async (\&cb)
2004		2689
2005	Create a new coroutine, running the specified callback. The coroutine will	2690	Create a new coroutine, running the specified callback. The coroutine will
…		…
2046	our $safe = new Safe "safe";	2731	our $safe = new Safe "safe";
2047	our $safe_hole = new Safe::Hole;	2732	our $safe_hole = new Safe::Hole;
2048		2733
2049	$SIG{FPE} = 'IGNORE';	2734	$SIG{FPE} = 'IGNORE';
2050		2735
2051	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2736	$safe->permit_only (Opcode::opset qw(
		2737	:base_core :base_mem :base_orig :base_math
		2738	grepstart grepwhile mapstart mapwhile
		2739	sort time
		2740	));
2052		2741
2053	# here we export the classes and methods available to script code	2742	# here we export the classes and methods available to script code
2054		2743
2055	=pod	2744	=pod
2056		2745
2057	The following fucntions and emthods are available within a safe environment:	2746	The following functions and methods are available within a safe environment:
2058		2747
2059	cf::object contr pay_amount pay_player map	2748	cf::object
		2749	contr pay_amount pay_player map x y force_find force_add
		2750	insert remove name archname title slaying race
		2751
2060	cf::object::player player	2752	cf::object::player
2061	cf::player peaceful	2753	player
2062	cf::map trigger	2754
		2755	cf::player
		2756	peaceful
		2757
		2758	cf::map
		2759	trigger
2063		2760
2064	=cut	2761	=cut
2065		2762
2066	for (	2763	for (
2067	["cf::object" => qw(contr pay_amount pay_player map)],	2764	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2765	insert remove inv name archname title slaying race)],
2068	["cf::object::player" => qw(player)],	2766	["cf::object::player" => qw(player)],
2069	["cf::player" => qw(peaceful)],	2767	["cf::player" => qw(peaceful)],
2070	["cf::map" => qw(trigger)],	2768	["cf::map" => qw(trigger)],
2071	) {	2769	) {
2072	no strict 'refs';	2770	no strict 'refs';
…		…
2143	=back	2841	=back
2144		2842
2145	=cut	2843	=cut
2146		2844
2147	#############################################################################	2845	#############################################################################
		2846	# the server's init and main functions
2148		2847
2149	=head2 EXTENSION DATABASE SUPPORT	2848	sub load_facedata($) {
		2849	my ($path) = @_;
2150		2850
2151	Crossfire maintains a very simple database for extension use. It can	2851	warn "loading facedata from $path\n";
2152	currently store anything that can be serialised using Storable, which
2153	excludes objects.
2154		2852
2155	The parameter C<$family> should best start with the name of the extension	2853	my $facedata;
2156	using it, it should be unique.	2854	0 < aio_load $path, $facedata
		2855	or die "$path: $!";
2157		2856
2158	=over 4	2857	$facedata = Coro::Storable::thaw $facedata;
2159		2858
2160	=item $hashref = cf::db_get $family	2859	$facedata->{version} == 2
		2860	or cf::cleanup "$path: version mismatch, cannot proceed.";
2161		2861
2162	Return a hashref for use by the extension C<$family>, which can be
2163	modified. After modifications, you have to call C<cf::db_dirty> or
2164	C<cf::db_sync>.
2165
2166	=item $value = cf::db_get $family => $key
2167
2168	Returns a single value from the database
2169
2170	=item cf::db_put $family => $hashref
2171
2172	Stores the given family hashref into the database. Updates are delayed, if
2173	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2174
2175	=item cf::db_put $family => $key => $value
2176
2177	Stores the given C<$value> in the family hash. Updates are delayed, if you
2178	want the data to be synced to disk immediately, use C<cf::db_sync>.
2179
2180	=item cf::db_dirty
2181
2182	Marks the database as dirty, to be updated at a later time.
2183
2184	=item cf::db_sync
2185
2186	Immediately write the database to disk I<if it is dirty>.
2187
2188	=cut
2189
2190	our $DB;
2191
2192	{
2193	my $path = cf::localdir . "/database.pst";
2194
2195	sub db_load() {
2196	$DB = stat $path ? Storable::retrieve $path : { };
2197	}	2862	{
		2863	my $faces = $facedata->{faceinfo};
2198		2864
2199	my $pid;	2865	while (my ($face, $info) = each %$faces) {
		2866	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2867	cf::face::set_visibility $idx, $info->{visibility};
		2868	cf::face::set_magicmap $idx, $info->{magicmap};
		2869	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2870	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2200		2871
2201	sub db_save() {	2872	cf::cede_to_tick;
2202	waitpid $pid, 0 if $pid;
2203	if (0 == ($pid = fork)) {
2204	$DB->{_meta}{version} = 1;
2205	Storable::nstore $DB, "$path~";
2206	rename "$path~", $path;
2207	cf::_exit 0 if defined $pid;
2208	}
2209	}
2210
2211	my $dirty;
2212
2213	sub db_sync() {
2214	db_save if $dirty;
2215	undef $dirty;
2216	}
2217
2218	my $idle = Event->idle (
2219	reentrant => 0,
2220	min => 10,
2221	max => 20,
2222	repeat => 0,
2223	data => WF_AUTOCANCEL,
2224	cb => \&db_sync,
2225	);
2226
2227	sub db_dirty() {
2228	$dirty = 1;
2229	$idle->start;
2230	}
2231
2232	sub db_get($;$) {
2233	@_ >= 2
2234	? $DB->{$_[0]}{$_[1]}
2235	: ($DB->{$_[0]} ||= { })
2236	}
2237
2238	sub db_put($$;$) {
2239	if (@_ >= 3) {
2240	$DB->{$_[0]}{$_[1]} = $_[2];
2241	} else {
2242	$DB->{$_[0]} = $_[1];
2243	}
2244	db_dirty;
2245	}
2246
2247	cf::global->attach (
2248	prio => 10000,
2249	on_cleanup => sub {
2250	db_sync;
2251	},	2873	}
2252	);
2253	}
2254		2874
2255	#############################################################################	2875	while (my ($face, $info) = each %$faces) {
2256	# the server's main()	2876	next unless $info->{smooth};
		2877	my $idx = cf::face::find $face
		2878	or next;
		2879	if (my $smooth = cf::face::find $info->{smooth}) {
		2880	cf::face::set_smooth $idx, $smooth;
		2881	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2882	} else {
		2883	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2884	}
		2885
		2886	cf::cede_to_tick;
		2887	}
		2888	}
		2889
		2890	{
		2891	my $anims = $facedata->{animinfo};
		2892
		2893	while (my ($anim, $info) = each %$anims) {
		2894	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2895	cf::cede_to_tick;
		2896	}
		2897
		2898	cf::anim::invalidate_all; # d'oh
		2899	}
		2900
		2901	{
		2902	# TODO: for gcfclient pleasure, we should give resources
		2903	# that gcfclient doesn't grok a >10000 face index.
		2904	my $res = $facedata->{resource};
		2905	my $enc = JSON::XS->new->utf8->canonical;
		2906
		2907	my $soundconf = delete $res->{"res/sound.conf"};
		2908
		2909	while (my ($name, $info) = each %$res) {
		2910	my $meta = $enc->encode ({
		2911	name => $name,
		2912	%{ $info->{meta} || {} },
		2913	});
		2914
		2915	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2916
		2917	if ($info->{type} & 1) {
		2918	# prepend meta info
		2919
		2920	my $data = pack "(w/a*)*", $meta, $info->{data};
		2921	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2922
		2923	cf::face::set_data $idx, 0, $data, $chk;
		2924	} else {
		2925	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2926	}
		2927
		2928	cf::face::set_type $idx, $info->{type};
		2929
		2930	cf::cede_to_tick;
		2931	}
		2932
		2933	if ($soundconf) {
		2934	$soundconf = $enc->decode (delete $soundconf->{data});
		2935
		2936	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2937	my $sound = $soundconf->{compat}[$_]
		2938	or next;
		2939
		2940	my $face = cf::face::find "sound/$sound->[1]";
		2941	cf::sound::set $sound->[0] => $face;
		2942	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2943	}
		2944
		2945	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2946	my $face = cf::face::find "sound/$v";
		2947	cf::sound::set $k => $face;
		2948	}
		2949	}
		2950	}
		2951
		2952	1
		2953	}
		2954
		2955	register_exticmd fx_want => sub {
		2956	my ($ns, $want) = @_;
		2957
		2958	while (my ($k, $v) = each %$want) {
		2959	$ns->fx_want ($k, $v);
		2960	}
		2961	};
		2962
		2963	sub reload_regions {
		2964	load_resource_file "$MAPDIR/regions"
		2965	or die "unable to load regions file\n";
		2966
		2967	for (cf::region::list) {
		2968	$_->{match} = qr/$_->{match}/
		2969	if exists $_->{match};
		2970	}
		2971	}
		2972
		2973	sub reload_facedata {
		2974	load_facedata "$DATADIR/facedata"
		2975	or die "unable to load facedata\n";
		2976	}
		2977
		2978	sub reload_archetypes {
		2979	load_resource_file "$DATADIR/archetypes"
		2980	or die "unable to load archetypes\n";
		2981	#d# NEED to laod twice to resolve forward references
		2982	# this really needs to be done in an extra post-pass
		2983	# (which needs to be synchronous, so solve it differently)
		2984	load_resource_file "$DATADIR/archetypes"
		2985	or die "unable to load archetypes\n";
		2986	}
		2987
		2988	sub reload_treasures {
		2989	load_resource_file "$DATADIR/treasures"
		2990	or die "unable to load treasurelists\n";
		2991	}
		2992
		2993	sub reload_resources {
		2994	warn "reloading resource files...\n";
		2995
		2996	reload_regions;
		2997	reload_facedata;
		2998	#reload_archetypes;#d#
		2999	reload_archetypes;
		3000	reload_treasures;
		3001
		3002	warn "finished reloading resource files\n";
		3003	}
		3004
		3005	sub init {
		3006	reload_resources;
		3007	}
2257		3008
2258	sub cfg_load {	3009	sub cfg_load {
2259	open my $fh, "<:utf8", cf::confdir . "/config"	3010	open my $fh, "<:utf8", "$CONFDIR/config"
2260	or return;	3011	or return;
2261		3012
2262	local $/;	3013	local $/;
2263	*CFG = YAML::Syck::Load <$fh>;	3014	*CFG = YAML::Syck::Load <$fh>;
2264		3015
…		…
2284	Event::one_event;	3035	Event::one_event;
2285	})->prio (Coro::PRIO_MAX);	3036	})->prio (Coro::PRIO_MAX);
2286	};	3037	};
2287		3038
2288	cfg_load;	3039	cfg_load;
2289	db_load;	3040	db_init;
2290	load_extensions;	3041	load_extensions;
2291		3042
2292	$TICK_WATCHER->start;	3043	$TICK_WATCHER->start;
2293	Event::loop;	3044	Event::loop;
2294	}	3045	}
…		…
2309	},	3060	},
2310	);	3061	);
2311	}	3062	}
2312	}	3063	}
2313		3064
		3065	sub write_runtime {
		3066	my $runtime = "$LOCALDIR/runtime";
		3067
		3068	# first touch the runtime file to show we are still running:
		3069	# the fsync below can take a very very long time.
		3070
		3071	IO::AIO::aio_utime $runtime, undef, undef;
		3072
		3073	my $guard = cf::lock_acquire "write_runtime";
		3074
		3075	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3076	or return;
		3077
		3078	my $value = $cf::RUNTIME + 90 + 10;
		3079	# 10 is the runtime save interval, for a monotonic clock
		3080	# 60 allows for the watchdog to kill the server.
		3081
		3082	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3083	and return;
		3084
		3085	# always fsync - this file is important
		3086	aio_fsync $fh
		3087	and return;
		3088
		3089	# touch it again to show we are up-to-date
		3090	aio_utime $fh, undef, undef;
		3091
		3092	close $fh
		3093	or return;
		3094
		3095	aio_rename "$runtime~", $runtime
		3096	and return;
		3097
		3098	warn "runtime file written.\n";
		3099
		3100	1
		3101	}
		3102
2314	sub emergency_save() {	3103	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	3104	my $freeze_guard = cf::freeze_mainloop;
2316		3105
2317	warn "enter emergency perl save\n";	3106	warn "enter emergency perl save\n";
2318		3107
…		…
2333	my $map = $cf::MAP{$path} or next;	3122	my $map = $cf::MAP{$path} or next;
2334	$map->valid or next;	3123	$map->valid or next;
2335	$map->save;	3124	$map->save;
2336	}	3125	}
2337	warn "end emergency map save\n";	3126	warn "end emergency map save\n";
		3127
		3128	warn "begin emergency database checkpoint\n";
		3129	BDB::db_env_txn_checkpoint $DB_ENV;
		3130	warn "end emergency database checkpoint\n";
2338	};	3131	};
2339		3132
2340	warn "leave emergency perl save\n";	3133	warn "leave emergency perl save\n";
2341	}	3134	}
2342		3135
		3136	sub post_cleanup {
		3137	my ($make_core) = @_;
		3138
		3139	warn Carp::longmess "post_cleanup backtrace"
		3140	if $make_core;
		3141	}
		3142
2343	sub reload() {	3143	sub do_reload_perl() {
2344	# can/must only be called in main	3144	# can/must only be called in main
2345	if ($Coro::current != $Coro::main) {	3145	if ($Coro::current != $Coro::main) {
2346	warn "can only reload from main coroutine";	3146	warn "can only reload from main coroutine";
2347	return;	3147	return;
2348	}	3148	}
2349		3149
2350	warn "reloading...";	3150	warn "reloading...";
2351		3151
2352	warn "cancelling server ticker";	3152	warn "entering sync_job";
2353	$TICK_WATCHER->cancel;
2354		3153
		3154	cf::sync_job {
		3155	cf::write_runtime; # external watchdog should not bark
2355	cf::emergency_save;	3156	cf::emergency_save;
		3157	cf::write_runtime; # external watchdog should not bark
2356		3158
2357	eval {	3159	warn "syncing database to disk";
		3160	BDB::db_env_txn_checkpoint $DB_ENV;
		3161
2358	# if anything goes wrong in here, we should simply crash as we already saved	3162	# if anything goes wrong in here, we should simply crash as we already saved
2359
2360	warn "syncing database to disk";
2361	cf::db_sync;
2362		3163
2363	warn "cancelling all WF_AUTOCANCEL watchers";	3164	warn "cancelling all WF_AUTOCANCEL watchers";
2364	for (Event::all_watchers) {	3165	for (Event::all_watchers) {
2365	$_->cancel if $_->data & WF_AUTOCANCEL;	3166	$_->cancel if $_->data & WF_AUTOCANCEL;
2366	}	3167	}
2367		3168
2368	warn "flushing outstanding aio requests";	3169	warn "flushing outstanding aio requests";
2369	for (;;) {	3170	for (;;) {
		3171	BDB::flush;
2370	IO::AIO::flush;	3172	IO::AIO::flush;
2371	Coro::cede;	3173	Coro::cede;
2372	last unless IO::AIO::nreqs;	3174	last unless IO::AIO::nreqs || BDB::nreqs;
2373	warn "iterate...";	3175	warn "iterate...";
2374	}	3176	}
		3177
		3178	++$RELOAD;
2375		3179
2376	warn "cancelling all extension coros";	3180	warn "cancelling all extension coros";
2377	$_->cancel for values %EXT_CORO;	3181	$_->cancel for values %EXT_CORO;
2378	%EXT_CORO = ();	3182	%EXT_CORO = ();
2379		3183
2380	warn "removing commands";	3184	warn "removing commands";
2381	%COMMAND = ();	3185	%COMMAND = ();
2382		3186
2383	warn "removing ext commands";	3187	warn "removing ext/exti commands";
2384	%EXTCMD = ();	3188	%EXTCMD = ();
		3189	%EXTICMD = ();
2385		3190
2386	warn "unloading/nuking all extensions";	3191	warn "unloading/nuking all extensions";
2387	for my $pkg (@EXTS) {	3192	for my $pkg (@EXTS) {
2388	warn "... unloading $pkg";	3193	warn "... unloading $pkg";
2389		3194
…		…
2419	Symbol::delete_package "safe::$_"	3224	Symbol::delete_package "safe::$_"
2420	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3225	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2421		3226
2422	warn "unloading cf.pm \"a bit\"";	3227	warn "unloading cf.pm \"a bit\"";
2423	delete $INC{"cf.pm"};	3228	delete $INC{"cf.pm"};
		3229	delete $INC{"cf/pod.pm"};
2424		3230
2425	# don't, removes xs symbols, too,	3231	# don't, removes xs symbols, too,
2426	# and global variables created in xs	3232	# and global variables created in xs
2427	#Symbol::delete_package __PACKAGE__;	3233	#Symbol::delete_package __PACKAGE__;
2428		3234
…		…
2432	require cf;	3238	require cf;
2433	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3239	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2434		3240
2435	warn "loading config and database again";	3241	warn "loading config and database again";
2436	cf::cfg_load;	3242	cf::cfg_load;
2437	cf::db_load;
2438		3243
2439	warn "loading extensions";	3244	warn "loading extensions";
2440	cf::load_extensions;	3245	cf::load_extensions;
2441		3246
2442	warn "reattaching attachments to objects/players";	3247	warn "reattaching attachments to objects/players";
2443	_global_reattach;	3248	_global_reattach; # objects, sockets
2444	warn "reattaching attachments to maps";	3249	warn "reattaching attachments to maps";
2445	reattach $_ for values %MAP;	3250	reattach $_ for values %MAP;
		3251	warn "reattaching attachments to players";
		3252	reattach $_ for values %PLAYER;
2446		3253
2447	warn "restarting server ticker";	3254	warn "leaving sync_job";
2448		3255
2449	$TICK_WATCHER->start;	3256	1
2450	};	3257	} or do {
2451
2452	if ($@) {
2453	warn $@;	3258	warn $@;
2454	warn "error while reloading, exiting.";	3259	warn "error while reloading, exiting.";
2455	exit 1;	3260	exit 1;
2456	}	3261	};
2457		3262
2458	warn "reloaded";	3263	warn "reloaded";
2459	};	3264	};
2460		3265
2461	our $RELOAD_WATCHER; # used only during reload	3266	our $RELOAD_WATCHER; # used only during reload
2462		3267
		3268	sub reload_perl() {
		3269	# doing reload synchronously and two reloads happen back-to-back,
		3270	# coro crashes during coro_state_free->destroy here.
		3271
		3272	$RELOAD_WATCHER ||= Event->timer (
		3273	reentrant => 0,
		3274	after => 0,
		3275	data => WF_AUTOCANCEL,
		3276	cb => sub {
		3277	do_reload_perl;
		3278	undef $RELOAD_WATCHER;
		3279	},
		3280	);
		3281	}
		3282
2463	register_command "reload" => sub {	3283	register_command "reload" => sub {
2464	my ($who, $arg) = @_;	3284	my ($who, $arg) = @_;
2465		3285
2466	if ($who->flag (FLAG_WIZ)) {	3286	if ($who->flag (FLAG_WIZ)) {
2467	$who->message ("reloading server.");	3287	$who->message ("reloading server.");
2468		3288	async { reload_perl };
2469	# doing reload synchronously and two reloads happen back-to-back,
2470	# coro crashes during coro_state_free->destroy here.
2471
2472	$RELOAD_WATCHER ||= Event->timer (
2473	reentrant => 0,
2474	after => 0,
2475	data => WF_AUTOCANCEL,
2476	cb => sub {
2477	reload;
2478	undef $RELOAD_WATCHER;
2479	},
2480	);
2481	}	3289	}
2482	};	3290	};
2483		3291
2484	unshift @INC, $LIBDIR;	3292	unshift @INC, $LIBDIR;
2485		3293
2486	my $bug_warning = 0;	3294	my $bug_warning = 0;
2487		3295
		3296	our @WAIT_FOR_TICK;
		3297	our @WAIT_FOR_TICK_BEGIN;
		3298
		3299	sub wait_for_tick {
		3300	return unless $TICK_WATCHER->is_active;
		3301	return if $Coro::current == $Coro::main;
		3302
		3303	my $signal = new Coro::Signal;
		3304	push @WAIT_FOR_TICK, $signal;
		3305	$signal->wait;
		3306	}
		3307
		3308	sub wait_for_tick_begin {
		3309	return unless $TICK_WATCHER->is_active;
		3310	return if $Coro::current == $Coro::main;
		3311
		3312	my $signal = new Coro::Signal;
		3313	push @WAIT_FOR_TICK_BEGIN, $signal;
		3314	$signal->wait;
		3315	}
		3316
		3317	my $min = 1e6;#d#
		3318	my $avg = 10;
2488	$TICK_WATCHER = Event->timer (	3319	$TICK_WATCHER = Event->timer (
2489	reentrant => 0,	3320	reentrant => 0,
2490	parked => 1,	3321	parked => 1,
2491	prio => 0,	3322	prio => 0,
2492	at => $NEXT_TICK || $TICK,	3323	at => $NEXT_TICK || $TICK,
…		…
2496	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3327	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2497	unless ++$bug_warning > 10;	3328	unless ++$bug_warning > 10;
2498	return;	3329	return;
2499	}	3330	}
2500		3331
2501	$NOW = Event::time;	3332	$NOW = $tick_start = Event::time;
2502		3333
2503	cf::server_tick; # one server iteration	3334	cf::server_tick; # one server iteration
		3335
		3336	0 && sync_job {#d#
		3337	for(1..10) {
		3338	my $t = Event::time;
		3339	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3340	or die;
		3341
		3342	$map->width (50);
		3343	$map->height (50);
		3344	$map->alloc;
		3345	$map->_load_objects ("/tmp/x.map", 1);
		3346	my $t = Event::time - $t;
		3347
		3348	#next unless $t < 0.0013;#d#
		3349	if ($t < $min) {
		3350	$min = $t;
		3351	}
		3352	$avg = $avg * 0.99 + $t * 0.01;
		3353	}
		3354	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3355	exit 0;
		3356	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3357	};
		3358
2504	$RUNTIME += $TICK;	3359	$RUNTIME += $TICK;
2505	$NEXT_TICK += $TICK;	3360	$NEXT_TICK += $TICK;
2506		3361
2507	$WAIT_FOR_TICK->broadcast;	3362	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2508	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3363	$NEXT_RUNTIME_WRITE = $NOW + 10;
2509		3364	Coro::async_pool {
2510	Event::sweep;	3365	write_runtime
2511	Coro::cede_notself;	3366	or warn "ERROR: unable to write runtime file: $!";
		3367	};
2512		3368	}
		3369
2513	# my $AFTER = Event::time;	3370	# my $AFTER = Event::time;
2514	# warn $AFTER - $NOW;#d#	3371	# warn $AFTER - $NOW;#d#
2515		3372
		3373	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3374	$sig->send;
		3375	}
		3376	while (my $sig = shift @WAIT_FOR_TICK) {
		3377	$sig->send;
		3378	}
		3379
		3380	$NOW = Event::time;
		3381
2516	# if we are delayed by four ticks or more, skip them all	3382	# if we are delayed by four ticks or more, skip them all
2517	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3383	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2518		3384
2519	$TICK_WATCHER->at ($NEXT_TICK);	3385	$TICK_WATCHER->at ($NEXT_TICK);
2520	$TICK_WATCHER->start;	3386	$TICK_WATCHER->start;
		3387
		3388	$LOAD = ($NOW - $tick_start) / $TICK;
		3389	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3390
		3391	_post_tick;
		3392
		3393
2521	},	3394	},
2522	);	3395	);
2523		3396
		3397	{
		3398	BDB::max_poll_time $TICK * 0.1;
		3399	$BDB_POLL_WATCHER = Event->io (
		3400	reentrant => 0,
		3401	fd => BDB::poll_fileno,
		3402	poll => 'r',
		3403	prio => 0,
		3404	data => WF_AUTOCANCEL,
		3405	cb => \&BDB::poll_cb,
		3406	);
		3407	BDB::min_parallel 8;
		3408
		3409	BDB::set_sync_prepare {
		3410	my $status;
		3411	my $current = $Coro::current;
		3412	(
		3413	sub {
		3414	$status = $!;
		3415	$current->ready; undef $current;
		3416	},
		3417	sub {
		3418	Coro::schedule while defined $current;
		3419	$! = $status;
		3420	},
		3421	)
		3422	};
		3423
		3424	unless ($DB_ENV) {
		3425	$DB_ENV = BDB::db_env_create;
		3426
		3427	cf::sync_job {
		3428	eval {
		3429	BDB::db_env_open
		3430	$DB_ENV,
		3431	$BDBDIR,
		3432	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3433	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3434	0666;
		3435
		3436	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3437
		3438	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3439	$DB_ENV->set_lk_detect;
		3440	};
		3441
		3442	cf::cleanup "db_env_open(db): $@" if $@;
		3443	};
		3444	}
		3445	}
		3446
		3447	{
		3448	IO::AIO::min_parallel 8;
		3449
		3450	undef $Coro::AIO::WATCHER;
2524	IO::AIO::max_poll_time $TICK * 0.1;	3451	IO::AIO::max_poll_time $TICK * 0.1;
2525
2526	undef $Coro::AIO::WATCHER;
2527	$AIO_POLL_WATCHER = Event->io (	3452	$AIO_POLL_WATCHER = Event->io (
2528	reentrant => 0,	3453	reentrant => 0,
		3454	data => WF_AUTOCANCEL,
2529	fd => IO::AIO::poll_fileno,	3455	fd => IO::AIO::poll_fileno,
2530	poll => 'r',	3456	poll => 'r',
2531	prio => 6,	3457	prio => 6,
2532	data => WF_AUTOCANCEL,
2533	cb => \&IO::AIO::poll_cb,	3458	cb => \&IO::AIO::poll_cb,
2534	);	3459	);
		3460	}
2535		3461
2536	$WRITE_RUNTIME_WATCHER = Event->timer (	3462	my $_log_backtrace;
2537	reentrant => 0,	3463
2538	data => WF_AUTOCANCEL,	3464	sub _log_backtrace {
2539	after => 1,	3465	my ($msg, @addr) = @_;
2540	interval => 10,	3466
2541	prio => 6, # keep it lowest so it acts like a watchdog	3467	$msg =~ s/\n//;
2542	cb => Coro::unblock_sub {	3468
2543	write_runtime	3469	# limit the # of concurrent backtraces
2544	or warn "ERROR: unable to write runtime file: $!";	3470	if ($_log_backtrace < 2) {
		3471	++$_log_backtrace;
		3472	async {
		3473	my @bt = fork_call {
		3474	@addr = map { sprintf "%x", $_ } @addr;
		3475	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3476	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3477	or die "addr2line: $!";
		3478
		3479	my @funcs;
		3480	my @res = <$fh>;
		3481	chomp for @res;
		3482	while (@res) {
		3483	my ($func, $line) = splice @res, 0, 2, ();
		3484	push @funcs, "[$func] $line";
		3485	}
		3486
		3487	@funcs
		3488	};
		3489
		3490	LOG llevInfo, "[ABT] $msg\n";
		3491	LOG llevInfo, "[ABT] $_\n" for @bt;
		3492	--$_log_backtrace;
		3493	};
		3494	} else {
		3495	LOG llevInfo, "[ABT] $msg\n";
		3496	LOG llevInfo, "[ABT] [suppressed]\n";
2545	},	3497	}
2546	);	3498	}
		3499
		3500	# load additional modules
		3501	use cf::pod;
2547		3502
2548	END { cf::emergency_save }	3503	END { cf::emergency_save }
2549		3504
2550	1	3505	1
2551		3506

Diff Legend

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