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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.314 by root, Mon Jul 23 16:53:15 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]
		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	Useful for short background jobs.
		334
		335	=cut
		336
		337	our @SLOT_QUEUE;
		338	our $SLOT_QUEUE;
		339
		340	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		341	$SLOT_QUEUE = Coro::async {
		342	my $signal = new Coro::Signal;
		343
		344	while () {
		345	next_job:
		346	my $avail = cf::till_tick;
		347	if ($avail > 0.01) {
		348	for (0 .. $#SLOT_QUEUE) {
		349	if ($SLOT_QUEUE[$_][0] < $avail) {
		350	my $job = splice @SLOT_QUEUE, $_, 1, ();
		351	$job->[2]->send;
		352	Coro::cede;
		353	goto next_job;
		354	}
		355	}
		356	}
		357
		358	if (@SLOT_QUEUE) {
		359	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		360	push @cf::WAIT_FOR_TICK, $signal;
		361	$signal->wait;
		362	} else {
		363	Coro::schedule;
		364	}
		365	}
		366	};
		367
		368	sub get_slot($;$) {
		369	my ($time, $pri) = @_;
		370
		371	push @SLOT_QUEUE, [$time, $pri, my $sig = new Coro::Signal];
		372	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		373	$SLOT_QUEUE->ready;
		374	$sig->wait;
271	}	375	}
272		376
273	=item cf::async { BLOCK }	377	=item cf::async { BLOCK }
274		378
275	Currently the same as Coro::async_pool, meaning you cannot use	379	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		384
281	BEGIN { *async = \&Coro::async_pool }	385	BEGIN { *async = \&Coro::async_pool }
282		386
283	=item cf::sync_job { BLOCK }	387	=item cf::sync_job { BLOCK }
284		388
285	The design of crossfire+ requires that the main coro ($Coro::main) is	389	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	390	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.	391	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		392	acceptable.
288		393
289	If it must be done, put the blocking parts into C<sync_job>. This will run	394	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	395	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	396	server will be frozen during this time, so the block should either finish
292	fast or be very important.	397	fast or be very important.
…		…
295		400
296	sub sync_job(&) {	401	sub sync_job(&) {
297	my ($job) = @_;	402	my ($job) = @_;
298		403
299	if ($Coro::current == $Coro::main) {	404	if ($Coro::current == $Coro::main) {
		405	my $time = Event::time;
		406
300	# this is the main coro, too bad, we have to block	407	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	408	# till the operation succeeds, freezing the server :/
302		409
303	# TODO: use suspend/resume instead	410	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	411	# (but this is cancel-safe)
…		…
315		422
316	while ($busy) {	423	while ($busy) {
317	Coro::cede or Event::one_event;	424	Coro::cede or Event::one_event;
318	}	425	}
319		426
		427	$time = Event::time - $time;
		428
		429	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		430	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		431
		432	$tick_start += $time; # do not account sync jobs to server load
		433
320	wantarray ? @res : $res[0]	434	wantarray ? @res : $res[0]
321	} else {	435	} else {
322	# we are in another coroutine, how wonderful, everything just works	436	# we are in another coroutine, how wonderful, everything just works
323		437
324	$job->()	438	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	457	$EXT_CORO{$coro+0} = $coro;
344		458
345	$coro	459	$coro
346	}	460	}
347		461
348	sub write_runtime {	462	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		463
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	464	Executes the given code block with the given arguments in a seperate
352	or return;	465	process, returning the results. Everything must be serialisable with
		466	Coro::Storable. May, of course, block. Note that the executed sub may
		467	never block itself or use any form of Event handling.
353		468
354	my $value = $cf::RUNTIME + 90 + 10;	469	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		470
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	471	sub _store_scalar {
359	and return;	472	open my $fh, ">", \my $buf
360		473	or die "fork_call: cannot open fh-to-buf in child : $!";
361	aio_fsync $fh	474	Storable::store_fd $_[0], $fh;
362	and return;
363
364	close $fh	475	close $fh;
365	or return;
366		476
367	aio_rename "$runtime~", $runtime	477	$buf
368	and return;	478	}
369		479
		480	sub fork_call(&@) {
		481	my ($cb, @args) = @_;
		482
		483	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		484	# or die "socketpair: $!";
		485	pipe my $fh1, my $fh2
		486	or die "pipe: $!";
		487
		488	if (my $pid = fork) {
		489	close $fh2;
		490
		491	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		492	warn "pst<$res>" unless $res =~ /^pst/;
		493	$res = Coro::Storable::thaw $res;
		494
		495	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		496
		497	Carp::confess $$res unless "ARRAY" eq ref $res;
		498
		499	return wantarray ? @$res : $res->[-1];
		500	} else {
		501	reset_signals;
		502	local $SIG{__WARN__};
		503	local $SIG{__DIE__};
		504	# just in case, this hack effectively disables event
		505	# in the child. cleaner and slower would be canceling all watchers,
		506	# but this works for the time being.
		507	local $Coro::idle;
		508	$Coro::current->prio (Coro::PRIO_MAX);
		509
		510	eval {
		511	close $fh1;
		512
		513	my @res = eval { $cb->(@args) };
		514
		515	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		516	close $fh2;
		517	};
		518
		519	warn $@ if $@;
		520	_exit 0;
370	1	521	}
		522	}
		523
		524	=item $value = cf::db_get $family => $key
		525
		526	Returns a single value from the environment database.
		527
		528	=item cf::db_put $family => $key => $value
		529
		530	Stores the given C<$value> in the family. It can currently store binary
		531	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		532
		533	=cut
		534
		535	our $DB;
		536
		537	sub db_init {
		538	unless ($DB) {
		539	$DB = BDB::db_create $DB_ENV;
		540
		541	cf::sync_job {
		542	eval {
		543	$DB->set_flags (BDB::CHKSUM);
		544
		545	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		546	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		547	cf::cleanup "db_open(db): $!" if $!;
		548	};
		549	cf::cleanup "db_open(db): $@" if $@;
		550	};
		551	}
		552	}
		553
		554	sub db_get($$) {
		555	my $key = "$_[0]/$_[1]";
		556
		557	cf::sync_job {
		558	BDB::db_get $DB, undef, $key, my $data;
		559
		560	$! ? ()
		561	: $data
		562	}
		563	}
		564
		565	sub db_put($$$) {
		566	BDB::dbreq_pri 4;
		567	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		568	}
		569
		570	=item cf::cache $id => [$paths...], $processversion => $process
		571
		572	Generic caching function that returns the value of the resource $id,
		573	caching and regenerating as required.
		574
		575	This function can block.
		576
		577	=cut
		578
		579	sub cache {
		580	my ($id, $src, $processversion, $process) = @_;
		581
		582	my $meta =
		583	join "\x00",
		584	$processversion,
		585	map {
		586	aio_stat $_
		587	and Carp::croak "$_: $!";
		588
		589	($_, (stat _)[7,9])
		590	} @$src;
		591
		592	my $dbmeta = db_get cache => "$id/meta";
		593	if ($dbmeta ne $meta) {
		594	# changed, we may need to process
		595
		596	my @data;
		597	my $md5;
		598
		599	for (0 .. $#$src) {
		600	0 <= aio_load $src->[$_], $data[$_]
		601	or Carp::croak "$src->[$_]: $!";
		602	}
		603
		604	# if processing is expensive, check
		605	# checksum first
		606	if (1) {
		607	$md5 =
		608	join "\x00",
		609	$processversion,
		610	map {
		611	Coro::cede;
		612	($src->[$_], Digest::MD5::md5_hex $data[$_])
		613	} 0.. $#$src;
		614
		615
		616	my $dbmd5 = db_get cache => "$id/md5";
		617	if ($dbmd5 eq $md5) {
		618	db_put cache => "$id/meta", $meta;
		619
		620	return db_get cache => "$id/data";
		621	}
		622	}
		623
		624	my $t1 = Time::HiRes::time;
		625	my $data = $process->(\@data);
		626	my $t2 = Time::HiRes::time;
		627
		628	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		629
		630	db_put cache => "$id/data", $data;
		631	db_put cache => "$id/md5" , $md5;
		632	db_put cache => "$id/meta", $meta;
		633
		634	return $data;
		635	}
		636
		637	db_get cache => "$id/data"
		638	}
		639
		640	=item cf::datalog type => key => value, ...
		641
		642	Log a datalog packet of the given type with the given key-value pairs.
		643
		644	=cut
		645
		646	sub datalog($@) {
		647	my ($type, %kv) = @_;
		648	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
371	}	649	}
372		650
373	=back	651	=back
374		652
375	=cut	653	=cut
…		…
382	attach callbacks/event handlers (a collection of which is called an "attachment")	660	attach callbacks/event handlers (a collection of which is called an "attachment")
383	to it. All such attachable objects support the following methods.	661	to it. All such attachable objects support the following methods.
384		662
385	In the following description, CLASS can be any of C<global>, C<object>	663	In the following description, CLASS can be any of C<global>, C<object>
386	C<player>, C<client> or C<map> (i.e. the attachable objects in	664	C<player>, C<client> or C<map> (i.e. the attachable objects in
387	crossfire+).	665	Crossfire TRT).
388		666
389	=over 4	667	=over 4
390		668
391	=item $attachable->attach ($attachment, key => $value...)	669	=item $attachable->attach ($attachment, key => $value...)
392		670
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	833	$registry = $CB_TYPE[$object_type] ||= [];
556		834
557	} elsif ($type eq "subtype") {	835	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	836	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	837	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	838	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		839
562	} elsif ($type eq "package") {	840	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	841	my $pkg = shift @arg;
564		842
565	while (my ($name, $id) = each %cb_id) {	843	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	872	_attach $registry, $klass, @attach;
595	}	873	}
596		874
597	$obj->{$name} = \%arg;	875	$obj->{$name} = \%arg;
598	} else {	876	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	877	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	878	}
601		879
602	$obj->{_attachment}{$name} = undef;	880	$obj->{_attachment}{$name} = undef;
603	}	881	}
604		882
…		…
606	if (ref $_[0]) {	884	if (ref $_[0]) {
607	_object_attach @_;	885	_object_attach @_;
608	} else {	886	} else {
609	_attach shift->_attach_registry, @_;	887	_attach shift->_attach_registry, @_;
610	}	888	}
		889	_recalc_want;
