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.184 by root, Fri Jan 19 22:47:57 2007 UTC vs.
Revision 1.322 by root, Fri Jul 27 10:10:51 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	475	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		476
358	aio_fsync $fh	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 : $!";
		480	Storable::store_fd $_[0], $fh;
361	close $fh	481	close $fh;
362	or return;
363		482
364	aio_rename "$runtime~", $runtime	483	$buf
365	and return;	484	}
366		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;
367	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 });
368	}	655	}
369		656
370	=back	657	=back
371		658
372	=cut	659	=cut
…		…
379	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")
380	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
381		668
382	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>
383	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
384	crossfire+).	671	Crossfire TRT).
385		672
386	=over 4	673	=over 4
387		674
388	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
389		676
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
553		840
554	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		845
559	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	847	my $pkg = shift @arg;
561		848
562	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
592	}	879	}
593		880
594	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
595	} else {	882	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	884	}
598		885
599	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
600	}	887	}
601		888
…		…
603	if (ref $_[0]) {	890	if (ref $_[0]) {
604	_object_attach @_;	891	_object_attach @_;
605	} else {	892	} else {
606	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
607	}	894	}
		895	_recalc_want;
608	};	896	};
609		897
610	# all those should be optimised	898	# all those should be optimised
611	sub cf::attachable::detach {	899	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
616	reattach ($obj);	904	reattach ($obj);
617	} else {	905	} else {
618	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
619	}	907	}
		908	_recalc_want;
620	};	909	};
621		910
622	sub cf::attachable::attached {	911	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
624		913
…		…
639	";	928	";
640	die if $@;	929	die if $@;
641	}	930	}
642		931
643	our $override;	932	our $override;
644	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?
645		934
646	sub override {	935	sub override {
647	$override = 1;	936	$override = 1;
648	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
649	}	938	}
650		939
651	sub do_invoke {	940	sub do_invoke {
652	my $event = shift;	941	my $event = shift;
653	my $callbacks = shift;	942	my $callbacks = shift;
654		943
655	@invoke_results = ();	944	@INVOKE_RESULTS = ();
656		945
657	local $override;	946	local $override;
658		947
659	for (@$callbacks) {	948	for (@$callbacks) {
660	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
677		966
678	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
679		968
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		972
684	=back	973	=back
685		974
686	=cut	975	=cut
687		976
688	#############################################################################	977	#############################################################################
689	# 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	}
690		990
691	sub reattach {	991	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	993	my ($obj) = @_;
694		994
…		…
747	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
748		1048
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1053	close $fh;
754		1054
755	if (@$objs) {	1055	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1061	close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
763	}	1063	}
764	} else {	1064	} else {
765	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
797	or return;	1097	or return;
798	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
799	}	1099	}
800		1100
801	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
803	return ($data, $av);	1103	return ($data, $av);
804	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
805		1111
806	#############################################################################	1112	#############################################################################
807	# command handling &c	1113	# command handling &c
808		1114
809	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1129	}
824		1130
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1132
827	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.
828		1138
829	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
830	called.	1140	called.
831		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
832	=cut	1153	=cut
833		1154
834	sub register_extcmd {	1155	sub register_extcmd {
835	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
836		1157
837	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
838	}	1165	}
839		1166
840	cf::player->attach (	1167	cf::player->attach (
841	on_command => sub {	1168	on_command => sub {
842	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1178	cf::override;
852	},	1179	},
853	on_extcmd => sub {	1180	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
855		1182
856	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1184
858	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
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
861	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
862	}	1195	if $reply;
863	}	1196	}
864	} else {	1197	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1199	}
867		1200
868	cf::override;	1201	cf::override;
869	},	1202	},
870	);	1203	);
871		1204
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
907	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1210	next unless -r $path;
909	eval {	1211
910	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;
911	1	1269	}
912	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
913	}	1275	};
914	}	1276	}
915		1277
916	#############################################################################	1278	#############################################################################
917		1279
		1280	=back
		1281
918	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
919		1283
920	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
921		1285
922	=cut	1286	=cut
…		…
934	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
935		1299
936	=cut	1300	=cut
937		1301
938	sub playerdir($) {	1302	sub playerdir($) {
939	cf::localdir	1303	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1305	}
945		1306
946	sub path($) {	1307	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1309
949	(playerdir $login) . "/$login.pl"	1310	(playerdir $login) . "/playerdata"
950	}	1311	}
951		1312
952	sub find_active($) {	1313	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1314	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1315	and $cf::PLAYER{$_[0]}->active
…		…
967	my $login = $_[0];	1328	my $login = $_[0];
968		1329
969	my $guard = cf::lock_acquire "user_find:$login";	1330	my $guard = cf::lock_acquire "user_find:$login";
970		1331
971	$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
972	my $pl = load_pl path $login	1340	my $pl = load_pl path $login
973	or return;	1341	or return;
974	$cf::PLAYER{$login} = $pl	1342	$cf::PLAYER{$login} = $pl
975	}	1343	}
976	}	1344	}
…		…
1013		1381
1014	=cut	1382	=cut
1015		1383
1016	sub quit_character {	1384	sub quit_character {
1017	my ($pl) = @_;	1385	my ($pl) = @_;
		1386
		1387	my $name = $pl->ob->name;
1018		1388
1019	$pl->{deny_save} = 1;	1389	$pl->{deny_save} = 1;
1020	$pl->password ("*"); # this should lock out the player until we nuked the dir	1390	$pl->password ("*"); # this should lock out the player until we nuked the dir
1021		1391
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1392	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1027	my $path = playerdir $pl;	1397	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1398	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1399	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1400	delete $cf::PLAYER{$pl->ob->name};
1031	$pl->destroy;	1401	$pl->destroy;
		1402
		1403	my $prefix = qr<^~\Q$name\E/>;
		1404
		1405	# nuke player maps
		1406	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1407
1032	IO::AIO::aio_rmtree $temp;	1408	IO::AIO::aio_rmtree $temp;
		1409	}
		1410
		1411	=item $pl->kick
		1412
		1413	Kicks a player out of the game. This destroys the connection.
		1414
		1415	=cut
		1416
		1417	sub kick {
		1418	my ($pl, $kicker) = @_;
		1419
		1420	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1421	$pl->killer ("kicked");
		1422	$pl->ns->destroy;
1033	}	1423	}
1034		1424
1035	=item cf::player::list_logins	1425	=item cf::player::list_logins
1036		1426
1037	Returns am arrayref of all valid playernames in the system, can take a	1427	Returns am arrayref of all valid playernames in the system, can take a
1038	while and may block, so not sync_job-capable, ever.	1428	while and may block, so not sync_job-capable, ever.
1039		1429
1040	=cut	1430	=cut
1041		1431
1042	sub list_logins {	1432	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1433	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1434	or return [];
1045		1435
1046	my @logins;	1436	my @logins;
1047		1437
1048	for my $login (@$dirs) {	1438	for my $login (@$dirs) {
…		…
1065	=cut	1455	=cut
1066		1456
1067	sub maps($) {	1457	sub maps($) {
1068	my ($pl) = @_;	1458	my ($pl) = @_;
1069		1459
		1460	$pl = ref $pl ? $pl->ob->name : $pl;
		1461
1070	my $files = aio_readdir playerdir $pl	1462	my $files = aio_readdir playerdir $pl
1071	or return;	1463	or return;
1072		1464
1073	my @paths;	1465	my @paths;
1074		1466
1075	for (@$files) {	1467	for (@$files) {
1076	utf8::decode $_;	1468	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1469	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1470	next unless /^$PATH_SEP/o;
1079		1471
1080	s/\.map$//;	1472	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1473	}
1083		1474
1084	\@paths	1475	\@paths
1085	}	1476	}
1086		1477
		1478	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1479
		1480	Expand crossfire pod fragments into protocol xml.
		1481
		1482	=cut
		1483
		1484	sub expand_cfpod {
		1485	((my $self), (local $_)) = @_;
		1486
		1487	# escape & and <
		1488	s/&/&amp;/g;
		1489	s/(?<![BIUGH])</&lt;/g;
		1490
		1491	# this is buggy, it needs to properly take care of nested <'s
		1492
		1493	1 while
		1494	# replace B<>, I<>, U<> etc.
		1495	s/B<([^\>]*)>/<b>$1<\/b>/
		1496	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1497	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1498	# replace G<male|female> tags
		1499	|| s{G<([^>|]*)\|([^>]*)>}{
		1500	$self->gender ? $2 : $1
		1501	}ge
		1502	# replace H<hint text>
		1503	|| s{H<([^\>]*)>}
		1504	{
		1505	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1506	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1507	"")
		1508	[$self->{hintmode}]
		1509	}ge;
		1510
		1511	# create single paragraphs (very hackish)
		1512	s/(?<=\S)\n(?=\w)/ /g;
		1513
		1514	# compress some whitespace
		1515	s/\s+\n/\n/g; # ws line-ends
		1516	s/\n\n+/\n/g; # double lines
		1517	s/^\n+//; # beginning lines
		1518	s/\n+$//; # ending lines
		1519
		1520	$_
		1521	}
		1522
		1523	sub hintmode {
		1524	$_[0]{hintmode} = $_[1] if @_ > 1;
		1525	$_[0]{hintmode}
		1526	}
		1527
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1088		1529
1089	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1090		1531
1091	=cut	1532	=cut
1092		1533
1093	sub ext_reply($$$%) {	1534	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1095		1536
1096	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1097		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1098	$self->send ("ext " . cf::to_json \%msg);	1539	} elsif ($self->ns->extcmd == 1) {
		1540	#TODO: version 1, remove
		1541	unshift @msg, msgtype => "reply", msgid => $id;
		1542	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1543	}
1099	}	1544	}
1100		1545
1101	package cf;	1546	=item $player->ext_msg ($type, @msg)
		1547
		1548	Sends an ext event to the client.
		1549
		1550	=cut
		1551
		1552	sub ext_msg($$@) {
		1553	my ($self, $type, @msg) = @_;
		1554
		1555	$self->ns->ext_msg ($type, @msg);
		1556	}
		1557
		1558	=head3 cf::region
		1559
		1560	=over 4
		1561
		1562	=cut
		1563
		1564	package cf::region;
		1565
		1566	=item cf::region::find_by_path $path
		1567
		1568	Tries to decuce the likely region for a map knowing only its path.
		1569
		1570	=cut
		1571
		1572	sub find_by_path($) {
		1573	my ($path) = @_;
		1574
		1575	my ($match, $specificity);
		1576
		1577	for my $region (list) {
		1578	if ($region->{match} && $path =~ $region->{match}) {
		1579	($match, $specificity) = ($region, $region->specificity)
		1580	if $region->specificity > $specificity;
		1581	}
		1582	}
		1583
		1584	$match
		1585	}
1102		1586
1103	=back	1587	=back
1104
1105		1588
1106	=head3 cf::map	1589	=head3 cf::map
1107		1590
1108	=over 4	1591	=over 4
1109		1592
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1620	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1621	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1622	)
1140	}	1623	}
1141		1624
		1625	=item cf::map->register ($regex, $prio)
		1626
		1627	Register a handler for the map path matching the given regex at the
		1628	givne priority (higher is better, built-in handlers have priority 0, the
		1629	default).
		1630
		1631	=cut
		1632
