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.190 by root, Mon Jan 22 03:44:41 2007 UTC vs.
Revision 1.329 by root, Fri Aug 10 05:38:16 2007 UTC

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

Diff Legend

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