611	};	890	};
612		891
613	# all those should be optimised	892	# all those should be optimised
614	sub cf::attachable::detach {	893	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	894	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	897	delete $obj->{_attachment}{$name};
619	reattach ($obj);	898	reattach ($obj);
620	} else {	899	} else {
621	Carp::croak "cannot, currently, detach class attachments";	900	Carp::croak "cannot, currently, detach class attachments";
622	}	901	}
		902	_recalc_want;
623	};	903	};
624		904
625	sub cf::attachable::attached {	905	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	906	my ($obj, $name) = @_;
627		907
…		…
642	";	922	";
643	die if $@;	923	die if $@;
644	}	924	}
645		925
646	our $override;	926	our $override;
647	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	927	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
648		928
649	sub override {	929	sub override {
650	$override = 1;	930	$override = 1;
651	@invoke_results = ();	931	@INVOKE_RESULTS = (@_);
652	}	932	}
653		933
654	sub do_invoke {	934	sub do_invoke {
655	my $event = shift;	935	my $event = shift;
656	my $callbacks = shift;	936	my $callbacks = shift;
657		937
658	@invoke_results = ();	938	@INVOKE_RESULTS = ();
659		939
660	local $override;	940	local $override;
661		941
662	for (@$callbacks) {	942	for (@$callbacks) {
663	eval { &{$_->[1]} };	943	eval { &{$_->[1]} };
…		…
680		960
681	Generate an object-specific event with the given arguments.	961	Generate an object-specific event with the given arguments.
682		962
683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	963	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
684	removed in future versions), and there is no public API to access override	964	removed in future versions), and there is no public API to access override
685	results (if you must, access C<@cf::invoke_results> directly).	965	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		966
687	=back	967	=back
688		968
689	=cut	969	=cut
690		970
691	#############################################################################	971	#############################################################################
692	# object support	972	# object support
		973	#
		974
		975	sub _can_merge {
		976	my ($ob1, $ob2) = @_;
		977
		978	local $Storable::canonical = 1;
		979	my $fob1 = Storable::freeze $ob1;
		980	my $fob2 = Storable::freeze $ob2;
		981
		982	$fob1 eq $fob2
		983	}
693		984
694	sub reattach {	985	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	986	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	987	my ($obj) = @_;
697		988
…		…
750	$filename, length $$rdata, scalar @$objs;	1041	$filename, length $$rdata, scalar @$objs;
751		1042
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1043	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1044	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1045	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1046	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1047	close $fh;
757		1048
758	if (@$objs) {	1049	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1050	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	1051	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1052	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1053	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1054	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1055	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1056	aio_rename "$filename.pst~", "$filename.pst";
766	}	1057	}
767	} else {	1058	} else {
768	aio_unlink "$filename.pst";	1059	aio_unlink "$filename.pst";
…		…
800	or return;	1091	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	1092	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1093	}
803		1094
804	warn sprintf "loading %s (%d)\n",	1095	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1096	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1097	return ($data, $av);
807	}	1098	}
		1099
		1100	=head2 COMMAND CALLBACKS
		1101
		1102	=over 4
		1103
		1104	=cut
808		1105
809	#############################################################################	1106	#############################################################################
810	# command handling &c	1107	# command handling &c
811		1108
812	=item cf::register_command $name => \&callback($ob,$args);	1109	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1122	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1123	}
827		1124
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1125	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1126
830	Register a callbackf ro execution when the client sends an extcmd packet.	1127	Register a callback for execution when the client sends an (synchronous)
		1128	extcmd packet. Ext commands will be processed in the order they are
		1129	received by the server, like other user commands. The first argument is
		1130	the logged-in player. Ext commands can only be processed after a player
		1131	has logged in successfully.
831		1132
832	If the callback returns something, it is sent back as if reply was being	1133	If the callback returns something, it is sent back as if reply was being
833	called.	1134	called.
834		1135
		1136	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1137
		1138	Register a callback for execution when the client sends an (asynchronous)
		1139	exticmd packet. Exti commands are processed by the server as soon as they
		1140	are received, i.e. out of order w.r.t. other commands. The first argument
		1141	is a client socket. Exti commands can be received anytime, even before
		1142	log-in.
		1143
		1144	If the callback returns something, it is sent back as if reply was being
		1145	called.
		1146
835	=cut	1147	=cut
836		1148
837	sub register_extcmd {	1149	sub register_extcmd {
838	my ($name, $cb) = @_;	1150	my ($name, $cb) = @_;
839		1151
840	$EXTCMD{$name} = $cb;	1152	$EXTCMD{$name} = $cb;
		1153	}
		1154
		1155	sub register_exticmd {
		1156	my ($name, $cb) = @_;
		1157
		1158	$EXTICMD{$name} = $cb;
841	}	1159	}
842		1160
843	cf::player->attach (	1161	cf::player->attach (
844	on_command => sub {	1162	on_command => sub {
845	my ($pl, $name, $params) = @_;	1163	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1172	cf::override;
855	},	1173	},
856	on_extcmd => sub {	1174	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1175	my ($pl, $buf) = @_;
858		1176
859	my $msg = eval { from_json $buf };	1177	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1178
861	if (ref $msg) {	1179	if (ref $msg) {
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1180	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
863	if (my %reply = $cb->($pl, $msg)) {	1181	if (my %reply = $cb->($pl, $msg)) {
864	$pl->ext_reply ($msg->{msgid}, %reply);	1182	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
870		1188
871	cf::override;	1189	cf::override;
872	},	1190	},
873	);	1191	);
874		1192
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1193	sub load_extensions {
		1194	cf::sync_job {
		1195	my %todo;
		1196
910	for my $ext (<$LIBDIR/*.ext>) {	1197	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1198	next unless -r $path;
912	eval {	1199
913	load_extension $ext;	1200	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1201	my $base = $1;
		1202	my $pkg = $1;
		1203	$pkg =~ s/[^[:word:]]/_/g;
		1204	$pkg = "ext::$pkg";
		1205
		1206	open my $fh, "<:utf8", $path
		1207	or die "$path: $!";
		1208
		1209	my $source = do { local $/; <$fh> };
		1210
		1211	my %ext = (
		1212	path => $path,
		1213	base => $base,
		1214	pkg => $pkg,
		1215	);
		1216
		1217	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1218	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1219
		1220	$ext{source} =
		1221	"package $pkg; use strict; use utf8;\n"
		1222	. "#line 1 \"$path\"\n{\n"
		1223	. $source
		1224	. "\n};\n1";
		1225
		1226	$todo{$base} = \%ext;
		1227	}
		1228
		1229	my %done;
		1230	while (%todo) {
		1231	my $progress;
		1232
		1233	while (my ($k, $v) = each %todo) {
		1234	for (split /,\s*/, $v->{meta}{depends}) {
		1235	goto skip
		1236	unless exists $done{$_};
		1237	}
		1238
		1239	warn "... loading '$k' into '$v->{pkg}'\n";
		1240
		1241	unless (eval $v->{source}) {
		1242	my $msg = $@ ? "$v->{path}: $@\n"
		1243	: "$v->{base}: extension inactive.\n";
		1244
		1245	if (exists $v->{meta}{mandatory}) {
		1246	warn $msg;
		1247	warn "mandatory extension failed to load, exiting.\n";
		1248	exit 1;
		1249	}
		1250
		1251	warn $msg;
		1252	}
		1253
		1254	$done{$k} = delete $todo{$k};
		1255	push @EXTS, $v->{pkg};
		1256	$progress = 1;
914	1	1257	}
915	} or warn "$ext not loaded: $@";	1258
		1259	skip:
		1260	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1261	unless $progress;
		1262	}
916	}	1263	};
917	}	1264	}
918		1265
919	#############################################################################	1266	#############################################################################
920		1267
		1268	=back
		1269