1142	sub register {	1633	sub register {
1143	my (undef, $regex) = @_;	1634	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1635	my $pkg = caller;
1145		1636
1146	no strict;	1637	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1638	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1639
1149	$EXT_MAP{$pkg} = qr<$regex>;	1640	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1641	}
1151		1642
1152	# also paths starting with '/'	1643	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1644	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1645
1155	sub thawer_merge {	1646	sub thawer_merge {
1156	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1157		1648
1158	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1159	local $self->{path};	1650	local $self->{path};
1160	local $self->{load_path};	1651	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1652
1164	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1165	}	1654	}
1166		1655
1167	sub normalise {	1656	sub normalise {
1168	my ($path, $base) = @_;	1657	my ($path, $base) = @_;
		1658
		1659	$path = "$path"; # make sure its a string
		1660
		1661	$path =~ s/\.map$//;
1169		1662
1170	# map plan:	1663	# map plan:
1171	#	1664	#
1172	# /! non-realised random map exit (special hack!)	1665	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1666	# {... are special paths that are not being touched
…		…
1201		1694
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1695	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		1696
1204	$path = normalise $path, $base;	1697	$path = normalise $path, $base;
1205		1698
1206	for my $pkg (keys %EXT_MAP) {	1699	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1700	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1701	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1702	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1211	return $self;	1704	return $self;
1212	}	1705	}
1213	}	1706	}
1214		1707
1215	Carp::carp "unable to resolve path '$path'.";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1709	()
1217	}	1710	}
1218		1711
1219	sub init {	1712	sub init {
1220	my ($self) = @_;	1713	my ($self) = @_;
…		…
1235		1728
1236	# the original (read-only) location	1729	# the original (read-only) location
1237	sub load_path {	1730	sub load_path {
1238	my ($self) = @_;	1731	my ($self) = @_;
1239		1732
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1733	"$MAPDIR/$self->{path}.map"
1241	}	1734	}
1242		1735
1243	# the temporary/swap location	1736	# the temporary/swap location
1244	sub save_path {	1737	sub save_path {
1245	my ($self) = @_;	1738	my ($self) = @_;
1246		1739
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1740	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1741	"$TMPDIR/$path.map"
1249	}	1742	}
1250		1743
1251	# the unique path, undef == no special unique path	1744	# the unique path, undef == no special unique path
1252	sub uniq_path {	1745	sub uniq_path {
1253	my ($self) = @_;	1746	my ($self) = @_;
1254		1747
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1748	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1749	"$UNIQUEDIR/$path"
1257	}	1750	}
1258		1751
1259	# and all this just because we cannot iterate over	1752	# and all this just because we cannot iterate over
1260	# all maps in C++...	1753	# all maps in C++...
1261	sub change_all_map_light {	1754	sub change_all_map_light {
…		…
1263		1756
1264	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1265	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
1266	}	1759	}
1267		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
		1767	}
		1768
1268	sub unlink_save {	1769	sub unlink_save {
1269	my ($self) = @_;	1770	my ($self) = @_;
1270		1771
1271	utf8::encode (my $save = $self->save_path);	1772	utf8::encode (my $save = $self->save_path);
1272	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1773	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1275		1776
1276	sub load_header_from($) {	1777	sub load_header_from($) {
1277	my ($self, $path) = @_;	1778	my ($self, $path) = @_;
1278		1779
1279	utf8::encode $path;	1780	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1781	#aio_open $path, O_RDONLY, 0
1281	or return;	1782	# or return;
1282		1783
1283	$self->_load_header ($path)	1784	$self->_load_header ($path)
1284	or return;	1785	or return;
1285		1786
1286	$self->{load_path} = $path;	1787	$self->{load_path} = $path;
1287		1788
1288	1	1789	1
1289	}	1790	}
1290		1791
1291	sub load_orig {	1792	sub load_header_orig {
1292	my ($self) = @_;	1793	my ($self) = @_;
1293		1794
1294	$self->load_header_from ($self->load_path)	1795	$self->load_header_from ($self->load_path)
1295	}	1796	}
1296		1797
1297	sub load_temp {	1798	sub load_header_temp {
1298	my ($self) = @_;	1799	my ($self) = @_;
1299		1800
1300	$self->load_header_from ($self->save_path)	1801	$self->load_header_from ($self->save_path)
		1802	}
		1803
		1804	sub prepare_temp {
		1805	my ($self) = @_;
		1806
		1807	$self->last_access ((delete $self->{last_access})
		1808	|| $cf::RUNTIME); #d#
		1809	# safety
		1810	$self->{instantiate_time} = $cf::RUNTIME
		1811	if $self->{instantiate_time} > $cf::RUNTIME;
		1812	}
		1813
		1814	sub prepare_orig {
		1815	my ($self) = @_;
		1816
		1817	$self->{load_original} = 1;
		1818	$self->{instantiate_time} = $cf::RUNTIME;
		1819	$self->last_access ($cf::RUNTIME);
		1820	$self->instantiate;
1301	}	1821	}
1302		1822
1303	sub load_header {	1823	sub load_header {
1304	my ($self) = @_;	1824	my ($self) = @_;
1305		1825
1306	if ($self->load_temp) {	1826	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1827	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1828	} else {
1313	$self->load_orig	1829	$self->load_header_orig
1314	or return;	1830	or return;
1315		1831	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	1832	}
		1833
		1834	$self->{deny_reset} = 1
		1835	if $self->no_reset;
		1836
		1837	$self->default_region (cf::region::find_by_path $self->{path})
		1838	unless $self->default_region;
1321		1839
1322	1	1840	1
1323	}	1841	}
1324		1842
1325	sub find;	1843	sub find;
…		…
1338	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1339		1857
1340	$map->load_header	1858	$map->load_header
1341	or return;	1859	or return;
1342		1860
1343	if ($map->should_reset) {	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1862	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1345	$map->reset;	1864	$map->reset;
1346	undef $guard;	1865	undef $guard;
1347	$map = find $path	1866	return find $path;
1348	or return;
1349	}	1867	}
1350		1868
1351	$cf::MAP{$path} = $map	1869	$cf::MAP{$path} = $map
1352	}	1870	}
1353	}	1871	}
		1872
		1873	sub pre_load { }
		1874	sub post_load { }
