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.193 by root, Wed Jan 24 16:29:10 2007 UTC vs.
Revision 1.334 by root, Mon Aug 20 22:09:04 2007 UTC

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

Diff Legend

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