921	=head2 CORE EXTENSIONS	1270	=head2 CORE EXTENSIONS
922		1271
923	Functions and methods that extend core crossfire objects.	1272	Functions and methods that extend core crossfire objects.
924		1273
925	=cut	1274	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1286	Returns the given player object, loading it if necessary (might block).
938		1287
939	=cut	1288	=cut
940		1289
941	sub playerdir($) {	1290	sub playerdir($) {
942	cf::localdir	1291	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1292	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1293	}
948		1294
949	sub path($) {	1295	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1296	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1297
952	(playerdir $login) . "/$login.pl"	1298	(playerdir $login) . "/playerdata"
953	}	1299	}
954		1300
955	sub find_active($) {	1301	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1302	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1303	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1316	my $login = $_[0];
971		1317
972	my $guard = cf::lock_acquire "user_find:$login";	1318	my $guard = cf::lock_acquire "user_find:$login";
973		1319
974	$cf::PLAYER{$_[0]} || do {	1320	$cf::PLAYER{$_[0]} || do {
		1321	# rename old playerfiles to new ones
		1322	#TODO: remove when no longer required
		1323	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1324	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1325	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1326	aio_unlink +(playerdir $login) . "/$login.pl";
		1327
975	my $pl = load_pl path $login	1328	my $pl = load_pl path $login
976	or return;	1329	or return;
977	$cf::PLAYER{$login} = $pl	1330	$cf::PLAYER{$login} = $pl
978	}	1331	}
979	}	1332	}
…		…
1016		1369
1017	=cut	1370	=cut
1018		1371
1019	sub quit_character {	1372	sub quit_character {
1020	my ($pl) = @_;	1373	my ($pl) = @_;
		1374
		1375	my $name = $pl->ob->name;
1021		1376
1022	$pl->{deny_save} = 1;	1377	$pl->{deny_save} = 1;
1023	$pl->password ("*"); # this should lock out the player until we nuked the dir	1378	$pl->password ("*"); # this should lock out the player until we nuked the dir
1024		1379
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1380	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1385	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1386	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1387	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1388	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1389	$pl->destroy;
		1390
		1391	my $prefix = qr<^~\Q$name\E/>;
		1392
		1393	# nuke player maps
		1394	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1395
1035	IO::AIO::aio_rmtree $temp;	1396	IO::AIO::aio_rmtree $temp;
		1397	}
		1398
		1399	=item $pl->kick
		1400
		1401	Kicks a player out of the game. This destroys the connection.
		1402
		1403	=cut
		1404
		1405	sub kick {
		1406	my ($pl, $kicker) = @_;
		1407
		1408	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1409	$pl->killer ("kicked");
		1410	$pl->ns->destroy;
1036	}	1411	}
1037		1412
1038	=item cf::player::list_logins	1413	=item cf::player::list_logins
1039		1414
1040	Returns am arrayref of all valid playernames in the system, can take a	1415	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1416	while and may block, so not sync_job-capable, ever.
1042		1417
1043	=cut	1418	=cut
1044		1419
1045	sub list_logins {	1420	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1421	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1422	or return [];
1048		1423
1049	my @logins;	1424	my @logins;
1050		1425
1051	for my $login (@$dirs) {	1426	for my $login (@$dirs) {
…		…
1068	=cut	1443	=cut
1069		1444
1070	sub maps($) {	1445	sub maps($) {
1071	my ($pl) = @_;	1446	my ($pl) = @_;
1072		1447
		1448	$pl = ref $pl ? $pl->ob->name : $pl;
		1449
1073	my $files = aio_readdir playerdir $pl	1450	my $files = aio_readdir playerdir $pl
1074	or return;	1451	or return;
1075		1452
1076	my @paths;	1453	my @paths;
1077		1454
1078	for (@$files) {	1455	for (@$files) {
1079	utf8::decode $_;	1456	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1457	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1458	next unless /^$PATH_SEP/o;
1082		1459
1083	s/\.map$//;	1460	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1461	}
1086		1462
1087	\@paths	1463	\@paths
1088	}	1464	}
1089		1465
		1466	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1467
		1468	Expand crossfire pod fragments into protocol xml.
		1469
		1470	=cut
		1471
		1472	sub expand_cfpod {
		1473	((my $self), (local $_)) = @_;
		1474
		1475	# escape & and <
		1476	s/&/&amp;/g;
		1477	s/(?<![BIUGH])</&lt;/g;
		1478
		1479	# this is buggy, it needs to properly take care of nested <'s
		1480
		1481	1 while
		1482	# replace B<>, I<>, U<> etc.
		1483	s/B<([^\>]*)>/<b>$1<\/b>/
		1484	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1485	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1486	# replace G<male|female> tags
		1487	|| s{G<([^>|]*)\|([^>]*)>}{
		1488	$self->gender ? $2 : $1
		1489	}ge
		1490	# replace H<hint text>
		1491	|| s{H<([^\>]*)>}
		1492	{
		1493	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1494	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1495	"")
		1496	[$self->{hintmode}]
		1497	}ge;
		1498
		1499	# create single paragraphs (very hackish)
		1500	s/(?<=\S)\n(?=\w)/ /g;
		1501
		1502	# compress some whitespace
		1503	s/\s+\n/\n/g; # ws line-ends
		1504	s/\n\n+/\n/g; # double lines
		1505	s/^\n+//; # beginning lines
		1506	s/\n+$//; # ending lines
		1507
		1508	$_
		1509	}
		1510
		1511	sub hintmode {
		1512	$_[0]{hintmode} = $_[1] if @_ > 1;
		1513	$_[0]{hintmode}
		1514	}
		1515
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1516	=item $player->ext_reply ($msgid, %msg)
1091		1517
1092	Sends an ext reply to the player.	1518	Sends an ext reply to the player.
1093		1519
1094	=cut	1520	=cut
1095		1521
1096	sub ext_reply($$$%) {	1522	sub ext_reply($$%) {
1097	my ($self, $id, %msg) = @_;	1523	my ($self, $id, %msg) = @_;
1098		1524
1099	$msg{msgid} = $id;	1525	$msg{msgid} = $id;
1100		1526	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1527	}
1103		1528
1104	package cf;	1529	=item $player->ext_event ($type, %msg)
		1530
		1531	Sends an ext event to the client.
		1532
		1533	=cut
		1534
		1535	sub ext_event($$%) {
		1536	my ($self, $type, %msg) = @_;
		1537
		1538	$self->ns->ext_event ($type, %msg);
		1539	}
		1540
		1541	=head3 cf::region
		1542
		1543	=over 4
		1544
		1545	=cut
		1546
		1547	package cf::region;
		1548
		1549	=item cf::region::find_by_path $path
		1550
		1551	Tries to decuce the likely region for a map knowing only its path.
		1552
		1553	=cut
		1554
		1555	sub find_by_path($) {
		1556	my ($path) = @_;
		1557
		1558	my ($match, $specificity);
		1559
		1560	for my $region (list) {
		1561	if ($region->{match} && $path =~ $region->{match}) {
		1562	($match, $specificity) = ($region, $region->specificity)
		1563	if $region->specificity > $specificity;
		1564	}
		1565	}
		1566
		1567	$match
		1568	}
1105		1569
1106	=back	1570	=back
1107
1108		1571
1109	=head3 cf::map	1572	=head3 cf::map
1110		1573
1111	=over 4	1574	=over 4
1112		1575
…		…
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1603	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region}), $rmp->{custom}	1604	(cf::region::find $rmp->{region}), $rmp->{custom}
1142	)	1605	)
1143	}	1606	}
1144		1607
		1608	=item cf::map->register ($regex, $prio)
		1609
		1610	Register a handler for the map path matching the given regex at the
		1611	givne priority (higher is better, built-in handlers have priority 0, the
		1612	default).
		1613
		1614	=cut
		1615
1145	sub register {	1616	sub register {
1146	my (undef, $regex) = @_;	1617	my (undef, $regex, $prio) = @_;
1147	my $pkg = caller;	1618	my $pkg = caller;
1148		1619
1149	no strict;	1620	no strict;
1150	push @{"$pkg\::ISA"}, __PACKAGE__;	1621	push @{"$pkg\::ISA"}, __PACKAGE__;
1151		1622
1152	$EXT_MAP{$pkg} = qr<$regex>;	1623	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1153	}	1624	}
1154		1625
1155	# also paths starting with '/'	1626	# also paths starting with '/'
1156	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1627	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1157		1628
1158	sub thawer_merge {	1629	sub thawer_merge {
1159	my ($self, $merge) = @_;	1630	my ($self, $merge) = @_;
1160		1631
1161	# we have to keep some variables in memory intact	1632	# we have to keep some variables in memory intact
1162	local $self->{path};	1633	local $self->{path};
1163	local $self->{load_path};	1634	local $self->{load_path};
1164	local $self->{deny_save};
1165	local $self->{deny_reset};
1166		1635
1167	$self->SUPER::thawer_merge ($merge);	1636	$self->SUPER::thawer_merge ($merge);
1168	}	1637	}
1169		1638
1170	sub normalise {	1639	sub normalise {
1171	my ($path, $base) = @_;	1640	my ($path, $base) = @_;
		1641
		1642	$path = "$path"; # make sure its a string
		1643
		1644	$path =~ s/\.map$//;
1172		1645
1173	# map plan:	1646	# map plan:
1174	#	1647	#
1175	# /! non-realised random map exit (special hack!)	1648	# /! non-realised random map exit (special hack!)
1176	# {... are special paths that are not being touched	1649	# {... are special paths that are not being touched
…		…
1204		1677
1205	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1678	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1206		1679
1207	$path = normalise $path, $base;	1680	$path = normalise $path, $base;
1208		1681
1209	for my $pkg (keys %EXT_MAP) {	1682	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1210	if ($path =~ $EXT_MAP{$pkg}) {	1683	if ($path =~ $EXT_MAP{$pkg}[1]) {
1211	my $self = bless cf::map::new, $pkg;	1684	my $self = bless cf::map::new, $pkg;
1212	$self->{path} = $path; $self->path ($path);	1685	$self->{path} = $path; $self->path ($path);
1213	$self->init; # pass $1 etc.	1686	$self->init; # pass $1 etc.
1214	return $self;	1687	return $self;
1215	}	1688	}
1216	}	1689	}
1217		1690
1218	Carp::carp "unable to resolve path '$path'.";	1691	Carp::cluck "unable to resolve path '$path' (base '$base').";
1219	()	1692	()
1220	}	1693	}
1221		1694
1222	sub init {	1695	sub init {
1223	my ($self) = @_;	1696	my ($self) = @_;
…		…
1238		1711
1239	# the original (read-only) location	1712	# the original (read-only) location
1240	sub load_path {	1713	sub load_path {
1241	my ($self) = @_;	1714	my ($self) = @_;
1242		1715
1243	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1716	"$MAPDIR/$self->{path}.map"
1244	}	1717	}
1245		1718
1246	# the temporary/swap location	1719	# the temporary/swap location
1247	sub save_path {	1720	sub save_path {
1248	my ($self) = @_;	1721	my ($self) = @_;
1249		1722
1250	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1723	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1251	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1724	"$TMPDIR/$path.map"
1252	}	1725	}
1253		1726
1254	# the unique path, undef == no special unique path	1727	# the unique path, undef == no special unique path
1255	sub uniq_path {	1728	sub uniq_path {
1256	my ($self) = @_;	1729	my ($self) = @_;
1257		1730
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1731	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1732	"$UNIQUEDIR/$path"
1260	}	1733	}
1261		1734
1262	# and all this just because we cannot iterate over	1735	# and all this just because we cannot iterate over
1263	# all maps in C++...	1736	# all maps in C++...
1264	sub change_all_map_light {	1737	sub change_all_map_light {
…		…
1266		1739
1267	$_->change_map_light ($change)	1740	$_->change_map_light ($change)
1268	for grep $_->outdoor, values %cf::MAP;	1741	for grep $_->outdoor, values %cf::MAP;
1269	}	1742	}
1270		1743
		1744	sub decay_objects {
		1745	my ($self) = @_;
		1746
		1747	return if $self->{deny_reset};
		1748
		1749	$self->do_decay_objects;
		1750	}
		1751
1271	sub unlink_save {	1752	sub unlink_save {
1272	my ($self) = @_;	1753	my ($self) = @_;
1273		1754
1274	utf8::encode (my $save = $self->save_path);	1755	utf8::encode (my $save = $self->save_path);
1275	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1756	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1278		1759
1279	sub load_header_from($) {	1760	sub load_header_from($) {
1280	my ($self, $path) = @_;	1761	my ($self, $path) = @_;
1281		1762
1282	utf8::encode $path;	1763	utf8::encode $path;
1283	aio_open $path, O_RDONLY, 0	1764	#aio_open $path, O_RDONLY, 0
1284	or return;	1765	# or return;
1285		1766
1286	$self->_load_header ($path)	1767	$self->_load_header ($path)
1287	or return;	1768	or return;
1288		1769
1289	$self->{load_path} = $path;	1770	$self->{load_path} = $path;
1290		1771
1291	1	1772	1
1292	}	1773	}
1293		1774
1294	sub load_orig {	1775	sub load_header_orig {
1295	my ($self) = @_;	1776	my ($self) = @_;
1296		1777
1297	$self->load_header_from ($self->load_path)	1778	$self->load_header_from ($self->load_path)
1298	}	1779	}
1299		1780
1300	sub load_temp {	1781	sub load_header_temp {
1301	my ($self) = @_;	1782	my ($self) = @_;
1302		1783
1303	$self->load_header_from ($self->save_path)	1784	$self->load_header_from ($self->save_path)
		1785	}
		1786
		1787	sub prepare_temp {
		1788	my ($self) = @_;
		1789
		1790	$self->last_access ((delete $self->{last_access})
		1791	|| $cf::RUNTIME); #d#
		1792	# safety
		1793	$self->{instantiate_time} = $cf::RUNTIME
		1794	if $self->{instantiate_time} > $cf::RUNTIME;
		1795	}
		1796
		1797	sub prepare_orig {
		1798	my ($self) = @_;
		1799
		1800	$self->{load_original} = 1;
		1801	$self->{instantiate_time} = $cf::RUNTIME;
		1802	$self->last_access ($cf::RUNTIME);
		1803	$self->instantiate;
1304	}	1804	}
1305		1805
1306	sub load_header {	1806	sub load_header {
1307	my ($self) = @_;	1807	my ($self) = @_;
1308		1808
1309	if ($self->load_temp) {	1809	if ($self->load_header_temp) {
1310	$self->last_access ((delete $self->{last_access})	1810	$self->prepare_temp;
1311	|| $cf::RUNTIME); #d#
1312	# safety
1313	$self->{instantiate_time} = $cf::RUNTIME
1314	if $self->{instantiate_time} > $cf::RUNTIME;
1315	} else {	1811	} else {
1316	$self->load_orig	1812	$self->load_header_orig
1317	or return;	1813	or return;
1318		1814	$self->prepare_orig;
1319	$self->{load_original} = 1;
1320	$self->{instantiate_time} = $cf::RUNTIME;
1321	$self->last_access ($cf::RUNTIME);
1322	$self->instantiate;
1323	}	1815	}
		1816
		1817	$self->{deny_reset} = 1
		1818	if $self->no_reset;
		1819
		1820	$self->default_region (cf::region::find_by_path $self->{path})
		1821	unless $self->default_region;
1324		1822
1325	1	1823	1
1326	}	1824	}
1327		1825
1328	sub find;	1826	sub find;
…		…
1341	$map->{last_save} = $cf::RUNTIME;	1839	$map->{last_save} = $cf::RUNTIME;
1342		1840
1343	$map->load_header	1841	$map->load_header
1344	or return;	1842	or return;
1345		1843
1346	if ($map->should_reset) {	1844	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1347	# doing this can freeze the server in a sync job, obviously	1845	# doing this can freeze the server in a sync job, obviously
1348	#$cf::WAIT_FOR_TICK->wait;	1846	#$cf::WAIT_FOR_TICK->wait;
1349	$map->reset;	1847	$map->reset;
1350	undef $guard;	1848	undef $guard;
1351	$map = find $path	1849	return find $path;
1352	or return;
1353	}	1850	}
1354		1851
1355	$cf::MAP{$path} = $map	1852	$cf::MAP{$path} = $map
1356	}	1853	}
1357	}	1854	}
		1855
		1856	sub pre_load { }
		1857	sub post_load { }