1354		1875
1355	sub load {	1876	sub load {
1356	my ($self) = @_;	1877	my ($self) = @_;
1357		1878
		1879	local $self->{deny_reset} = 1; # loading can take a long time
		1880
1358	my $path = $self->{path};	1881	my $path = $self->{path};
		1882
		1883	{
1359	my $guard = cf::lock_acquire "map_load:$path";	1884	my $guard = cf::lock_acquire "map_load:$path";
1360		1885
1361	return if $self->in_memory != cf::MAP_SWAPPED;	1886	return if $self->in_memory != cf::MAP_SWAPPED;
1362		1887
1363	$self->in_memory (cf::MAP_LOADING);	1888	$self->in_memory (cf::MAP_LOADING);
1364		1889
1365	$self->alloc;	1890	$self->alloc;
1366	$self->_load_objects ($self->{load_path}, 1)
1367	or return;
1368		1891
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1892	$self->pre_load;
1370	if delete $self->{load_original};
1371
1372	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {
1375	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);
1377	}
1378	}
1379
1380	Coro::cede;
1381
1382	# now do the right thing for maps
1383	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;	1893	Coro::cede;
1390	$self->set_darkness_map;	1894
		1895	$self->_load_objects ($self->{load_path}, 1)
		1896	or return;
		1897
		1898	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1899	if delete $self->{load_original};
		1900
		1901	if (my $uniq = $self->uniq_path) {
		1902	utf8::encode $uniq;
		1903	if (aio_open $uniq, O_RDONLY, 0) {
		1904	$self->clear_unique_items;
		1905	$self->_load_objects ($uniq, 0);
		1906	}
		1907	}
		1908
		1909	Coro::cede;
		1910	# now do the right thing for maps
		1911	$self->link_multipart_objects;
1391	$self->difficulty ($self->estimate_difficulty)	1912	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	1913	unless $self->difficulty;
1393	Coro::cede;	1914	Coro::cede;
		1915
		1916	unless ($self->{deny_activate}) {
		1917	$self->decay_objects;
		1918	$self->fix_auto_apply;
		1919	$self->update_buttons;
		1920	Coro::cede;
		1921	$self->set_darkness_map;
		1922	Coro::cede;
1394	$self->activate;	1923	$self->activate;
1395	}	1924	}
1396		1925
1397	$self->in_memory (cf::MAP_IN_MEMORY);	1926	$self->in_memory (cf::MAP_IN_MEMORY);
		1927	}
		1928
		1929	$self->post_load;
1398	}	1930	}
1399		1931
1400	sub customise_for {	1932	sub customise_for {
1401	my ($self, $ob) = @_;	1933	my ($self, $ob) = @_;
1402		1934
1403	return find "~" . $ob->name . "/" . $self->{path}	1935	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	1936	if $self->per_player;
		1937
		1938	# return find "?party/" . $ob->name . "/" . $self->{path}
		1939	# if $self->per_party;
1405		1940
1406	$self	1941	$self
1407	}	1942	}
1408		1943
1409	# find and load all maps in the 3x3 area around a map	1944	# find and load all maps in the 3x3 area around a map
…		…
1456		1991
1457	undef $MAP_PREFETCH{$path};	1992	undef $MAP_PREFETCH{$path};
1458	$MAP_PREFETCHER ||= cf::async {	1993	$MAP_PREFETCHER ||= cf::async {
1459	while (%MAP_PREFETCH) {	1994	while (%MAP_PREFETCH) {
1460	for my $path (keys %MAP_PREFETCH) {	1995	for my $path (keys %MAP_PREFETCH) {
1461	my $map = find $path	1996	if (my $map = find $path) {
1462	or next;
1463	$map->load;	1997	$map->load;
		1998	}
1464		1999
1465	delete $MAP_PREFETCH{$path};	2000	delete $MAP_PREFETCH{$path};
1466	}	2001	}
1467	}	2002	}
1468	undef $MAP_PREFETCHER;	2003	undef $MAP_PREFETCHER;
1469	};	2004	};
		2005	$MAP_PREFETCHER->prio (6);
1470		2006
1471	()	2007	()
1472	}	2008	}
1473		2009
1474	sub save {	2010	sub save {
…		…
1519		2055
1520	sub reset_at {	2056	sub reset_at {
1521	my ($self) = @_;	2057	my ($self) = @_;
1522		2058
1523	# TODO: safety, remove and allow resettable per-player maps	2059	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2060	return 1e99 if $self->{deny_reset};
1526		2061
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2062	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2063	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529		2064
…		…
1540	my ($self) = @_;	2075	my ($self) = @_;
1541		2076
1542	my $lock = cf::lock_acquire "map_data:$self->{path}";	2077	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		2078
1544	return if $self->players;	2079	return if $self->players;
1545	return if $self->isa ("ext::map_per_player");#d#
1546		2080
1547	warn "resetting map ", $self->path;#d#	2081	warn "resetting map ", $self->path;
		2082
		2083	$self->in_memory (cf::MAP_SWAPPED);
		2084
		2085	# need to save uniques path
		2086	unless ($self->{deny_save}) {
		2087	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2088
		2089	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2090	if $uniq;
		2091	}
1548		2092
1549	delete $cf::MAP{$self->path};	2093	delete $cf::MAP{$self->path};
1550		2094
1551	$self->in_memory (cf::MAP_SWAPPED);
1552	$self->clear;	2095	$self->clear;
1553		2096
1554	$_->clear_links_to ($self) for values %cf::MAP;	2097	$_->clear_links_to ($self) for values %cf::MAP;
1555		2098
1556	$self->unlink_save;	2099	$self->unlink_save;
…		…
1575	$cf::MAP{$self->path} = $self;	2118	$cf::MAP{$self->path} = $self;
1576		2119
1577	$self->reset; # polite request, might not happen	2120	$self->reset; # polite request, might not happen
1578	}	2121	}
1579		2122
		2123	=item $maps = cf::map::tmp_maps
		2124
		2125	Returns an arrayref with all map paths of currently instantiated and saved
		2126	maps. May block.
		2127
		2128	=cut
		2129
		2130	sub tmp_maps() {
		2131	[
		2132	map {
		2133	utf8::decode $_;
		2134	/\.map$/
		2135	? normalise $_
		2136	: ()
		2137	} @{ aio_readdir $TMPDIR or [] }
		2138	]
		2139	}
		2140
		2141	=item $maps = cf::map::random_maps
		2142
		2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	random maps. May block.
		2145
		2146	=cut
		2147
		2148	sub random_maps() {
		2149	[
		2150	map {
		2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise "?random/$_"
		2154	: ()
		2155	} @{ aio_readdir $RANDOMDIR or [] }
		2156	]
		2157	}
		2158
1580	=item cf::map::unique_maps	2159	=item cf::map::unique_maps
1581		2160
1582	Returns an arrayref of paths of all shared maps that have	2161	Returns an arrayref of paths of all shared maps that have
1583	instantiated unique items. May block.	2162	instantiated unique items. May block.
1584		2163
1585	=cut	2164	=cut
1586		2165
1587	sub unique_maps() {	2166	sub unique_maps() {
1588	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2167	[
1589	or return;	2168	map {
1590
1591	my @paths;
1592
1593	for (@$files) {
1594	utf8::decode $_;	2169	utf8::decode $_;
1595	next if /\.pst$/;
1596	next unless /^$PATH_SEP/o;
1597
1598	s/\.map$//;	2170	/\.map$/
1599	push @paths, $_;	2171	? normalise $_
		2172	: ()
		2173	} @{ aio_readdir $UNIQUEDIR or [] }
1600	}	2174	]
1601
1602	\@paths
1603	}	2175	}
1604		2176
1605	package cf;	2177	package cf;
1606		2178
1607	=back	2179	=back
…		…
1653		2225
1654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2226	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1655		2227
1656	if ($self->{record_replies}) {	2228	if ($self->{record_replies}) {
1657	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2229	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2230
1658	} else {	2231	} else {
		2232	my $pl = $self->contr;
		2233
		2234	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2235	my $dialog = $pl->{npc_dialog};
		2236	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2237
		2238	} else {
1659	$msg = $npc->name . " says: $msg" if $npc;	2239	$msg = $npc->name . " says: $msg" if $npc;
1660	$self->message ($msg, $flags);	2240	$self->message ($msg, $flags);
		2241	}
1661	}	2242	}
1662	}	2243	}
1663		2244
1664	=item $player_object->may ("access")	2245	=item $player_object->may ("access")
1665		2246
…		…
1698	=cut	2279	=cut
1699		2280
1700	sub link_map {	2281	sub link_map {
1701	unless ($LINK_MAP) {	2282	unless ($LINK_MAP) {
1702	$LINK_MAP = cf::map::find "{link}"	2283	$LINK_MAP = cf::map::find "{link}"
1703	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2284	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1704	$LINK_MAP->load;	2285	$LINK_MAP->load;
1705	}	2286	}
1706		2287
1707	$LINK_MAP	2288	$LINK_MAP
1708	}	2289	}
…		…
1713	$self->deactivate_recursive;	2294	$self->deactivate_recursive;
1714		2295
1715	return if UNIVERSAL::isa $self->map, "ext::map_link";	2296	return if UNIVERSAL::isa $self->map, "ext::map_link";
1716		2297
1717	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2298	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718	if $self->map;	2299	if $self->map && $self->map->{path} ne "{link}";
1719		2300
1720	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2301	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1721	}	2302	}
1722		2303
1723	sub cf::object::player::leave_link {	2304	sub cf::object::player::leave_link {
1724	my ($self, $map, $x, $y) = @_;	2305	my ($self, $map, $x, $y) = @_;
		2306
		2307	return unless $self->contr->active;
1725		2308
1726	my $link_pos = delete $self->{_link_pos};	2309	my $link_pos = delete $self->{_link_pos};
1727		2310
1728	unless ($map) {	2311	unless ($map) {
1729	# restore original map position	2312	# restore original map position
…		…
1747	$map->load;	2330	$map->load;
1748	$map->load_diag;	2331	$map->load_diag;
1749		2332
1750	return unless $self->contr->active;	2333	return unless $self->contr->active;
1751	$self->activate_recursive;	2334	$self->activate_recursive;
		2335
		2336	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1752	$self->enter_map ($map, $x, $y);	2337	$self->enter_map ($map, $x, $y);
1753	}	2338	}
1754		2339
1755	cf::player->attach (	2340	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1756	on_logout => sub {
1757	my ($pl) = @_;
1758		2341
1759	# abort map switching before logout	2342	Moves the player to the given map-path and coordinates by first freezing
1760	if ($pl->ob->{_link_pos}) {	2343	her, loading and preparing them map, calling the provided $check callback
1761	cf::sync_job {	2344	that has to return the map if sucecssful, and then unfreezes the player on
1762	$pl->ob->leave_link	2345	the new (success) or old (failed) map position. In either case, $done will
1763	};	2346	be called at the end of this process.
1764	}
1765	},
1766	on_login => sub {
1767	my ($pl) = @_;
1768		2347
1769	# try to abort aborted map switching on player login :)
1770	# should happen only on crashes
1771	if ($pl->ob->{_link_pos}) {
1772	$pl->ob->enter_link;
1773	(async {
1774	# we need this sleep as the login has a concurrent enter_exit running
1775	# and this sleep increases chances of the player not ending up in scorn
1776	$pl->ob->reply (undef,
1777	"There was an internal problem at your last logout, "
1778	. "the server will try to bring you to your intended destination in a second.",
1779	cf::NDI_RED);
1780	Coro::Timer::sleep 1;
1781	$pl->ob->leave_link;
1782	})->prio (2);
1783	}
1784	},
1785	);
1786
1787	=item $player_object->goto ($path, $x, $y)
1788
1789	=cut	2348	=cut
		2349
		2350	our $GOTOGEN;
1790		2351
1791	sub cf::object::player::goto {	2352	sub cf::object::player::goto {
1792	my ($self, $path, $x, $y) = @_;	2353	my ($self, $path, $x, $y, $check, $done) = @_;
		2354
		2355	# do generation counting so two concurrent goto's will be executed in-order
		2356	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1793		2357
1794	$self->enter_link;	2358	$self->enter_link;
1795		2359
1796	(async {	2360	(async {
		2361	my $map = eval {
1797	my $map = cf::map::find $path;	2362	my $map = cf::map::find $path;
		2363
		2364	if ($map) {
1798	$map = $map->customise_for ($self) if $map;	2365	$map = $map->customise_for ($self);
1799		2366	$map = $check->($map) if $check && $map;
1800	# warn "entering ", $map->path, " at ($x, $y)\n"	2367	} else {
1801	# if $map;
1802
1803	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2368	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	}
1804		2370
		2371	$map
		2372	};
		2373
		2374	if ($@) {
		2375	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2376	LOG llevError | logBacktrace, Carp::longmess $@;
		2377	}
		2378
		2379	if ($gen == $self->{_goto_generation}) {
		2380	delete $self->{_goto_generation};
1805	$self->leave_link ($map, $x, $y);	2381	$self->leave_link ($map, $x, $y);
		2382	}
		2383
		2384	$done->() if $done;
1806	})->prio (1);	2385	})->prio (1);
1807	}	2386	}
1808		2387
1809	=item $player_object->enter_exit ($exit_object)	2388	=item $player_object->enter_exit ($exit_object)
1810		2389
…		…
1839	# that depends on the exit object	2418	# that depends on the exit object
1840		2419
1841	my $rmp = parse_random_map_params $exit->msg;	2420	my $rmp = parse_random_map_params $exit->msg;
1842		2421
1843	if ($exit->map) {	2422	if ($exit->map) {
1844	$rmp->{region} = $exit->map->region_name;	2423	$rmp->{region} = $exit->region->name;
1845	$rmp->{origin_map} = $exit->map->path;	2424	$rmp->{origin_map} = $exit->map->path;
1846	$rmp->{origin_x} = $exit->x;	2425	$rmp->{origin_x} = $exit->x;
1847	$rmp->{origin_y} = $exit->y;	2426	$rmp->{origin_y} = $exit->y;
1848	}	2427	}
1849		2428
1850	$rmp->{random_seed} ||= $exit->random_seed;	2429	$rmp->{random_seed} ||= $exit->random_seed;
1851		2430
1852	my $data = cf::to_json $rmp;	2431	my $data = cf::to_json $rmp;
1853	my $md5 = Digest::MD5::md5_hex $data;	2432	my $md5 = Digest::MD5::md5_hex $data;
1854	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2433	my $meta = "$RANDOMDIR/$md5.meta";
1855		2434
1856	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2435	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2436	aio_write $fh, 0, (length $data), $data, 0;
1858	undef $fh;	2437	undef $fh;
1859	aio_rename "$meta~", $meta;	2438	aio_rename "$meta~", $meta;
…		…
1866	sub cf::object::player::enter_exit {	2445	sub cf::object::player::enter_exit {
1867	my ($self, $exit) = @_;	2446	my ($self, $exit) = @_;
1868		2447
1869	return unless $self->type == cf::PLAYER;	2448	return unless $self->type == cf::PLAYER;
1870		2449
		2450	if ($exit->slaying eq "/!") {
		2451	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2452	# the problem is that $exit might not survive long enough
		2453	# so it needs to be done right now, right here
		2454	cf::sync_job { prepare_random_map $exit };
		2455	}
		2456
		2457	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2458	my $hp = $exit->stats->hp;
		2459	my $sp = $exit->stats->sp;
		2460
1871	$self->enter_link;	2461	$self->enter_link;
		2462
		2463	# if exit is damned, update players death & WoR home-position
		2464	$self->contr->savebed ($slaying, $hp, $sp)
		2465	if $exit->flag (FLAG_DAMNED);
1872		2466
1873	(async {	2467	(async {
1874	$self->deactivate_recursive; # just to be sure	2468	$self->deactivate_recursive; # just to be sure
1875	unless (eval {	2469	unless (eval {
1876	prepare_random_map $exit	2470	$self->goto ($slaying, $hp, $sp);
1877	if $exit->slaying eq "/!";
1878
1879	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1880	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1881		2471
1882	1;	2472	1;
1883	}) {	2473	}) {
1884	$self->message ("Something went wrong deep within the crossfire server. "	2474	$self->message ("Something went wrong deep within the crossfire server. "
1885	. "I'll try to bring you back to the map you were before. "	2475	. "I'll try to bring you back to the map you were before. "
1886	. "Please report this to the dungeon master!",	2476	. "Please report this to the dungeon master!",
1887	cf::NDI_UNIQUE | cf::NDI_RED);	2477	cf::NDI_UNIQUE | cf::NDI_RED);
1888		2478
1889	warn "ERROR in enter_exit: $@";	2479	warn "ERROR in enter_exit: $@";
1890	$self->leave_link;	2480	$self->leave_link;
1891	}	2481	}
1892	})->prio (1);	2482	})->prio (1);
…		…
1905		2495
1906	sub cf::client::send_drawinfo {	2496	sub cf::client::send_drawinfo {
1907	my ($self, $text, $flags) = @_;	2497	my ($self, $text, $flags) = @_;
1908		2498
1909	utf8::encode $text;	2499	utf8::encode $text;
1910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2500	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1911	}	2501	}
1912		2502
		2503	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2504
		2505	Send a drawinfo or msg packet to the client, formatting the msg for the
		2506	client if neccessary. C<$type> should be a string identifying the type of
		2507	the message, with C<log> being the default. If C<$color> is negative, suppress
		2508	the message unless the client supports the msg packet.
		2509
		2510	=cut
		2511
		2512	sub cf::client::send_msg {
		2513	my ($self, $channel, $msg, $color, @extra) = @_;
		2514
		2515	$msg = $self->pl->expand_cfpod ($msg);
		2516
		2517	$color &= ~cf::NDI_UNIQUE; # just in case...
		2518
		2519	if (ref $channel) {
		2520	# send meta info to client, if not yet sent
		2521	unless (exists $self->{channel}{$channel->{id}}) {
		2522	$self->{channel}{$channel->{id}} = $channel;
		2523	$self->ext_msg (channel_info => $channel);
		2524	}
		2525
		2526	$channel = $channel->{id};
		2527	}
		2528
		2529	return unless @extra || length $msg;
		2530
		2531	if ($self->can_msg) {
		2532	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2533	} else {
		2534	# replace some tags by gcfclient-compatible ones
		2535	for ($msg) {
		2536	1 while
		2537	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2538	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2539	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2540	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2541	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2542	}
		2543
		2544	if ($color >= 0) {
		2545	if (0 && $msg =~ /\[/) {
		2546	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
		2555	=item $client->ext_msg ($type, @msg)
		2556
		2557	Sends an ext event to the client.
		2558
		2559	=cut
		2560
		2561	sub cf::client::ext_msg($$@) {
		2562	my ($self, $type, @msg) = @_;
		2563
		2564	my $extcmd = $self->extcmd;
		2565
		2566	if ($extcmd == 2) {
		2567	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2568	} elsif ($extcmd == 1) { # TODO: remove
		2569	push @msg, msgtype => "event_$type";
		2570	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2571	}
		2572	}
1913		2573
1914	=item $success = $client->query ($flags, "text", \&cb)	2574	=item $success = $client->query ($flags, "text", \&cb)
1915		2575
1916	Queues a query to the client, calling the given callback with	2576	Queues a query to the client, calling the given callback with
1917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1918	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2578	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1919		2579
1920	Queries can fail, so check the return code. Or don't, as queries will become	2580	Queries can fail, so check the return code. Or don't, as queries will
1921	reliable at some point in the future.	2581	become reliable at some point in the future.
1922		2582
1923	=cut	2583	=cut
1924		2584
1925	sub cf::client::query {	2585	sub cf::client::query {
1926	my ($self, $flags, $text, $cb) = @_;	2586	my ($self, $flags, $text, $cb) = @_;
…		…
1934	utf8::encode $text;	2594	utf8::encode $text;
1935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1936		2596
1937	$self->send_packet ($self->{query_queue}[0][0])	2597	$self->send_packet ($self->{query_queue}[0][0])
1938	if @{ $self->{query_queue} } == 1;	2598	if @{ $self->{query_queue} } == 1;
		2599
		2600	1
1939	}	2601	}
1940		2602
1941	cf::client->attach (	2603	cf::client->attach (
		2604	on_connect => sub {
		2605	my ($ns) = @_;
		2606
		2607	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2608	},
1942	on_reply => sub {	2609	on_reply => sub {
1943	my ($ns, $msg) = @_;	2610	my ($ns, $msg) = @_;
1944		2611
1945	# this weird shuffling is so that direct followup queries	2612	# this weird shuffling is so that direct followup queries
1946	# get handled first	2613	# get handled first
1947	my $queue = delete $ns->{query_queue}	2614	my $queue = delete $ns->{query_queue}
1948	or return; # be conservative, not sure how that can happen, but we saw a crash here	2615	or return; # be conservative, not sure how that can happen, but we saw a crash here
1949		2616
1950	(shift @$queue)->[1]->($msg);	2617	(shift @$queue)->[1]->($msg);
		2618	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1951		2619
1952	push @{ $ns->{query_queue} }, @$queue;	2620	push @{ $ns->{query_queue} }, @$queue;
1953		2621
1954	if (@{ $ns->{query_queue} } == @$queue) {	2622	if (@{ $ns->{query_queue} } == @$queue) {
1955	if (@$queue) {	2623	if (@$queue) {
…		…
1957	} else {	2625	} else {
1958	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2626	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1959	}	2627	}
1960	}	2628	}
1961	},	2629	},
		2630	on_exticmd => sub {
		2631	my ($ns, $buf) = @_;
		2632
		2633	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2634
		2635	if (ref $msg) {
		2636	my ($type, $reply, @payload) =
		2637	"ARRAY" eq ref $msg
		2638	? @$msg
		2639	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2640
		2641	if (my $cb = $EXTICMD{$type}) {
		2642	my @reply = $cb->($ns, @payload);
		2643
		2644	$ns->ext_reply ($reply, @reply)
		2645	if $reply;
		2646	}
		2647	} else {
		2648	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2649	}
		2650
		2651	cf::override;
		2652	},
1962	);	2653	);
1963		2654
1964	=item $client->async (\&cb)	2655	=item $client->async (\&cb)
1965		2656
1966	Create a new coroutine, running the specified callback. The coroutine will	2657	Create a new coroutine, running the specified callback. The coroutine will
…		…
2013		2704
2014	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
2015		2706
2016	=pod	2707	=pod
2017		2708
2018	The following fucntions and emthods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2019		2710
2020	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove
		2714
2021	cf::object::player player	2715	cf::object::player
2022	cf::player peaceful	2716	player
2023	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2024		2723
2025	=cut	2724	=cut
2026		2725
2027	for (	2726	for (
2028	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove)],
2029	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2030	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2031	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2032	) {	2732	) {
2033	no strict 'refs';	2733	no strict 'refs';
…		…
2104	=back	2804	=back
2105		2805
2106	=cut	2806	=cut
2107		2807
2108	#############################################################################	2808	#############################################################################
		2809	# the server's init and main functions
2109		2810
2110	=head2 EXTENSION DATABASE SUPPORT	2811	sub load_facedata($) {
		2812	my ($path) = @_;
2111		2813
2112	Crossfire maintains a very simple database for extension use. It can	2814	warn "loading facedata from $path\n";
2113	currently store anything that can be serialised using Storable, which
2114	excludes objects.
2115		2815
2116	The parameter C<$family> should best start with the name of the extension	2816	my $facedata;
2117	using it, it should be unique.	2817	0 < aio_load $path, $facedata
		2818	or die "$path: $!";
2118		2819
2119	=over 4	2820	$facedata = Coro::Storable::thaw $facedata;
2120		2821
2121	=item $hashref = cf::db_get $family	2822	$facedata->{version} == 2
		2823	or cf::cleanup "$path: version mismatch, cannot proceed.";
2122		2824
2123	Return a hashref for use by the extension C<$family>, which can be
2124	modified. After modifications, you have to call C<cf::db_dirty> or
2125	C<cf::db_sync>.
2126
2127	=item $value = cf::db_get $family => $key
2128
2129	Returns a single value from the database
2130
2131	=item cf::db_put $family => $hashref
2132
2133	Stores the given family hashref into the database. Updates are delayed, if
2134	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2135
2136	=item cf::db_put $family => $key => $value
2137
2138	Stores the given C<$value> in the family hash. Updates are delayed, if you
2139	want the data to be synced to disk immediately, use C<cf::db_sync>.
2140
2141	=item cf::db_dirty
2142
2143	Marks the database as dirty, to be updated at a later time.
2144
2145	=item cf::db_sync
2146
2147	Immediately write the database to disk I<if it is dirty>.
2148
2149	=cut
2150
2151	our $DB;
2152
2153	{
2154	my $path = cf::localdir . "/database.pst";
2155
2156	sub db_load() {
2157	$DB = stat $path ? Storable::retrieve $path : { };
2158	}	2825	{
		2826	my $faces = $facedata->{faceinfo};
2159		2827
2160	my $pid;	2828	while (my ($face, $info) = each %$faces) {
		2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
		2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2161		2834
2162	sub db_save() {	2835	cf::cede_to_tick;
2163	waitpid $pid, 0 if $pid;
2164	if (0 == ($pid = fork)) {
2165	$DB->{_meta}{version} = 1;
2166	Storable::nstore $DB, "$path~";
2167	rename "$path~", $path;
2168	cf::_exit 0 if defined $pid;
2169	}
2170	}
2171
2172	my $dirty;
2173
2174	sub db_sync() {
2175	db_save if $dirty;
2176	undef $dirty;
2177	}
2178
2179	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2180	db_sync;
2181	});
2182
2183	sub db_dirty() {
2184	$dirty = 1;
2185	$idle->start;
2186	}
2187
2188	sub db_get($;$) {
2189	@_ >= 2
2190	? $DB->{$_[0]}{$_[1]}
2191	: ($DB->{$_[0]} ||= { })
2192	}
2193
2194	sub db_put($$;$) {
2195	if (@_ >= 3) {
2196	$DB->{$_[0]}{$_[1]} = $_[2];
2197	} else {
2198	$DB->{$_[0]} = $_[1];
2199	}
2200	db_dirty;
2201	}
2202
2203	cf::global->attach (
2204	prio => 10000,
2205	on_cleanup => sub {
2206	db_sync;
2207	},	2836	}
2208	);
2209	}
2210		2837
2211	#############################################################################	2838	while (my ($face, $info) = each %$faces) {
2212	# the server's main()	2839	next unless $info->{smooth};
		2840	my $idx = cf::face::find $face
		2841	or next;
		2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
		2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2845	} else {
		2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2847	}
		2848
		2849	cf::cede_to_tick;
		2850	}
		2851	}
		2852
		2853	{
		2854	my $anims = $facedata->{animinfo};
		2855
		2856	while (my ($anim, $info) = each %$anims) {
		2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2858	cf::cede_to_tick;
		2859	}
		2860
		2861	cf::anim::invalidate_all; # d'oh
		2862	}
		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	my $soundconf = delete $res->{"res/sound.conf"};
		2871
		2872	while (my ($name, $info) = each %$res) {
		2873	my $meta = $enc->encode ({
		2874	name => $name,
		2875	%{ $info->{meta} || {} },
		2876	});
		2877
		2878	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2879
		2880	if ($info->{type} & 1) {
		2881	# prepend meta info
		2882
		2883	my $data = pack "(w/a*)*", $meta, $info->{data};
		2884	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2885
		2886	cf::face::set_data $idx, 0, $data, $chk;
		2887	} else {
		2888	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2889	}
		2890
		2891	cf::face::set_type $idx, $info->{type};
		2892
		2893	cf::cede_to_tick;
		2894	}
		2895
		2896	if ($soundconf) {
		2897	$soundconf = $enc->decode (delete $soundconf->{data});
		2898
		2899	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2900	my $sound = $soundconf->{compat}[$_]
		2901	or next;
		2902
		2903	my $face = cf::face::find "sound/$sound->[1]";
		2904
		2905	cf::sound::set $sound->[0] => $face;
		2906	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2907	}
		2908
		2909	#TODO
		2910	}
		2911	}
		2912
		2913	1
		2914	}
		2915
		2916	register_exticmd fx_want => sub {
		2917	my ($ns, $want) = @_;
		2918
		2919	while (my ($k, $v) = each %$want) {
		2920	$ns->fx_want ($k, $v);
		2921	}
		2922	};
		2923
		2924	sub reload_regions {
		2925	load_resource_file "$MAPDIR/regions"
		2926	or die "unable to load regions file\n";
		2927
		2928	for (cf::region::list) {
		2929	$_->{match} = qr/$_->{match}/
		2930	if exists $_->{match};
		2931	}
		2932	}
		2933
		2934	sub reload_facedata {
		2935	load_facedata "$DATADIR/facedata"
		2936	or die "unable to load facedata\n";
		2937	}
		2938
		2939	sub reload_archetypes {
		2940	load_resource_file "$DATADIR/archetypes"
		2941	or die "unable to load archetypes\n";
		2942	#d# NEED to laod twice to resolve forward references
		2943	# this really needs to be done in an extra post-pass
		2944	# (which needs to be synchronous, so solve it differently)
		2945	load_resource_file "$DATADIR/archetypes"
		2946	or die "unable to load archetypes\n";
		2947	}
		2948
		2949	sub reload_treasures {
		2950	load_resource_file "$DATADIR/treasures"
		2951	or die "unable to load treasurelists\n";
		2952	}
		2953
		2954	sub reload_resources {
		2955	warn "reloading resource files...\n";
		2956
		2957	reload_regions;
		2958	reload_facedata;
		2959	#reload_archetypes;#d#
		2960	reload_archetypes;
		2961	reload_treasures;
		2962
		2963	warn "finished reloading resource files\n";
		2964	}
		2965
		2966	sub init {
		2967	reload_resources;
		2968	}
2213		2969
2214	sub cfg_load {	2970	sub cfg_load {
2215	open my $fh, "<:utf8", cf::confdir . "/config"	2971	open my $fh, "<:utf8", "$CONFDIR/config"
2216	or return;	2972	or return;
2217		2973
2218	local $/;	2974	local $/;
2219	*CFG = YAML::Syck::Load <$fh>;	2975	*CFG = YAML::Syck::Load <$fh>;
2220		2976
…		…
2240	Event::one_event;	2996	Event::one_event;
2241	})->prio (Coro::PRIO_MAX);	2997	})->prio (Coro::PRIO_MAX);
2242	};	2998	};
2243		2999
2244	cfg_load;	3000	cfg_load;
2245	db_load;	3001	db_init;
2246	load_extensions;	3002	load_extensions;
2247		3003
2248	$TICK_WATCHER->start;	3004	$TICK_WATCHER->start;
2249	Event::loop;	3005	Event::loop;
2250	}	3006	}
…		…
2254		3010
2255	# install some emergency cleanup handlers	3011	# install some emergency cleanup handlers
2256	BEGIN {	3012	BEGIN {
2257	for my $signal (qw(INT HUP TERM)) {	3013	for my $signal (qw(INT HUP TERM)) {
2258	Event->signal (	3014	Event->signal (
		3015	reentrant => 0,
2259	data => WF_AUTOCANCEL,	3016	data => WF_AUTOCANCEL,
2260	signal => $signal,	3017	signal => $signal,
		3018	prio => 0,
2261	cb => sub {	3019	cb => sub {
2262	cf::cleanup "SIG$signal";	3020	cf::cleanup "SIG$signal";
2263	},	3021	},
2264	);	3022	);
2265	}	3023	}
		3024	}
		3025
		3026	sub write_runtime {
		3027	my $runtime = "$LOCALDIR/runtime";
		3028
		3029	# first touch the runtime file to show we are still running:
		3030	# the fsync below can take a very very long time.
		3031
		3032	IO::AIO::aio_utime $runtime, undef, undef;
		3033
		3034	my $guard = cf::lock_acquire "write_runtime";
		3035
		3036	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3037	or return;
		3038
		3039	my $value = $cf::RUNTIME + 90 + 10;
		3040	# 10 is the runtime save interval, for a monotonic clock
		3041	# 60 allows for the watchdog to kill the server.
		3042
		3043	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3044	and return;
		3045
		3046	# always fsync - this file is important
		3047	aio_fsync $fh
		3048	and return;
		3049
		3050	# touch it again to show we are up-to-date
		3051	aio_utime $fh, undef, undef;
		3052
		3053	close $fh
		3054	or return;
		3055
		3056	aio_rename "$runtime~", $runtime
		3057	and return;
		3058
		3059	warn "runtime file written.\n";
		3060
		3061	1
2266	}	3062	}
2267		3063
2268	sub emergency_save() {	3064	sub emergency_save() {
2269	my $freeze_guard = cf::freeze_mainloop;	3065	my $freeze_guard = cf::freeze_mainloop;
2270		3066
…		…
2287	my $map = $cf::MAP{$path} or next;	3083	my $map = $cf::MAP{$path} or next;
2288	$map->valid or next;	3084	$map->valid or next;
2289	$map->save;	3085	$map->save;
2290	}	3086	}
2291	warn "end emergency map save\n";	3087	warn "end emergency map save\n";
		3088
		3089	warn "begin emergency database checkpoint\n";
		3090	BDB::db_env_txn_checkpoint $DB_ENV;
		3091	warn "end emergency database checkpoint\n";