1358		1858
1359	sub load {	1859	sub load {
1360	my ($self) = @_;	1860	my ($self) = @_;
1361		1861
		1862	local $self->{deny_reset} = 1; # loading can take a long time
		1863
1362	my $path = $self->{path};	1864	my $path = $self->{path};
		1865
		1866	{
1363	my $guard = cf::lock_acquire "map_load:$path";	1867	my $guard = cf::lock_acquire "map_load:$path";
1364		1868
1365	return if $self->in_memory != cf::MAP_SWAPPED;	1869	return if $self->in_memory != cf::MAP_SWAPPED;
1366		1870
1367	$self->in_memory (cf::MAP_LOADING);	1871	$self->in_memory (cf::MAP_LOADING);
1368		1872
1369	$self->alloc;	1873	$self->alloc;
1370	$self->_load_objects ($self->{load_path}, 1)
1371	or return;
1372		1874
1373	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1875	$self->pre_load;
1374	if delete $self->{load_original};
1375
1376	if (my $uniq = $self->uniq_path) {
1377	utf8::encode $uniq;
1378	if (aio_open $uniq, O_RDONLY, 0) {
1379	$self->clear_unique_items;
1380	$self->_load_objects ($uniq, 0);
1381	}
1382	}
1383
1384	Coro::cede;
1385
1386	# now do the right thing for maps
1387	$self->link_multipart_objects;
1388
1389	unless ($self->{deny_activate}) {
1390	$self->decay_objects;
1391	$self->fix_auto_apply;
1392	$self->update_buttons;
1393	Coro::cede;	1876	Coro::cede;
1394	$self->set_darkness_map;	1877
		1878	$self->_load_objects ($self->{load_path}, 1)
		1879	or return;
		1880
		1881	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1882	if delete $self->{load_original};
		1883
		1884	if (my $uniq = $self->uniq_path) {
		1885	utf8::encode $uniq;
		1886	if (aio_open $uniq, O_RDONLY, 0) {
		1887	$self->clear_unique_items;
		1888	$self->_load_objects ($uniq, 0);
		1889	}
		1890	}
		1891
		1892	Coro::cede;
		1893	# now do the right thing for maps
		1894	$self->link_multipart_objects;
1395	$self->difficulty ($self->estimate_difficulty)	1895	$self->difficulty ($self->estimate_difficulty)
1396	unless $self->difficulty;	1896	unless $self->difficulty;
1397	Coro::cede;	1897	Coro::cede;
		1898
		1899	unless ($self->{deny_activate}) {
		1900	$self->decay_objects;
		1901	$self->fix_auto_apply;
		1902	$self->update_buttons;
		1903	Coro::cede;
		1904	$self->set_darkness_map;
		1905	Coro::cede;
1398	$self->activate;	1906	$self->activate;
1399	}	1907	}
1400		1908
1401	$self->in_memory (cf::MAP_IN_MEMORY);	1909	$self->in_memory (cf::MAP_IN_MEMORY);
		1910	}
		1911
		1912	$self->post_load;
1402	}	1913	}
1403		1914
1404	sub customise_for {	1915	sub customise_for {
1405	my ($self, $ob) = @_;	1916	my ($self, $ob) = @_;
1406		1917
1407	return find "~" . $ob->name . "/" . $self->{path}	1918	return find "~" . $ob->name . "/" . $self->{path}
1408	if $self->per_player;	1919	if $self->per_player;
		1920
		1921	# return find "?party/" . $ob->name . "/" . $self->{path}
		1922	# if $self->per_party;
1409		1923
1410	$self	1924	$self
1411	}	1925	}
1412		1926
1413	# find and load all maps in the 3x3 area around a map	1927	# find and load all maps in the 3x3 area around a map
…		…
1460		1974
1461	undef $MAP_PREFETCH{$path};	1975	undef $MAP_PREFETCH{$path};
1462	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1463	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1464	for my $path (keys %MAP_PREFETCH) {	1978	for my $path (keys %MAP_PREFETCH) {
1465	my $map = find $path	1979	if (my $map = find $path) {
1466	or next;
1467	$map->load;	1980	$map->load;
		1981	}
1468		1982
1469	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$path};
1470	}	1984	}
1471	}	1985	}
1472	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1473	};	1987	};
		1988	$MAP_PREFETCHER->prio (6);