2292	};	3092	};
2293		3093
2294	warn "leave emergency perl save\n";	3094	warn "leave emergency perl save\n";
2295	}	3095	}
2296		3096
		3097	sub post_cleanup {
		3098	my ($make_core) = @_;
		3099
		3100	warn Carp::longmess "post_cleanup backtrace"
		3101	if $make_core;
		3102	}
		3103
2297	sub reload() {	3104	sub do_reload_perl() {
2298	# can/must only be called in main	3105	# can/must only be called in main
2299	if ($Coro::current != $Coro::main) {	3106	if ($Coro::current != $Coro::main) {
2300	warn "can only reload from main coroutine";	3107	warn "can only reload from main coroutine";
2301	return;	3108	return;
2302	}	3109	}
2303		3110
2304	warn "reloading...";	3111	warn "reloading...";
2305		3112
2306	warn "cancelling server ticker";	3113	warn "entering sync_job";
2307	$TICK_WATCHER->cancel;
2308		3114
		3115	cf::sync_job {
		3116	cf::write_runtime; # external watchdog should not bark
2309	cf::emergency_save;	3117	cf::emergency_save;
		3118	cf::write_runtime; # external watchdog should not bark
2310		3119
2311	eval {	3120	warn "syncing database to disk";
		3121	BDB::db_env_txn_checkpoint $DB_ENV;
		3122
2312	# if anything goes wrong in here, we should simply crash as we already saved	3123	# if anything goes wrong in here, we should simply crash as we already saved
2313
2314	warn "syncing database to disk";
2315	cf::db_sync;
2316		3124
2317	warn "cancelling all WF_AUTOCANCEL watchers";	3125	warn "cancelling all WF_AUTOCANCEL watchers";
2318	for (Event::all_watchers) {	3126	for (Event::all_watchers) {
2319	$_->cancel if $_->data & WF_AUTOCANCEL;	3127	$_->cancel if $_->data & WF_AUTOCANCEL;
2320	}	3128	}
2321		3129
2322	warn "flushing outstanding aio requests";	3130	warn "flushing outstanding aio requests";
2323	for (;;) {	3131	for (;;) {
		3132	BDB::flush;
2324	IO::AIO::flush;	3133	IO::AIO::flush;
2325	Coro::cede;	3134	Coro::cede;
2326	last unless IO::AIO::nreqs;	3135	last unless IO::AIO::nreqs || BDB::nreqs;
2327	warn "iterate...";	3136	warn "iterate...";
2328	}	3137	}
		3138
		3139	++$RELOAD;
2329		3140
2330	warn "cancelling all extension coros";	3141	warn "cancelling all extension coros";
2331	$_->cancel for values %EXT_CORO;	3142	$_->cancel for values %EXT_CORO;
2332	%EXT_CORO = ();	3143	%EXT_CORO = ();
2333		3144
2334	warn "removing commands";	3145	warn "removing commands";
2335	%COMMAND = ();	3146	%COMMAND = ();
2336		3147
2337	warn "removing ext commands";	3148	warn "removing ext/exti commands";
2338	%EXTCMD = ();	3149	%EXTCMD = ();
		3150	%EXTICMD = ();
2339		3151
2340	warn "unloading/nuking all extensions";	3152	warn "unloading/nuking all extensions";
2341	for my $pkg (@EXTS) {	3153	for my $pkg (@EXTS) {
2342	warn "... unloading $pkg";	3154	warn "... unloading $pkg";
2343		3155
…		…
2373	Symbol::delete_package "safe::$_"	3185	Symbol::delete_package "safe::$_"
2374	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3186	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2375		3187
2376	warn "unloading cf.pm \"a bit\"";	3188	warn "unloading cf.pm \"a bit\"";
2377	delete $INC{"cf.pm"};	3189	delete $INC{"cf.pm"};
		3190	delete $INC{"cf/pod.pm"};
2378		3191
2379	# don't, removes xs symbols, too,	3192	# don't, removes xs symbols, too,
2380	# and global variables created in xs	3193	# and global variables created in xs
2381	#Symbol::delete_package __PACKAGE__;	3194	#Symbol::delete_package __PACKAGE__;
2382		3195
…		…
2386	require cf;	3199	require cf;
2387	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3200	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2388		3201
2389	warn "loading config and database again";	3202	warn "loading config and database again";
2390	cf::cfg_load;	3203	cf::cfg_load;
2391	cf::db_load;
2392		3204
2393	warn "loading extensions";	3205	warn "loading extensions";
2394	cf::load_extensions;	3206	cf::load_extensions;
2395		3207
2396	warn "reattaching attachments to objects/players";	3208	warn "reattaching attachments to objects/players";
2397	_global_reattach;	3209	_global_reattach; # objects, sockets
2398	warn "reattaching attachments to maps";	3210	warn "reattaching attachments to maps";
2399	reattach $_ for values %MAP;	3211	reattach $_ for values %MAP;
		3212	warn "reattaching attachments to players";
		3213	reattach $_ for values %PLAYER;
2400		3214
2401	warn "restarting server ticker";	3215	warn "leaving sync_job";
2402		3216
2403	$TICK_WATCHER->start;	3217	1
2404	};	3218	} or do {
2405
2406	if ($@) {
2407	warn $@;	3219	warn $@;
2408	warn "error while reloading, exiting.";	3220	warn "error while reloading, exiting.";
2409	exit 1;	3221	exit 1;
2410	}	3222	};
2411		3223
2412	warn "reloaded";	3224	warn "reloaded";
2413	};	3225	};
2414		3226
2415	our $RELOAD_WATCHER; # used only during reload	3227	our $RELOAD_WATCHER; # used only during reload
2416		3228
		3229	sub reload_perl() {
		3230	# doing reload synchronously and two reloads happen back-to-back,
		3231	# coro crashes during coro_state_free->destroy here.
		3232
		3233	$RELOAD_WATCHER ||= Event->timer (
		3234	reentrant => 0,
		3235	after => 0,
		3236	data => WF_AUTOCANCEL,
		3237	cb => sub {
		3238	do_reload_perl;
		3239	undef $RELOAD_WATCHER;
		3240	},
		3241	);
		3242	}
		3243
2417	register_command "reload" => sub {	3244	register_command "reload" => sub {
2418	my ($who, $arg) = @_;	3245	my ($who, $arg) = @_;
2419		3246
2420	if ($who->flag (FLAG_WIZ)) {	3247	if ($who->flag (FLAG_WIZ)) {
2421	$who->message ("reloading server.");	3248	$who->message ("reloading server.");
2422		3249	async { reload_perl };
2423	# doing reload synchronously and two reloads happen back-to-back,
2424	# coro crashes during coro_state_free->destroy here.
2425
2426	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2427	reload;
2428	undef $RELOAD_WATCHER;
2429	});
2430	}	3250	}
2431	};	3251	};
2432		3252
2433	unshift @INC, $LIBDIR;	3253	unshift @INC, $LIBDIR;
2434		3254
2435	my $bug_warning = 0;	3255	my $bug_warning = 0;
2436		3256
		3257	our @WAIT_FOR_TICK;
		3258	our @WAIT_FOR_TICK_BEGIN;
		3259
		3260	sub wait_for_tick {
		3261	return unless $TICK_WATCHER->is_active;
		3262	return if $Coro::current == $Coro::main;
		3263
		3264	my $signal = new Coro::Signal;
		3265	push @WAIT_FOR_TICK, $signal;
		3266	$signal->wait;
		3267	}
		3268
		3269	sub wait_for_tick_begin {
		3270	return unless $TICK_WATCHER->is_active;
		3271	return if $Coro::current == $Coro::main;
		3272
		3273	my $signal = new Coro::Signal;
		3274	push @WAIT_FOR_TICK_BEGIN, $signal;
		3275	$signal->wait;
		3276	}
		3277
		3278	my $min = 1e6;#d#
		3279	my $avg = 10;
2437	$TICK_WATCHER = Event->timer (	3280	$TICK_WATCHER = Event->timer (
2438	reentrant => 0,	3281	reentrant => 0,
2439	parked => 1,	3282	parked => 1,
2440	prio => 0,	3283	prio => 0,
2441	at => $NEXT_TICK || $TICK,	3284	at => $NEXT_TICK || $TICK,
…		…
2445	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3288	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2446	unless ++$bug_warning > 10;	3289	unless ++$bug_warning > 10;
2447	return;	3290	return;
2448	}	3291	}
2449		3292
2450	$NOW = Event::time;	3293	$NOW = $tick_start = Event::time;
2451		3294
2452	cf::server_tick; # one server iteration	3295	cf::server_tick; # one server iteration
		3296
		3297	0 && sync_job {#d#
		3298	for(1..10) {
		3299	my $t = Event::time;
		3300	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3301	or die;
		3302
		3303	$map->width (50);
		3304	$map->height (50);
		3305	$map->alloc;
		3306	$map->_load_objects ("/tmp/x.map", 1);
		3307	my $t = Event::time - $t;
		3308
		3309	#next unless $t < 0.0013;#d#
		3310	if ($t < $min) {
		3311	$min = $t;
		3312	}
		3313	$avg = $avg * 0.99 + $t * 0.01;
		3314	}
		3315	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3316	exit 0;
		3317	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3318	};
		3319