1474		1989
1475	()	1990	()
1476	}	1991	}
1477		1992
1478	sub save {	1993	sub save {
…		…
1523		2038
1524	sub reset_at {	2039	sub reset_at {
1525	my ($self) = @_;	2040	my ($self) = @_;
1526		2041
1527	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1528	return 1e99 if $self->isa ("ext::map_per_player");#d#
1529	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1530		2044
1531	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1532	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1533		2047
…		…
1544	my ($self) = @_;	2058	my ($self) = @_;
1545		2059
1546	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1547		2061
1548	return if $self->players;	2062	return if $self->players;
1549	return if $self->isa ("ext::map_per_player");#d#
1550		2063
1551	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1552		2075
1553	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
1554		2077
1555	$self->in_memory (cf::MAP_SWAPPED);
1556	$self->clear;	2078	$self->clear;
1557		2079
1558	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1559		2081
1560	$self->unlink_save;	2082	$self->unlink_save;
…		…
1579	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1580		2102
1581	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1582	}	2104	}
1583		2105
		2106	=item $maps = cf::map::tmp_maps
		2107
		2108	Returns an arrayref with all map paths of currently instantiated and saved
		2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
		2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
		2123
		2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
1584	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1585		2143
1586	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1587	instantiated unique items. May block.	2145	instantiated unique items. May block.
1588		2146
1589	=cut	2147	=cut
1590		2148
1591	sub unique_maps() {	2149	sub unique_maps() {
1592	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2150	[
1593	or return;	2151	map {
1594
1595	my @paths;
1596
1597	for (@$files) {
1598	utf8::decode $_;	2152	utf8::decode $_;
1599	next if /\.pst$/;
1600	next unless /^$PATH_SEP/o;
1601
1602	s/\.map$//;	2153	/\.map$/
1603	push @paths, $_;	2154	? normalise $_
		2155	: ()
		2156	} @{ aio_readdir $UNIQUEDIR or [] }
1604	}	2157	]
1605
1606	\@paths
1607	}	2158	}
1608		2159
1609	package cf;	2160	package cf;
1610		2161
1611	=back	2162	=back
…		…
1657		2208
1658	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1659		2210
1660	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1661	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1662	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $diag = $pl->{npc_dialog};
		2219	$diag->{pl}->ext_reply (
		2220	$diag->{id},
		2221	msgtype => "reply",
		2222	msg => $diag->{pl}->expand_cfpod ($msg),
		2223	add_topics => []
		2224	);
		2225
		2226	} else {
1663	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1664	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1665	}	2230	}
1666	}	2231	}
1667		2232
1668	=item $player_object->may ("access")	2233	=item $player_object->may ("access")
1669		2234
…		…
1702	=cut	2267	=cut
1703		2268
1704	sub link_map {	2269	sub link_map {
1705	unless ($LINK_MAP) {	2270	unless ($LINK_MAP) {
1706	$LINK_MAP = cf::map::find "{link}"	2271	$LINK_MAP = cf::map::find "{link}"
1707	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2272	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1708	$LINK_MAP->load;	2273	$LINK_MAP->load;
1709	}	2274	}
1710		2275
1711	$LINK_MAP	2276	$LINK_MAP
1712	}	2277	}
…		…
1717	$self->deactivate_recursive;	2282	$self->deactivate_recursive;
1718		2283
1719	return if UNIVERSAL::isa $self->map, "ext::map_link";	2284	return if UNIVERSAL::isa $self->map, "ext::map_link";
1720		2285
1721	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2286	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1722	if $self->map;	2287	if $self->map && $self->map->{path} ne "{link}";
1723		2288
1724	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2289	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1725	}	2290	}
1726		2291
1727	sub cf::object::player::leave_link {	2292	sub cf::object::player::leave_link {
1728	my ($self, $map, $x, $y) = @_;	2293	my ($self, $map, $x, $y) = @_;
		2294
		2295	return unless $self->contr->active;
1729		2296
1730	my $link_pos = delete $self->{_link_pos};	2297	my $link_pos = delete $self->{_link_pos};
1731		2298
1732	unless ($map) {	2299	unless ($map) {
1733	# restore original map position	2300	# restore original map position
…		…
1751	$map->load;	2318	$map->load;
1752	$map->load_diag;	2319	$map->load_diag;
1753		2320
1754	return unless $self->contr->active;	2321	return unless $self->contr->active;
1755	$self->activate_recursive;	2322	$self->activate_recursive;
		2323
		2324	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1756	$self->enter_map ($map, $x, $y);	2325	$self->enter_map ($map, $x, $y);
1757	}	2326	}
1758		2327
1759	cf::player->attach (	2328	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1760	on_logout => sub {
1761	my ($pl) = @_;
1762		2329
1763	# abort map switching before logout	2330	Moves the player to the given map-path and coordinates by first freezing
1764	if ($pl->ob->{_link_pos}) {	2331	her, loading and preparing them map, calling the provided $check callback
1765	cf::sync_job {	2332	that has to return the map if sucecssful, and then unfreezes the player on
1766	$pl->ob->leave_link	2333	the new (success) or old (failed) map position. In either case, $done will
1767	};	2334	be called at the end of this process.
1768	}
1769	},
1770	on_login => sub {
1771	my ($pl) = @_;
1772		2335
1773	# try to abort aborted map switching on player login :)
1774	# should happen only on crashes
1775	if ($pl->ob->{_link_pos}) {
1776	$pl->ob->enter_link;
1777	(async {
1778	# we need this sleep as the login has a concurrent enter_exit running
1779	# and this sleep increases chances of the player not ending up in scorn
1780	$pl->ob->reply (undef,
1781	"There was an internal problem at your last logout, "
1782	. "the server will try to bring you to your intended destination in a second.",
1783	cf::NDI_RED);
1784	Coro::Timer::sleep 1;
1785	$pl->ob->leave_link;
1786	})->prio (2);
1787	}
1788	},
1789	);
1790
1791	=item $player_object->goto ($path, $x, $y)
1792
1793	=cut	2336	=cut
		2337
		2338	our $GOTOGEN;
1794		2339
1795	sub cf::object::player::goto {	2340	sub cf::object::player::goto {
1796	my ($self, $path, $x, $y) = @_;	2341	my ($self, $path, $x, $y, $check, $done) = @_;
		2342
		2343	# do generation counting so two concurrent goto's will be executed in-order
		2344	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1797		2345
1798	$self->enter_link;	2346	$self->enter_link;
1799		2347
1800	(async {	2348	(async {
		2349	my $map = eval {
1801	my $map = cf::map::find $path;	2350	my $map = cf::map::find $path;
		2351
		2352	if ($map) {
1802	$map = $map->customise_for ($self) if $map;	2353	$map = $map->customise_for ($self);
1803		2354	$map = $check->($map) if $check && $map;
1804	# warn "entering ", $map->path, " at ($x, $y)\n"	2355	} else {
1805	# if $map;
1806
1807	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2356	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2357	}
1808		2358
		2359	$map
		2360	};
		2361
		2362	if ($@) {
		2363	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2364	LOG llevError | logBacktrace, Carp::longmess $@;
		2365	}
		2366
		2367	if ($gen == $self->{_goto_generation}) {
		2368	delete $self->{_goto_generation};
1809	$self->leave_link ($map, $x, $y);	2369	$self->leave_link ($map, $x, $y);
		2370	}
		2371
		2372	$done->() if $done;
1810	})->prio (1);	2373	})->prio (1);
1811	}	2374	}
1812		2375
1813	=item $player_object->enter_exit ($exit_object)	2376	=item $player_object->enter_exit ($exit_object)
1814		2377
…		…
1843	# that depends on the exit object	2406	# that depends on the exit object
1844		2407
1845	my $rmp = parse_random_map_params $exit->msg;	2408	my $rmp = parse_random_map_params $exit->msg;
1846		2409
1847	if ($exit->map) {	2410	if ($exit->map) {
1848	$rmp->{region} = $exit->map->region_name;	2411	$rmp->{region} = $exit->region->name;
1849	$rmp->{origin_map} = $exit->map->path;	2412	$rmp->{origin_map} = $exit->map->path;
1850	$rmp->{origin_x} = $exit->x;	2413	$rmp->{origin_x} = $exit->x;
1851	$rmp->{origin_y} = $exit->y;	2414	$rmp->{origin_y} = $exit->y;
1852	}	2415	}
1853		2416
1854	$rmp->{random_seed} ||= $exit->random_seed;	2417	$rmp->{random_seed} ||= $exit->random_seed;
1855		2418
1856	my $data = cf::to_json $rmp;	2419	my $data = cf::to_json $rmp;
1857	my $md5 = Digest::MD5::md5_hex $data;	2420	my $md5 = Digest::MD5::md5_hex $data;
1858	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2421	my $meta = "$RANDOMDIR/$md5.meta";
1859		2422
1860	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2423	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1861	aio_write $fh, 0, (length $data), $data, 0;	2424	aio_write $fh, 0, (length $data), $data, 0;
1862	undef $fh;	2425	undef $fh;
1863	aio_rename "$meta~", $meta;	2426	aio_rename "$meta~", $meta;
…		…
1870	sub cf::object::player::enter_exit {	2433	sub cf::object::player::enter_exit {
1871	my ($self, $exit) = @_;	2434	my ($self, $exit) = @_;
1872		2435
1873	return unless $self->type == cf::PLAYER;	2436	return unless $self->type == cf::PLAYER;
1874		2437
		2438	if ($exit->slaying eq "/!") {
		2439	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2440	# the problem is that $exit might not survive long enough
		2441	# so it needs to be done right now, right here
		2442	cf::sync_job { prepare_random_map $exit };
		2443	}
		2444
		2445	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2446	my $hp = $exit->stats->hp;
		2447	my $sp = $exit->stats->sp;
		2448
1875	$self->enter_link;	2449	$self->enter_link;
		2450
		2451	# if exit is damned, update players death & WoR home-position
		2452	$self->contr->savebed ($slaying, $hp, $sp)
		2453	if $exit->flag (FLAG_DAMNED);
1876		2454
1877	(async {	2455	(async {
1878	$self->deactivate_recursive; # just to be sure	2456	$self->deactivate_recursive; # just to be sure
1879	unless (eval {	2457	unless (eval {
1880	prepare_random_map $exit	2458	$self->goto ($slaying, $hp, $sp);
1881	if $exit->slaying eq "/!";
1882
1883	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1884	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1885		2459
1886	1;	2460	1;
1887	}) {	2461	}) {
1888	$self->message ("Something went wrong deep within the crossfire server. "	2462	$self->message ("Something went wrong deep within the crossfire server. "
1889	. "I'll try to bring you back to the map you were before. "	2463	. "I'll try to bring you back to the map you were before. "
1890	. "Please report this to the dungeon master!",	2464	. "Please report this to the dungeon master!",
1891	cf::NDI_UNIQUE | cf::NDI_RED);	2465	cf::NDI_UNIQUE | cf::NDI_RED);
1892		2466
1893	warn "ERROR in enter_exit: $@";	2467	warn "ERROR in enter_exit: $@";
1894	$self->leave_link;	2468	$self->leave_link;
1895	}	2469	}
1896	})->prio (1);	2470	})->prio (1);
…		…
1909		2483
1910	sub cf::client::send_drawinfo {	2484	sub cf::client::send_drawinfo {
1911	my ($self, $text, $flags) = @_;	2485	my ($self, $text, $flags) = @_;
1912		2486
1913	utf8::encode $text;	2487	utf8::encode $text;
1914	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2488	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1915	}	2489	}
1916		2490
		2491	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2492
		2493	Send a drawinfo or msg packet to the client, formatting the msg for the
		2494	client if neccessary. C<$type> should be a string identifying the type of
		2495	the message, with C<log> being the default. If C<$color> is negative, suppress
		2496	the message unless the client supports the msg packet.
		2497
		2498	=cut
		2499
		2500	sub cf::client::send_msg {
		2501	my ($self, $channel, $msg, $color, @extra) = @_;
		2502
		2503	$msg = $self->pl->expand_cfpod ($msg);
		2504
		2505	$color &= ~cf::NDI_UNIQUE; # just in case...
		2506
		2507	if (ref $channel) {
		2508	# send meta info to client, if not yet sent
		2509	unless (exists $self->{channel}{$channel->{id}}) {
		2510	$self->{channel}{$channel->{id}} = $channel;
		2511	$self->ext_event (channel_info => %$channel);
		2512	}
		2513
		2514	$channel = $channel->{id};
		2515	}
		2516
		2517	return unless @extra || length $msg;
		2518
		2519	if ($self->can_msg) {
		2520	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2521	} else {
		2522	# replace some tags by gcfclient-compatible ones
		2523	for ($msg) {
		2524	1 while
		2525	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2526	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2527	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2528	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2529	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2530	}
		2531
		2532	if ($color >= 0) {
		2533	if (0 && $msg =~ /\[/) {
		2534	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2535	} else {
		2536	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2537	$self->send_packet ("drawinfo $color $msg")
		2538	}
		2539	}
		2540	}
		2541	}
		2542
		2543	=item $client->ext_event ($type, %msg)
		2544
		2545	Sends an ext event to the client.
		2546
		2547	=cut
		2548
		2549	sub cf::client::ext_event($$%) {
		2550	my ($self, $type, %msg) = @_;
		2551
		2552	return unless $self->extcmd;
		2553
		2554	$msg{msgtype} = "event_$type";
		2555	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2556	}
1917		2557
1918	=item $success = $client->query ($flags, "text", \&cb)	2558	=item $success = $client->query ($flags, "text", \&cb)
1919		2559
1920	Queues a query to the client, calling the given callback with	2560	Queues a query to the client, calling the given callback with
1921	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2561	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1922	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2562	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1923		2563
1924	Queries can fail, so check the return code. Or don't, as queries will become	2564	Queries can fail, so check the return code. Or don't, as queries will
1925	reliable at some point in the future.	2565	become reliable at some point in the future.
1926		2566
1927	=cut	2567	=cut
1928		2568
1929	sub cf::client::query {	2569	sub cf::client::query {
1930	my ($self, $flags, $text, $cb) = @_;	2570	my ($self, $flags, $text, $cb) = @_;
…		…
1938	utf8::encode $text;	2578	utf8::encode $text;
1939	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2579	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1940		2580
1941	$self->send_packet ($self->{query_queue}[0][0])	2581	$self->send_packet ($self->{query_queue}[0][0])
1942	if @{ $self->{query_queue} } == 1;	2582	if @{ $self->{query_queue} } == 1;
		2583
		2584	1
1943	}	2585	}
1944		2586
1945	cf::client->attach (	2587	cf::client->attach (
		2588	on_connect => sub {
		2589	my ($ns) = @_;
		2590
		2591	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2592	},
1946	on_reply => sub {	2593	on_reply => sub {
1947	my ($ns, $msg) = @_;	2594	my ($ns, $msg) = @_;
1948		2595
1949	# this weird shuffling is so that direct followup queries	2596	# this weird shuffling is so that direct followup queries
1950	# get handled first	2597	# get handled first
1951	my $queue = delete $ns->{query_queue}	2598	my $queue = delete $ns->{query_queue}
1952	or return; # be conservative, not sure how that can happen, but we saw a crash here	2599	or return; # be conservative, not sure how that can happen, but we saw a crash here
1953		2600
1954	(shift @$queue)->[1]->($msg);	2601	(shift @$queue)->[1]->($msg);
		2602	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1955		2603
1956	push @{ $ns->{query_queue} }, @$queue;	2604	push @{ $ns->{query_queue} }, @$queue;
1957		2605
1958	if (@{ $ns->{query_queue} } == @$queue) {	2606	if (@{ $ns->{query_queue} } == @$queue) {
1959	if (@$queue) {	2607	if (@$queue) {
…		…
1961	} else {	2609	} else {
1962	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2610	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1963	}	2611	}
1964	}	2612	}
1965	},	2613	},
		2614	on_exticmd => sub {
		2615	my ($ns, $buf) = @_;
		2616
		2617	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2618
		2619	if (ref $msg) {
		2620	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2621	if (my %reply = $cb->($ns, $msg)) {
		2622	$reply{msgid} = $msg->{msgid};
		2623	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2624	}
		2625	}
		2626	} else {
		2627	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2628	}
		2629
		2630	cf::override;
		2631	},
1966	);	2632	);
1967		2633
1968	=item $client->async (\&cb)	2634	=item $client->async (\&cb)
1969		2635
1970	Create a new coroutine, running the specified callback. The coroutine will	2636	Create a new coroutine, running the specified callback. The coroutine will
…		…
2017		2683
2018	# here we export the classes and methods available to script code	2684	# here we export the classes and methods available to script code
2019		2685
2020	=pod	2686	=pod
2021		2687
2022	The following fucntions and emthods are available within a safe environment:	2688	The following functions and methods are available within a safe environment:
2023		2689
2024	cf::object contr pay_amount pay_player map	2690	cf::object
		2691	contr pay_amount pay_player map x y force_find force_add
		2692	insert remove
		2693
2025	cf::object::player player	2694	cf::object::player
2026	cf::player peaceful	2695	player
2027	cf::map trigger	2696
		2697	cf::player
		2698	peaceful
		2699
		2700	cf::map
		2701	trigger
2028		2702
2029	=cut	2703	=cut
2030		2704
2031	for (	2705	for (
2032	["cf::object" => qw(contr pay_amount pay_player map)],	2706	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2707	insert remove)],
2033	["cf::object::player" => qw(player)],	2708	["cf::object::player" => qw(player)],
2034	["cf::player" => qw(peaceful)],	2709	["cf::player" => qw(peaceful)],
2035	["cf::map" => qw(trigger)],	2710	["cf::map" => qw(trigger)],
2036	) {	2711	) {
2037	no strict 'refs';	2712	no strict 'refs';
…		…
2108	=back	2783	=back
2109		2784
2110	=cut	2785	=cut
2111		2786
2112	#############################################################################	2787	#############################################################################
		2788	# the server's init and main functions
2113		2789
2114	=head2 EXTENSION DATABASE SUPPORT	2790	sub load_facedata($) {
		2791	my ($path) = @_;
2115		2792
2116	Crossfire maintains a very simple database for extension use. It can	2793	warn "loading facedata from $path\n";
2117	currently store anything that can be serialised using Storable, which
2118	excludes objects.
2119		2794
2120	The parameter C<$family> should best start with the name of the extension	2795	my $facedata;
2121	using it, it should be unique.	2796	0 < aio_load $path, $facedata
		2797	or die "$path: $!";
2122		2798
2123	=over 4	2799	$facedata = Coro::Storable::thaw $facedata;
2124		2800
2125	=item $hashref = cf::db_get $family	2801	$facedata->{version} == 2
		2802	or cf::cleanup "$path: version mismatch, cannot proceed.";
2126		2803
2127	Return a hashref for use by the extension C<$family>, which can be
2128	modified. After modifications, you have to call C<cf::db_dirty> or
2129	C<cf::db_sync>.
2130
2131	=item $value = cf::db_get $family => $key
2132
2133	Returns a single value from the database
2134
2135	=item cf::db_put $family => $hashref
2136
2137	Stores the given family hashref into the database. Updates are delayed, if
2138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140	=item cf::db_put $family => $key => $value
2141
2142	Stores the given C<$value> in the family hash. Updates are delayed, if you
2143	want the data to be synced to disk immediately, use C<cf::db_sync>.
2144
2145	=item cf::db_dirty
2146
2147	Marks the database as dirty, to be updated at a later time.
2148
2149	=item cf::db_sync
2150
2151	Immediately write the database to disk I<if it is dirty>.
2152
2153	=cut
2154
2155	our $DB;
2156
2157	{
2158	my $path = cf::localdir . "/database.pst";
2159
2160	sub db_load() {
2161	$DB = stat $path ? Storable::retrieve $path : { };
2162	}	2804	{
		2805	my $faces = $facedata->{faceinfo};
2163		2806
2164	my $pid;	2807	while (my ($face, $info) = each %$faces) {
		2808	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2809	cf::face::set_visibility $idx, $info->{visibility};
		2810	cf::face::set_magicmap $idx, $info->{magicmap};
		2811	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2812	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2165		2813
2166	sub db_save() {	2814	cf::cede_to_tick;
2167	waitpid $pid, 0 if $pid;
2168	if (0 == ($pid = fork)) {
2169	$DB->{_meta}{version} = 1;
2170	Storable::nstore $DB, "$path~";
2171	rename "$path~", $path;
2172	cf::_exit 0 if defined $pid;
2173	}
2174	}
2175
2176	my $dirty;
2177
2178	sub db_sync() {
2179	db_save if $dirty;
2180	undef $dirty;
2181	}
2182
2183	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2184	db_sync;
2185	});
2186
2187	sub db_dirty() {
2188	$dirty = 1;
2189	$idle->start;
2190	}
2191
2192	sub db_get($;$) {
2193	@_ >= 2
2194	? $DB->{$_[0]}{$_[1]}
2195	: ($DB->{$_[0]} ||= { })
2196	}
2197
2198	sub db_put($$;$) {
2199	if (@_ >= 3) {
2200	$DB->{$_[0]}{$_[1]} = $_[2];
2201	} else {
2202	$DB->{$_[0]} = $_[1];
2203	}
2204	db_dirty;
2205	}
2206
2207	cf::global->attach (
2208	prio => 10000,
2209	on_cleanup => sub {
2210	db_sync;
2211	},	2815	}
2212	);
2213	}
2214		2816
2215	#############################################################################	2817	while (my ($face, $info) = each %$faces) {
2216	# the server's main()	2818	next unless $info->{smooth};
		2819	my $idx = cf::face::find $face
		2820	or next;
		2821	if (my $smooth = cf::face::find $info->{smooth}) {
		2822	cf::face::set_smooth $idx, $smooth;
		2823	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2824	} else {
		2825	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2826	}
		2827
		2828	cf::cede_to_tick;
		2829	}
		2830	}
		2831
		2832	{
		2833	my $anims = $facedata->{animinfo};
		2834
		2835	while (my ($anim, $info) = each %$anims) {
		2836	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2837	cf::cede_to_tick;
		2838	}
		2839
		2840	cf::anim::invalidate_all; # d'oh
		2841	}
		2842
		2843	{
		2844	# TODO: for gcfclient pleasure, we should give resources
		2845	# that gcfclient doesn't grok a >10000 face index.
		2846	my $res = $facedata->{resource};
		2847	my $enc = JSON::XS->new->utf8->canonical;
		2848
		2849	while (my ($name, $info) = each %$res) {
		2850	my $meta = $enc->encode ({
		2851	name => $name,
		2852	type => $info->{type},
		2853	copyright => $info->{copyright}, #TODO#
		2854	});
		2855
		2856	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2857
		2858	if ($name =~ /\.jpg$/) {
		2859	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2860	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2861	} else {
		2862	my $data = pack "(w/a*)*", $meta, $info->{data};
		2863	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2864
		2865	cf::face::set_type $idx, 1;
		2866	cf::face::set_data $idx, 0, $data, $chk;
		2867	}
		2868
		2869	cf::cede_to_tick;
		2870	}
		2871	}
		2872
		2873	1
		2874	}
		2875
		2876	sub reload_regions {
		2877	load_resource_file "$MAPDIR/regions"
		2878	or die "unable to load regions file\n";
		2879
		2880	for (cf::region::list) {
		2881	$_->{match} = qr/$_->{match}/
		2882	if exists $_->{match};
		2883	}
		2884	}
		2885
		2886	sub reload_facedata {
		2887	load_facedata "$DATADIR/facedata"
		2888	or die "unable to load facedata\n";
		2889	}
		2890
		2891	sub reload_archetypes {
		2892	load_resource_file "$DATADIR/archetypes"
		2893	or die "unable to load archetypes\n";
		2894	#d# NEED to laod twice to resolve forward references
		2895	# this really needs to be done in an extra post-pass
		2896	# (which needs to be synchronous, so solve it differently)
		2897	load_resource_file "$DATADIR/archetypes"
		2898	or die "unable to load archetypes\n";
		2899	}
		2900
		2901	sub reload_treasures {
		2902	load_resource_file "$DATADIR/treasures"
		2903	or die "unable to load treasurelists\n";
		2904	}
		2905
		2906	sub reload_resources {
		2907	warn "reloading resource files...\n";
		2908
		2909	reload_regions;
		2910	reload_facedata;
		2911	#reload_archetypes;#d#
		2912	reload_archetypes;
		2913	reload_treasures;
		2914
		2915	warn "finished reloading resource files\n";
		2916	}
		2917
		2918	sub init {
		2919	reload_resources;
		2920	}
2217		2921
2218	sub cfg_load {	2922	sub cfg_load {
2219	open my $fh, "<:utf8", cf::confdir . "/config"	2923	open my $fh, "<:utf8", "$CONFDIR/config"
2220	or return;	2924	or return;
2221		2925
2222	local $/;	2926	local $/;
2223	*CFG = YAML::Syck::Load <$fh>;	2927	*CFG = YAML::Syck::Load <$fh>;
2224		2928
…		…
2244	Event::one_event;	2948	Event::one_event;
2245	})->prio (Coro::PRIO_MAX);	2949	})->prio (Coro::PRIO_MAX);
2246	};	2950	};
2247		2951
2248	cfg_load;	2952	cfg_load;
2249	db_load;	2953	db_init;
2250	load_extensions;	2954	load_extensions;
2251		2955
2252	$TICK_WATCHER->start;	2956	$TICK_WATCHER->start;
2253	Event::loop;	2957	Event::loop;
2254	}	2958	}
…		…
2258		2962
2259	# install some emergency cleanup handlers	2963	# install some emergency cleanup handlers
2260	BEGIN {	2964	BEGIN {
2261	for my $signal (qw(INT HUP TERM)) {	2965	for my $signal (qw(INT HUP TERM)) {
2262	Event->signal (	2966	Event->signal (
		2967	reentrant => 0,
2263	data => WF_AUTOCANCEL,	2968	data => WF_AUTOCANCEL,
2264	signal => $signal,	2969	signal => $signal,
		2970	prio => 0,
2265	cb => sub {	2971	cb => sub {
2266	cf::cleanup "SIG$signal";	2972	cf::cleanup "SIG$signal";
2267	},	2973	},
2268	);	2974	);
2269	}	2975	}
		2976	}
		2977
		2978	sub write_runtime {
		2979	my $runtime = "$LOCALDIR/runtime";
		2980
		2981	# first touch the runtime file to show we are still running:
		2982	# the fsync below can take a very very long time.
		2983
		2984	IO::AIO::aio_utime $runtime, undef, undef;
		2985
		2986	my $guard = cf::lock_acquire "write_runtime";
		2987
		2988	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2989	or return;
		2990
		2991	my $value = $cf::RUNTIME + 90 + 10;
		2992	# 10 is the runtime save interval, for a monotonic clock
		2993	# 60 allows for the watchdog to kill the server.
		2994
		2995	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2996	and return;
		2997
		2998	# always fsync - this file is important
		2999	aio_fsync $fh
		3000	and return;
		3001
		3002	# touch it again to show we are up-to-date
		3003	aio_utime $fh, undef, undef;
		3004
		3005	close $fh
		3006	or return;
		3007
		3008	aio_rename "$runtime~", $runtime
		3009	and return;
		3010
		3011	warn "runtime file written.\n";
		3012
		3013	1
2270	}	3014	}
2271		3015
2272	sub emergency_save() {	3016	sub emergency_save() {
2273	my $freeze_guard = cf::freeze_mainloop;	3017	my $freeze_guard = cf::freeze_mainloop;
2274		3018
…		…
2291	my $map = $cf::MAP{$path} or next;	3035	my $map = $cf::MAP{$path} or next;
2292	$map->valid or next;	3036	$map->valid or next;
2293	$map->save;	3037	$map->save;
2294	}	3038	}
2295	warn "end emergency map save\n";	3039	warn "end emergency map save\n";
		3040
		3041	warn "begin emergency database checkpoint\n";
		3042	BDB::db_env_txn_checkpoint $DB_ENV;
		3043	warn "end emergency database checkpoint\n";