2453	$RUNTIME += $TICK;	3320	$RUNTIME += $TICK;
2454	$NEXT_TICK += $TICK;	3321	$NEXT_TICK += $TICK;
2455		3322
2456	$WAIT_FOR_TICK->broadcast;	3323	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2457	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3324	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3325	Coro::async_pool {
		3326	write_runtime
		3327	or warn "ERROR: unable to write runtime file: $!";
		3328	};
		3329	}
		3330
		3331	# my $AFTER = Event::time;
		3332	# warn $AFTER - $NOW;#d#
		3333
		3334	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3335	$sig->send;
		3336	}
		3337	while (my $sig = shift @WAIT_FOR_TICK) {
		3338	$sig->send;
		3339	}
		3340
		3341	$NOW = Event::time;
2458		3342
2459	# if we are delayed by four ticks or more, skip them all	3343	# if we are delayed by four ticks or more, skip them all
2460	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3344	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2461		3345
2462	$TICK_WATCHER->at ($NEXT_TICK);	3346	$TICK_WATCHER->at ($NEXT_TICK);
2463	$TICK_WATCHER->start;	3347	$TICK_WATCHER->start;
		3348
		3349	$LOAD = ($NOW - $tick_start) / $TICK;
		3350	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3351
		3352	_post_tick;
		3353
		3354
2464	},	3355	},
2465	);	3356	);
2466		3357
		3358	{
		3359	BDB::max_poll_time $TICK * 0.1;
		3360	$BDB_POLL_WATCHER = Event->io (
		3361	reentrant => 0,
		3362	fd => BDB::poll_fileno,
		3363	poll => 'r',
		3364	prio => 0,
		3365	data => WF_AUTOCANCEL,
		3366	cb => \&BDB::poll_cb,
		3367	);
		3368	BDB::min_parallel 8;
		3369
		3370	BDB::set_sync_prepare {
		3371	my $status;
		3372	my $current = $Coro::current;
		3373	(
		3374	sub {
		3375	$status = $!;
		3376	$current->ready; undef $current;
		3377	},
		3378	sub {
		3379	Coro::schedule while defined $current;
		3380	$! = $status;
		3381	},
		3382	)
		3383	};
		3384
		3385	unless ($DB_ENV) {
		3386	$DB_ENV = BDB::db_env_create;
		3387
		3388	cf::sync_job {
		3389	eval {
		3390	BDB::db_env_open
		3391	$DB_ENV,
		3392	$BDBDIR,
		3393	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3394	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3395	0666;
		3396
		3397	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3398
		3399	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3400	$DB_ENV->set_lk_detect;
		3401	};
		3402
		3403	cf::cleanup "db_env_open(db): $@" if $@;
		3404	};
		3405	}
		3406	}
		3407
		3408	{
		3409	IO::AIO::min_parallel 8;
		3410
		3411	undef $Coro::AIO::WATCHER;
2467	IO::AIO::max_poll_time $TICK * 0.2;	3412	IO::AIO::max_poll_time $TICK * 0.1;
2468
2469	$AIO_POLL_WATCHER = Event->io (	3413	$AIO_POLL_WATCHER = Event->io (
2470	fd => IO::AIO::poll_fileno,	3414	reentrant => 0,
2471	poll => 'r',
2472	prio => 5,
2473	data => WF_AUTOCANCEL,
2474	cb => \&IO::AIO::poll_cb,
2475	);
2476
2477	$WRITE_RUNTIME_WATCHER = Event->timer (
2478	data => WF_AUTOCANCEL,	3415	data => WF_AUTOCANCEL,
2479	after => 1,	3416	fd => IO::AIO::poll_fileno,
2480	interval => 10,	3417	poll => 'r',
2481	cb => Coro::unblock_sub {	3418	prio => 6,
2482	write_runtime	3419	cb => \&IO::AIO::poll_cb,
2483	or warn "ERROR: unable to write runtime file: $!";	3420	);
		3421	}
		3422
		3423	my $_log_backtrace;
		3424
		3425	sub _log_backtrace {
		3426	my ($msg, @addr) = @_;
		3427
		3428	$msg =~ s/\n//;
		3429
		3430	# limit the # of concurrent backtraces
		3431	if ($_log_backtrace < 2) {
		3432	++$_log_backtrace;
		3433	async {
		3434	my @bt = fork_call {
		3435	@addr = map { sprintf "%x", $_ } @addr;
		3436	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3437	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3438	or die "addr2line: $!";
		3439
		3440	my @funcs;
		3441	my @res = <$fh>;
		3442	chomp for @res;
		3443	while (@res) {
		3444	my ($func, $line) = splice @res, 0, 2, ();
		3445	push @funcs, "[$func] $line";
		3446	}
		3447
		3448	@funcs
		3449	};
		3450
		3451	LOG llevInfo, "[ABT] $msg\n";
		3452	LOG llevInfo, "[ABT] $_\n" for @bt;
		3453	--$_log_backtrace;
		3454	};
		3455	} else {
		3456	LOG llevInfo, "[ABT] $msg\n";
		3457	LOG llevInfo, "[ABT] [suppressed]\n";
2484	},	3458	}
2485	);	3459	}
		3460
		3461	# load additional modules
		3462	use cf::pod;
2486		3463
2487	END { cf::emergency_save }	3464	END { cf::emergency_save }
2488		3465
2489	1	3466	1
2490		3467

Diff Legend

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