2296	};	3044	};
2297		3045
2298	warn "leave emergency perl save\n";	3046	warn "leave emergency perl save\n";
2299	}	3047	}
2300		3048
		3049	sub post_cleanup {
		3050	my ($make_core) = @_;
		3051
		3052	warn Carp::longmess "post_cleanup backtrace"
		3053	if $make_core;
		3054	}
		3055
2301	sub reload() {	3056	sub do_reload_perl() {
2302	# can/must only be called in main	3057	# can/must only be called in main
2303	if ($Coro::current != $Coro::main) {	3058	if ($Coro::current != $Coro::main) {
2304	warn "can only reload from main coroutine";	3059	warn "can only reload from main coroutine";
2305	return;	3060	return;
2306	}	3061	}
2307		3062
2308	warn "reloading...";	3063	warn "reloading...";
2309		3064
2310	warn "cancelling server ticker";	3065	warn "entering sync_job";
2311	$TICK_WATCHER->cancel;
2312		3066
		3067	cf::sync_job {
		3068	cf::write_runtime; # external watchdog should not bark
2313	cf::emergency_save;	3069	cf::emergency_save;
		3070	cf::write_runtime; # external watchdog should not bark
2314		3071
2315	eval {	3072	warn "syncing database to disk";
		3073	BDB::db_env_txn_checkpoint $DB_ENV;
		3074
2316	# if anything goes wrong in here, we should simply crash as we already saved	3075	# if anything goes wrong in here, we should simply crash as we already saved
2317
2318	warn "syncing database to disk";
2319	cf::db_sync;
2320		3076
2321	warn "cancelling all WF_AUTOCANCEL watchers";	3077	warn "cancelling all WF_AUTOCANCEL watchers";
2322	for (Event::all_watchers) {	3078	for (Event::all_watchers) {
2323	$_->cancel if $_->data & WF_AUTOCANCEL;	3079	$_->cancel if $_->data & WF_AUTOCANCEL;
2324	}	3080	}
2325		3081
2326	warn "flushing outstanding aio requests";	3082	warn "flushing outstanding aio requests";
2327	for (;;) {	3083	for (;;) {
		3084	BDB::flush;
2328	IO::AIO::flush;	3085	IO::AIO::flush;
2329	Coro::cede;	3086	Coro::cede;
2330	last unless IO::AIO::nreqs;	3087	last unless IO::AIO::nreqs || BDB::nreqs;
2331	warn "iterate...";	3088	warn "iterate...";
2332	}	3089	}
		3090
		3091	++$RELOAD;
2333		3092
2334	warn "cancelling all extension coros";	3093	warn "cancelling all extension coros";
2335	$_->cancel for values %EXT_CORO;	3094	$_->cancel for values %EXT_CORO;
2336	%EXT_CORO = ();	3095	%EXT_CORO = ();
2337		3096
2338	warn "removing commands";	3097	warn "removing commands";
2339	%COMMAND = ();	3098	%COMMAND = ();
2340		3099
2341	warn "removing ext commands";	3100	warn "removing ext/exti commands";
2342	%EXTCMD = ();	3101	%EXTCMD = ();
		3102	%EXTICMD = ();
2343		3103
2344	warn "unloading/nuking all extensions";	3104	warn "unloading/nuking all extensions";
2345	for my $pkg (@EXTS) {	3105	for my $pkg (@EXTS) {
2346	warn "... unloading $pkg";	3106	warn "... unloading $pkg";
2347		3107
…		…
2377	Symbol::delete_package "safe::$_"	3137	Symbol::delete_package "safe::$_"
2378	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3138	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2379		3139
2380	warn "unloading cf.pm \"a bit\"";	3140	warn "unloading cf.pm \"a bit\"";
2381	delete $INC{"cf.pm"};	3141	delete $INC{"cf.pm"};
		3142	delete $INC{"cf/pod.pm"};
2382		3143
2383	# don't, removes xs symbols, too,	3144	# don't, removes xs symbols, too,
2384	# and global variables created in xs	3145	# and global variables created in xs
2385	#Symbol::delete_package __PACKAGE__;	3146	#Symbol::delete_package __PACKAGE__;
2386		3147
…		…
2390	require cf;	3151	require cf;
2391	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3152	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2392		3153
2393	warn "loading config and database again";	3154	warn "loading config and database again";
2394	cf::cfg_load;	3155	cf::cfg_load;
2395	cf::db_load;
2396		3156
2397	warn "loading extensions";	3157	warn "loading extensions";
2398	cf::load_extensions;	3158	cf::load_extensions;
2399		3159
2400	warn "reattaching attachments to objects/players";	3160	warn "reattaching attachments to objects/players";
2401	_global_reattach;	3161	_global_reattach; # objects, sockets
2402	warn "reattaching attachments to maps";	3162	warn "reattaching attachments to maps";
2403	reattach $_ for values %MAP;	3163	reattach $_ for values %MAP;
		3164	warn "reattaching attachments to players";
		3165	reattach $_ for values %PLAYER;
2404		3166
2405	warn "restarting server ticker";	3167	warn "leaving sync_job";
2406		3168
2407	$TICK_WATCHER->start;	3169	1
2408	};	3170	} or do {
2409
2410	if ($@) {
2411	warn $@;	3171	warn $@;
2412	warn "error while reloading, exiting.";	3172	warn "error while reloading, exiting.";
2413	exit 1;	3173	exit 1;
2414	}	3174	};
2415		3175
2416	warn "reloaded";	3176	warn "reloaded";
2417	};	3177	};
2418		3178
2419	our $RELOAD_WATCHER; # used only during reload	3179	our $RELOAD_WATCHER; # used only during reload
2420		3180
		3181	sub reload_perl() {
		3182	# doing reload synchronously and two reloads happen back-to-back,
		3183	# coro crashes during coro_state_free->destroy here.
		3184
		3185	$RELOAD_WATCHER ||= Event->timer (
		3186	reentrant => 0,
		3187	after => 0,
		3188	data => WF_AUTOCANCEL,
		3189	cb => sub {
		3190	do_reload_perl;
		3191	undef $RELOAD_WATCHER;
		3192	},
		3193	);
		3194	}
		3195
2421	register_command "reload" => sub {	3196	register_command "reload" => sub {
2422	my ($who, $arg) = @_;	3197	my ($who, $arg) = @_;
2423		3198
2424	if ($who->flag (FLAG_WIZ)) {	3199	if ($who->flag (FLAG_WIZ)) {
2425	$who->message ("reloading server.");	3200	$who->message ("reloading server.");
2426		3201	async { reload_perl };
2427	# doing reload synchronously and two reloads happen back-to-back,
2428	# coro crashes during coro_state_free->destroy here.
2429
2430	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2431	reload;
2432	undef $RELOAD_WATCHER;
2433	});
2434	}	3202	}
2435	};	3203	};
2436		3204
2437	unshift @INC, $LIBDIR;	3205	unshift @INC, $LIBDIR;
2438		3206
2439	my $bug_warning = 0;	3207	my $bug_warning = 0;
2440		3208
		3209	our @WAIT_FOR_TICK;
		3210	our @WAIT_FOR_TICK_BEGIN;
		3211
		3212	sub wait_for_tick {
		3213	return unless $TICK_WATCHER->is_active;
		3214	return if $Coro::current == $Coro::main;
		3215
		3216	my $signal = new Coro::Signal;
		3217	push @WAIT_FOR_TICK, $signal;
		3218	$signal->wait;
		3219	}
		3220
		3221	sub wait_for_tick_begin {
		3222	return unless $TICK_WATCHER->is_active;
		3223	return if $Coro::current == $Coro::main;
		3224
		3225	my $signal = new Coro::Signal;
		3226	push @WAIT_FOR_TICK_BEGIN, $signal;
		3227	$signal->wait;
		3228	}
		3229
		3230	my $min = 1e6;#d#
		3231	my $avg = 10;
2441	$TICK_WATCHER = Event->timer (	3232	$TICK_WATCHER = Event->timer (
2442	reentrant => 0,	3233	reentrant => 0,
2443	parked => 1,	3234	parked => 1,
2444	prio => 0,	3235	prio => 0,
2445	at => $NEXT_TICK || $TICK,	3236	at => $NEXT_TICK || $TICK,
…		…
2449	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3240	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2450	unless ++$bug_warning > 10;	3241	unless ++$bug_warning > 10;
2451	return;	3242	return;
2452	}	3243	}
2453		3244
2454	$NOW = Event::time;	3245	$NOW = $tick_start = Event::time;
2455		3246
2456	cf::server_tick; # one server iteration	3247	cf::server_tick; # one server iteration
		3248
		3249	0 && sync_job {#d#
		3250	for(1..10) {
		3251	my $t = Event::time;
		3252	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3253	or die;
		3254
		3255	$map->width (50);
		3256	$map->height (50);
		3257	$map->alloc;
		3258	$map->_load_objects ("/tmp/x.map", 1);
		3259	my $t = Event::time - $t;
		3260
		3261	#next unless $t < 0.0013;#d#
		3262	if ($t < $min) {
		3263	$min = $t;
		3264	}
		3265	$avg = $avg * 0.99 + $t * 0.01;
		3266	}
		3267	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3268	exit 0;
		3269	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3270	};
		3271
2457	$RUNTIME += $TICK;	3272	$RUNTIME += $TICK;
2458	$NEXT_TICK += $TICK;	3273	$NEXT_TICK += $TICK;
2459		3274
2460	$WAIT_FOR_TICK->broadcast;	3275	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2461	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3276	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3277	Coro::async_pool {
		3278	write_runtime
		3279	or warn "ERROR: unable to write runtime file: $!";
		3280	};
		3281	}
		3282
		3283	# my $AFTER = Event::time;
		3284	# warn $AFTER - $NOW;#d#
		3285
		3286	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3287	$sig->send;
		3288	}
		3289	while (my $sig = shift @WAIT_FOR_TICK) {
		3290	$sig->send;
		3291	}
		3292
		3293	$NOW = Event::time;
2462		3294
2463	# if we are delayed by four ticks or more, skip them all	3295	# if we are delayed by four ticks or more, skip them all
2464	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3296	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2465		3297
2466	$TICK_WATCHER->at ($NEXT_TICK);	3298	$TICK_WATCHER->at ($NEXT_TICK);
2467	$TICK_WATCHER->start;	3299	$TICK_WATCHER->start;
		3300
		3301	$LOAD = ($NOW - $tick_start) / $TICK;
		3302	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3303
		3304	_post_tick;
		3305
		3306
2468	},	3307	},
2469	);	3308	);
2470		3309
		3310	{
		3311	BDB::max_poll_time $TICK * 0.1;
		3312	$BDB_POLL_WATCHER = Event->io (
		3313	reentrant => 0,
		3314	fd => BDB::poll_fileno,
		3315	poll => 'r',
		3316	prio => 0,
		3317	data => WF_AUTOCANCEL,
		3318	cb => \&BDB::poll_cb,
		3319	);
		3320	BDB::min_parallel 8;
		3321
		3322	BDB::set_sync_prepare {
		3323	my $status;
		3324	my $current = $Coro::current;
		3325	(
		3326	sub {
		3327	$status = $!;
		3328	$current->ready; undef $current;
		3329	},
		3330	sub {
		3331	Coro::schedule while defined $current;
		3332	$! = $status;
		3333	},
		3334	)
		3335	};
		3336
		3337	unless ($DB_ENV) {
		3338	$DB_ENV = BDB::db_env_create;
		3339
		3340	cf::sync_job {
		3341	eval {
		3342	BDB::db_env_open
		3343	$DB_ENV,
		3344	$BDBDIR,
		3345	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3346	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3347	0666;
		3348
		3349	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3350
		3351	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3352	$DB_ENV->set_lk_detect;
		3353	};
		3354
		3355	cf::cleanup "db_env_open(db): $@" if $@;
		3356	};
		3357	}
		3358	}
		3359
		3360	{
		3361	IO::AIO::min_parallel 8;
		3362
		3363	undef $Coro::AIO::WATCHER;
2471	IO::AIO::max_poll_time $TICK * 0.2;	3364	IO::AIO::max_poll_time $TICK * 0.1;
2472
2473	$AIO_POLL_WATCHER = Event->io (	3365	$AIO_POLL_WATCHER = Event->io (
2474	fd => IO::AIO::poll_fileno,	3366	reentrant => 0,
2475	poll => 'r',
2476	prio => 5,
2477	data => WF_AUTOCANCEL,
2478	cb => \&IO::AIO::poll_cb,
2479	);
2480
2481	$WRITE_RUNTIME_WATCHER = Event->timer (
2482	data => WF_AUTOCANCEL,	3367	data => WF_AUTOCANCEL,
2483	after => 1,	3368	fd => IO::AIO::poll_fileno,
2484	interval => 10,	3369	poll => 'r',
2485	prio => 6, # keep it lowest so it acts like a watchdog	3370	prio => 6,
2486	cb => Coro::unblock_sub {	3371	cb => \&IO::AIO::poll_cb,
2487	write_runtime	3372	);
2488	or warn "ERROR: unable to write runtime file: $!";	3373	}
		3374
		3375	my $_log_backtrace;
		3376
		3377	sub _log_backtrace {
		3378	my ($msg, @addr) = @_;
		3379
		3380	$msg =~ s/\n//;
		3381
		3382	# limit the # of concurrent backtraces
		3383	if ($_log_backtrace < 2) {
		3384	++$_log_backtrace;
		3385	async {
		3386	my @bt = fork_call {
		3387	@addr = map { sprintf "%x", $_ } @addr;
		3388	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3389	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3390	or die "addr2line: $!";
		3391
		3392	my @funcs;
		3393	my @res = <$fh>;
		3394	chomp for @res;
		3395	while (@res) {
		3396	my ($func, $line) = splice @res, 0, 2, ();
		3397	push @funcs, "[$func] $line";
		3398	}
		3399
		3400	@funcs
		3401	};
		3402
		3403	LOG llevInfo, "[ABT] $msg\n";
		3404	LOG llevInfo, "[ABT] $_\n" for @bt;
		3405	--$_log_backtrace;
		3406	};
		3407	} else {
		3408	LOG llevInfo, "[ABT] $msg\n";
		3409	LOG llevInfo, "[ABT] [suppressed]\n";
2489	},	3410	}
2490	);	3411	}
		3412
		3413	# load additional modules
		3414	use cf::pod;
2491		3415
2492	END { cf::emergency_save }	3416	END { cf::emergency_save }
2493		3417
2494	1	3418	1
2495		3419

Diff Legend

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