ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.190 by root, Mon Jan 22 03:44:41 2007 UTC vs.
Revision 1.332 by root, Sat Aug 18 17:33:53 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.4 ();	15	use Coro 3.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) = @_;
		1631
		1632	$path = "$path"; # make sure its a string
		1633
		1634	$path =~ s/\.map$//;
1180		1635
1181	# map plan:	1636	# map plan:
1182	#	1637	#
1183	# /! non-realised random map exit (special hack!)	1638	# /! non-realised random map exit (special hack!)
1184	# {... are special paths that are not being touched	1639	# {... are special paths that are not being touched
…		…
1221	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1222	return $self;	1677	return $self;
1223	}	1678	}
1224	}	1679	}
1225		1680
1226	Carp::carp "unable to resolve path '$path'.";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1227	()	1682	()
1228	}	1683	}
1229		1684
1230	sub init {	1685	sub init {
1231	my ($self) = @_;	1686	my ($self) = @_;
…		…
1246		1701
1247	# the original (read-only) location	1702	# the original (read-only) location
1248	sub load_path {	1703	sub load_path {
1249	my ($self) = @_;	1704	my ($self) = @_;
1250		1705
1251	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1706	"$MAPDIR/$self->{path}.map"
1252	}	1707	}
1253		1708
1254	# the temporary/swap location	1709	# the temporary/swap location
1255	sub save_path {	1710	sub save_path {
1256	my ($self) = @_;	1711	my ($self) = @_;
1257		1712
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1714	"$TMPDIR/$path.map"
1260	}	1715	}
1261		1716
1262	# the unique path, undef == no special unique path	1717	# the unique path, undef == no special unique path
1263	sub uniq_path {	1718	sub uniq_path {
1264	my ($self) = @_;	1719	my ($self) = @_;
1265		1720
1266	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1722	"$UNIQUEDIR/$path"
1268	}	1723	}
1269		1724
1270	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1271	# all maps in C++...	1726	# all maps in C++...
1272	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1274		1729
1275	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1276	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1277	}	1732	}
1278		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
1279	sub unlink_save {	1742	sub unlink_save {
1280	my ($self) = @_;	1743	my ($self) = @_;
1281		1744
1282	utf8::encode (my $save = $self->save_path);	1745	utf8::encode (my $save = $self->save_path);
1283	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1286		1749
1287	sub load_header_from($) {	1750	sub load_header_from($) {
1288	my ($self, $path) = @_;	1751	my ($self, $path) = @_;
1289		1752
1290	utf8::encode $path;	1753	utf8::encode $path;
1291	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
1292	or return;	1755	# or return;
1293		1756
1294	$self->_load_header ($path)	1757	$self->_load_header ($path)
1295	or return;	1758	or return;
1296		1759
1297	$self->{load_path} = $path;	1760	$self->{load_path} = $path;
…		…
1339	$self->load_header_orig	1802	$self->load_header_orig
1340	or return;	1803	or return;
1341	$self->prepare_orig;	1804	$self->prepare_orig;
1342	}	1805	}
1343		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
1344	1	1813	1
1345	}	1814	}
1346		1815
1347	sub find;	1816	sub find;
1348	sub find {	1817	sub find {
…		…
1360	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1361		1830
1362	$map->load_header	1831	$map->load_header
1363	or return;	1832	or return;
1364		1833
1365	if ($map->should_reset) {	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1366	# doing this can freeze the server in a sync job, obviously	1835	# doing this can freeze the server in a sync job, obviously
1367	#$cf::WAIT_FOR_TICK->wait;	1836	#$cf::WAIT_FOR_TICK->wait;
1368	$map->reset;	1837	$map->reset;
1369	undef $guard;	1838	undef $guard;
1370	$map = find $path	1839	return find $path;
1371	or return;
1372	}	1840	}
1373		1841
1374	$cf::MAP{$path} = $map	1842	$cf::MAP{$path} = $map
1375	}	1843	}
1376	}	1844	}
…		…
1379	sub post_load { }	1847	sub post_load { }
1380		1848
1381	sub load {	1849	sub load {
1382	my ($self) = @_;	1850	my ($self) = @_;
1383		1851
		1852	local $self->{deny_reset} = 1; # loading can take a long time
		1853
1384	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
1385	my $guard = cf::lock_acquire "map_load:$path";	1857	my $guard = cf::lock_acquire "map_load:$path";
1386		1858
1387	return if $self->in_memory != cf::MAP_SWAPPED;	1859	return if $self->in_memory != cf::MAP_SWAPPED;
1388		1860
1389	$self->in_memory (cf::MAP_LOADING);	1861	$self->in_memory (cf::MAP_LOADING);
1390		1862
1391	$self->alloc;	1863	$self->alloc;
1392		1864
1393	$self->pre_load;	1865	$self->pre_load;
1394
1395	$self->_load_objects ($self->{load_path}, 1)
1396	or return;
1397
1398	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1399	if delete $self->{load_original};
1400
1401	if (my $uniq = $self->uniq_path) {
1402	utf8::encode $uniq;
1403	if (aio_open $uniq, O_RDONLY, 0) {
1404	$self->clear_unique_items;
1405	$self->_load_objects ($uniq, 0);
1406	}
1407	}
1408
1409	Coro::cede;
1410
1411	# now do the right thing for maps
1412	$self->link_multipart_objects;
1413
1414	unless ($self->{deny_activate}) {
1415	$self->decay_objects;
1416	$self->fix_auto_apply;
1417	$self->update_buttons;
1418	Coro::cede;	1866	Coro::cede;
1419	$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;
1420	$self->difficulty ($self->estimate_difficulty)	1885	$self->difficulty ($self->estimate_difficulty)
1421	unless $self->difficulty;	1886	unless $self->difficulty;
1422	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;
1423	$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);
1424	}	1903	}
1425		1904
1426	$self->post_load;	1905	$self->post_load;
1427
1428	$self->in_memory (cf::MAP_IN_MEMORY);
1429	}	1906	}
1430		1907
1431	sub customise_for {	1908	sub customise_for {
1432	my ($self, $ob) = @_;	1909	my ($self, $ob) = @_;
1433		1910
1434	return find "~" . $ob->name . "/" . $self->{path}	1911	return find "~" . $ob->name . "/" . $self->{path}
1435	if $self->per_player;	1912	if $self->per_player;
		1913
		1914	# return find "?party/" . $ob->name . "/" . $self->{path}
		1915	# if $self->per_party;
1436		1916
1437	$self	1917	$self
1438	}	1918	}
1439		1919
1440	# 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
…		…
1487		1967
1488	undef $MAP_PREFETCH{$path};	1968	undef $MAP_PREFETCH{$path};
1489	$MAP_PREFETCHER ||= cf::async {	1969	$MAP_PREFETCHER ||= cf::async {
1490	while (%MAP_PREFETCH) {	1970	while (%MAP_PREFETCH) {
1491	for my $path (keys %MAP_PREFETCH) {	1971	for my $path (keys %MAP_PREFETCH) {
1492	my $map = find $path	1972	if (my $map = find $path) {
1493	or next;
1494	$map->load;	1973	$map->load;
		1974	}
1495		1975
1496	delete $MAP_PREFETCH{$path};	1976	delete $MAP_PREFETCH{$path};
1497	}	1977	}
1498	}	1978	}
1499	undef $MAP_PREFETCHER;	1979	undef $MAP_PREFETCHER;
…		…
1551		2031
1552	sub reset_at {	2032	sub reset_at {
1553	my ($self) = @_;	2033	my ($self) = @_;
1554		2034
1555	# TODO: safety, remove and allow resettable per-player maps	2035	# TODO: safety, remove and allow resettable per-player maps
1556	return 1e99 if $self->isa ("ext::map_per_player");#d#
1557	return 1e99 if $self->{deny_reset};	2036	return 1e99 if $self->{deny_reset};
1558		2037
1559	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2038	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1560	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2039	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1561		2040
…		…
1572	my ($self) = @_;	2051	my ($self) = @_;
1573		2052
1574	my $lock = cf::lock_acquire "map_data:$self->{path}";	2053	my $lock = cf::lock_acquire "map_data:$self->{path}";
1575		2054
1576	return if $self->players;	2055	return if $self->players;
1577	return if $self->isa ("ext::map_per_player");#d#
1578		2056
1579	warn "resetting map ", $self->path;#d#	2057	warn "resetting map ", $self->path;
		2058
		2059	$self->in_memory (cf::MAP_SWAPPED);
		2060
		2061	# need to save uniques path
		2062	unless ($self->{deny_save}) {
		2063	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2064
		2065	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2066	if $uniq;
		2067	}
1580		2068
1581	delete $cf::MAP{$self->path};	2069	delete $cf::MAP{$self->path};
1582		2070
1583	$self->in_memory (cf::MAP_SWAPPED);
1584	$self->clear;	2071	$self->clear;
1585		2072
1586	$_->clear_links_to ($self) for values %cf::MAP;	2073	$_->clear_links_to ($self) for values %cf::MAP;
1587		2074
1588	$self->unlink_save;	2075	$self->unlink_save;
…		…
1607	$cf::MAP{$self->path} = $self;	2094	$cf::MAP{$self->path} = $self;
1608		2095
1609	$self->reset; # polite request, might not happen	2096	$self->reset; # polite request, might not happen
1610	}	2097	}
1611		2098
		2099	=item $maps = cf::map::tmp_maps
		2100
		2101	Returns an arrayref with all map paths of currently instantiated and saved
		2102	maps. May block.
		2103
		2104	=cut
		2105
		2106	sub tmp_maps() {
		2107	[
		2108	map {
		2109	utf8::decode $_;
		2110	/\.map$/
		2111	? normalise $_
		2112	: ()
		2113	} @{ aio_readdir $TMPDIR or [] }
		2114	]
		2115	}
		2116
		2117	=item $maps = cf::map::random_maps
		2118
		2119	Returns an arrayref with all map paths of currently instantiated and saved
		2120	random maps. May block.
		2121
		2122	=cut
		2123
		2124	sub random_maps() {
		2125	[
		2126	map {
		2127	utf8::decode $_;
		2128	/\.map$/
		2129	? normalise "?random/$_"
		2130	: ()
		2131	} @{ aio_readdir $RANDOMDIR or [] }
		2132	]
		2133	}
		2134
1612	=item cf::map::unique_maps	2135	=item cf::map::unique_maps
1613		2136
1614	Returns an arrayref of paths of all shared maps that have	2137	Returns an arrayref of paths of all shared maps that have
1615	instantiated unique items. May block.	2138	instantiated unique items. May block.
1616		2139
1617	=cut	2140	=cut
1618		2141
1619	sub unique_maps() {	2142	sub unique_maps() {
1620	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2143	[
1621	or return;	2144	map {
1622
1623	my @paths;
1624
1625	for (@$files) {
1626	utf8::decode $_;	2145	utf8::decode $_;
1627	next if /\.pst$/;
1628	next unless /^$PATH_SEP/o;
1629
1630	s/\.map$//;	2146	/\.map$/
1631	push @paths, $_;	2147	? normalise $_
		2148	: ()
		2149	} @{ aio_readdir $UNIQUEDIR or [] }
1632	}	2150	]
1633
1634	\@paths
1635	}	2151	}
1636		2152
1637	package cf;	2153	package cf;
1638		2154
1639	=back	2155	=back
…		…
1685		2201
1686	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2202	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1687		2203
1688	if ($self->{record_replies}) {	2204	if ($self->{record_replies}) {
1689	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2205	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2206
1690	} else {	2207	} else {
		2208	my $pl = $self->contr;
		2209
		2210	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2211	my $dialog = $pl->{npc_dialog};
		2212	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2213
		2214	} else {
1691	$msg = $npc->name . " says: $msg" if $npc;	2215	$msg = $npc->name . " says: $msg" if $npc;
1692	$self->message ($msg, $flags);	2216	$self->message ($msg, $flags);
		2217	}
1693	}	2218	}
		2219	}
		2220
		2221	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2222
		2223	=cut
		2224
		2225	sub cf::object::send_msg {
		2226	my $pl = shift->contr
		2227	or return;
		2228	$pl->send_msg (@_);
1694	}	2229	}
1695		2230
1696	=item $player_object->may ("access")	2231	=item $player_object->may ("access")
1697		2232
1698	Returns wether the given player is authorized to access resource "access"	2233	Returns wether the given player is authorized to access resource "access"
…		…
1730	=cut	2265	=cut
1731		2266
1732	sub link_map {	2267	sub link_map {
1733	unless ($LINK_MAP) {	2268	unless ($LINK_MAP) {
1734	$LINK_MAP = cf::map::find "{link}"	2269	$LINK_MAP = cf::map::find "{link}"
1735	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2270	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1736	$LINK_MAP->load;	2271	$LINK_MAP->load;
1737	}	2272	}
1738		2273
1739	$LINK_MAP	2274	$LINK_MAP
1740	}	2275	}
…		…
1745	$self->deactivate_recursive;	2280	$self->deactivate_recursive;
1746		2281
1747	return if UNIVERSAL::isa $self->map, "ext::map_link";	2282	return if UNIVERSAL::isa $self->map, "ext::map_link";
1748		2283
1749	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2284	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1750	if $self->map;	2285	if $self->map && $self->map->{path} ne "{link}";
1751		2286
1752	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2287	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1753	}	2288	}
1754		2289
1755	sub cf::object::player::leave_link {	2290	sub cf::object::player::leave_link {
1756	my ($self, $map, $x, $y) = @_;	2291	my ($self, $map, $x, $y) = @_;
		2292
		2293	return unless $self->contr->active;
1757		2294
1758	my $link_pos = delete $self->{_link_pos};	2295	my $link_pos = delete $self->{_link_pos};
1759		2296
1760	unless ($map) {	2297	unless ($map) {
1761	# restore original map position	2298	# restore original map position
…		…
1779	$map->load;	2316	$map->load;
1780	$map->load_diag;	2317	$map->load_diag;
1781		2318
1782	return unless $self->contr->active;	2319	return unless $self->contr->active;
1783	$self->activate_recursive;	2320	$self->activate_recursive;
		2321
		2322	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1784	$self->enter_map ($map, $x, $y);	2323	$self->enter_map ($map, $x, $y);
1785	}	2324	}
1786		2325
1787	cf::player->attach (	2326	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1788	on_logout => sub {
1789	my ($pl) = @_;
1790		2327
1791	# abort map switching before logout	2328	Moves the player to the given map-path and coordinates by first freezing
1792	if ($pl->ob->{_link_pos}) {	2329	her, loading and preparing them map, calling the provided $check callback
1793	cf::sync_job {	2330	that has to return the map if sucecssful, and then unfreezes the player on
1794	$pl->ob->leave_link	2331	the new (success) or old (failed) map position. In either case, $done will
1795	};	2332	be called at the end of this process.
1796	}
1797	},
1798	on_login => sub {
1799	my ($pl) = @_;
1800		2333
1801	# try to abort aborted map switching on player login :)
1802	# should happen only on crashes
1803	if ($pl->ob->{_link_pos}) {
1804	$pl->ob->enter_link;
1805	(async {
1806	# we need this sleep as the login has a concurrent enter_exit running
1807	# and this sleep increases chances of the player not ending up in scorn
1808	$pl->ob->reply (undef,
1809	"There was an internal problem at your last logout, "
1810	. "the server will try to bring you to your intended destination in a second.",
1811	cf::NDI_RED);
1812	Coro::Timer::sleep 1;
1813	$pl->ob->leave_link;
1814	})->prio (2);
1815	}
1816	},
1817	);
1818
1819	=item $player_object->goto ($path, $x, $y)
1820
1821	=cut	2334	=cut
		2335
		2336	our $GOTOGEN;
1822		2337
1823	sub cf::object::player::goto {	2338	sub cf::object::player::goto {
1824	my ($self, $path, $x, $y) = @_;	2339	my ($self, $path, $x, $y, $check, $done) = @_;
		2340
		2341	# do generation counting so two concurrent goto's will be executed in-order
		2342	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1825		2343
1826	$self->enter_link;	2344	$self->enter_link;
1827		2345
1828	(async {	2346	(async {
		2347	my $map = eval {
1829	my $map = cf::map::find $path;	2348	my $map = cf::map::find $path;
		2349
		2350	if ($map) {
1830	$map = $map->customise_for ($self) if $map;	2351	$map = $map->customise_for ($self);
1831		2352	$map = $check->($map) if $check && $map;
1832	# warn "entering ", $map->path, " at ($x, $y)\n"	2353	} else {
1833	# if $map;
1834
1835	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2354	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2355	}
1836		2356
		2357	$map
		2358	};
		2359
		2360	if ($@) {
		2361	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2362	LOG llevError | logBacktrace, Carp::longmess $@;
		2363	}
		2364
		2365	if ($gen == $self->{_goto_generation}) {
		2366	delete $self->{_goto_generation};
1837	$self->leave_link ($map, $x, $y);	2367	$self->leave_link ($map, $x, $y);
		2368	}
		2369
		2370	$done->() if $done;
1838	})->prio (1);	2371	})->prio (1);
1839	}	2372	}
1840		2373
1841	=item $player_object->enter_exit ($exit_object)	2374	=item $player_object->enter_exit ($exit_object)
1842		2375
…		…
1871	# that depends on the exit object	2404	# that depends on the exit object
1872		2405
1873	my $rmp = parse_random_map_params $exit->msg;	2406	my $rmp = parse_random_map_params $exit->msg;
1874		2407
1875	if ($exit->map) {	2408	if ($exit->map) {
1876	$rmp->{region} = $exit->map->region_name;	2409	$rmp->{region} = $exit->region->name;
1877	$rmp->{origin_map} = $exit->map->path;	2410	$rmp->{origin_map} = $exit->map->path;
1878	$rmp->{origin_x} = $exit->x;	2411	$rmp->{origin_x} = $exit->x;
1879	$rmp->{origin_y} = $exit->y;	2412	$rmp->{origin_y} = $exit->y;
1880	}	2413	}
1881		2414
1882	$rmp->{random_seed} ||= $exit->random_seed;	2415	$rmp->{random_seed} ||= $exit->random_seed;
1883		2416
1884	my $data = cf::to_json $rmp;	2417	my $data = cf::to_json $rmp;
1885	my $md5 = Digest::MD5::md5_hex $data;	2418	my $md5 = Digest::MD5::md5_hex $data;
1886	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2419	my $meta = "$RANDOMDIR/$md5.meta";
1887		2420
1888	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2421	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1889	aio_write $fh, 0, (length $data), $data, 0;	2422	aio_write $fh, 0, (length $data), $data, 0;
1890	undef $fh;	2423	undef $fh;
1891	aio_rename "$meta~", $meta;	2424	aio_rename "$meta~", $meta;
…		…
1898	sub cf::object::player::enter_exit {	2431	sub cf::object::player::enter_exit {
1899	my ($self, $exit) = @_;	2432	my ($self, $exit) = @_;
1900		2433
1901	return unless $self->type == cf::PLAYER;	2434	return unless $self->type == cf::PLAYER;
1902		2435
		2436	if ($exit->slaying eq "/!") {
		2437	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2438	# the problem is that $exit might not survive long enough
		2439	# so it needs to be done right now, right here
		2440	cf::sync_job { prepare_random_map $exit };
		2441	}
		2442
		2443	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2444	my $hp = $exit->stats->hp;
		2445	my $sp = $exit->stats->sp;
		2446
1903	$self->enter_link;	2447	$self->enter_link;
		2448
		2449	# if exit is damned, update players death & WoR home-position
		2450	$self->contr->savebed ($slaying, $hp, $sp)
		2451	if $exit->flag (FLAG_DAMNED);
1904		2452
1905	(async {	2453	(async {
1906	$self->deactivate_recursive; # just to be sure	2454	$self->deactivate_recursive; # just to be sure
1907	unless (eval {	2455	unless (eval {
1908	prepare_random_map $exit	2456	$self->goto ($slaying, $hp, $sp);
1909	if $exit->slaying eq "/!";
1910
1911	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1912	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1913		2457
1914	1;	2458	1;
1915	}) {	2459	}) {
1916	$self->message ("Something went wrong deep within the crossfire server. "	2460	$self->message ("Something went wrong deep within the crossfire server. "
1917	. "I'll try to bring you back to the map you were before. "	2461	. "I'll try to bring you back to the map you were before. "
1918	. "Please report this to the dungeon master!",	2462	. "Please report this to the dungeon master!",
1919	cf::NDI_UNIQUE | cf::NDI_RED);	2463	cf::NDI_UNIQUE | cf::NDI_RED);
1920		2464
1921	warn "ERROR in enter_exit: $@";	2465	warn "ERROR in enter_exit: $@";
1922	$self->leave_link;	2466	$self->leave_link;
1923	}	2467	}
1924	})->prio (1);	2468	})->prio (1);
…		…
1937		2481
1938	sub cf::client::send_drawinfo {	2482	sub cf::client::send_drawinfo {
1939	my ($self, $text, $flags) = @_;	2483	my ($self, $text, $flags) = @_;
1940		2484
1941	utf8::encode $text;	2485	utf8::encode $text;
1942	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2486	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1943	}	2487	}
1944		2488
		2489	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2490
		2491	Send a drawinfo or msg packet to the client, formatting the msg for the
		2492	client if neccessary. C<$type> should be a string identifying the type of
		2493	the message, with C<log> being the default. If C<$color> is negative, suppress
		2494	the message unless the client supports the msg packet.
		2495
		2496	=cut
		2497
		2498	sub cf::client::send_msg {
		2499	my ($self, $channel, $msg, $color, @extra) = @_;
		2500
		2501	$msg = $self->pl->expand_cfpod ($msg);
		2502
		2503	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2504
		2505	if (ref $channel) {
		2506	# send meta info to client, if not yet sent
		2507	unless (exists $self->{channel}{$channel->{id}}) {
		2508	$self->{channel}{$channel->{id}} = $channel;
		2509	$self->ext_msg (channel_info => $channel);
		2510	}
		2511
		2512	$channel = $channel->{id};
		2513	}
		2514
		2515	return unless @extra || length $msg;
		2516
		2517	if ($self->can_msg) {
		2518	# default colour, mask it out
		2519	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2520	if $color & cf::NDI_DEF;
		2521
		2522	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2523	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2524	} else {
		2525	if ($color >= 0) {
		2526	# replace some tags by gcfclient-compatible ones
		2527	for ($msg) {
		2528	1 while
		2529	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2530	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2531	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2532	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2533	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2534	}
		2535
		2536	$color &= cf::NDI_COLOR_MASK;
		2537
		2538	utf8::encode $msg;
		2539
		2540	if (0 && $msg =~ /\[/) {
		2541	# COMMAND/INFO
		2542	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2543	} else {
		2544	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2545	$self->send_packet ("drawinfo $color $msg")
		2546	}
		2547	}
		2548	}
		2549	}
		2550
		2551	=item $client->ext_msg ($type, @msg)
		2552
		2553	Sends an ext event to the client.
		2554
		2555	=cut
		2556
		2557	sub cf::client::ext_msg($$@) {
		2558	my ($self, $type, @msg) = @_;
		2559
		2560	my $extcmd = $self->extcmd;
		2561
		2562	if ($extcmd == 2) {
		2563	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2564	} elsif ($extcmd == 1) { # TODO: remove
		2565	push @msg, msgtype => "event_$type";
		2566	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2567	}
		2568	}
1945		2569
1946	=item $success = $client->query ($flags, "text", \&cb)	2570	=item $success = $client->query ($flags, "text", \&cb)
1947		2571
1948	Queues a query to the client, calling the given callback with	2572	Queues a query to the client, calling the given callback with
1949	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2573	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1950	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2574	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1951		2575
1952	Queries can fail, so check the return code. Or don't, as queries will become	2576	Queries can fail, so check the return code. Or don't, as queries will
1953	reliable at some point in the future.	2577	become reliable at some point in the future.
1954		2578
1955	=cut	2579	=cut
1956		2580
1957	sub cf::client::query {	2581	sub cf::client::query {
1958	my ($self, $flags, $text, $cb) = @_;	2582	my ($self, $flags, $text, $cb) = @_;
…		…
1966	utf8::encode $text;	2590	utf8::encode $text;
1967	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2591	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1968		2592
1969	$self->send_packet ($self->{query_queue}[0][0])	2593	$self->send_packet ($self->{query_queue}[0][0])
1970	if @{ $self->{query_queue} } == 1;	2594	if @{ $self->{query_queue} } == 1;
		2595
		2596	1
1971	}	2597	}
1972		2598
1973	cf::client->attach (	2599	cf::client->attach (
		2600	on_connect => sub {
		2601	my ($ns) = @_;
		2602
		2603	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2604	},
1974	on_reply => sub {	2605	on_reply => sub {
1975	my ($ns, $msg) = @_;	2606	my ($ns, $msg) = @_;
1976		2607
1977	# this weird shuffling is so that direct followup queries	2608	# this weird shuffling is so that direct followup queries
1978	# get handled first	2609	# get handled first
1979	my $queue = delete $ns->{query_queue}	2610	my $queue = delete $ns->{query_queue}
1980	or return; # be conservative, not sure how that can happen, but we saw a crash here	2611	or return; # be conservative, not sure how that can happen, but we saw a crash here
1981		2612
1982	(shift @$queue)->[1]->($msg);	2613	(shift @$queue)->[1]->($msg);
		2614	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1983		2615
1984	push @{ $ns->{query_queue} }, @$queue;	2616	push @{ $ns->{query_queue} }, @$queue;
1985		2617
1986	if (@{ $ns->{query_queue} } == @$queue) {	2618	if (@{ $ns->{query_queue} } == @$queue) {
1987	if (@$queue) {	2619	if (@$queue) {
…		…
1989	} else {	2621	} else {
1990	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2622	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1991	}	2623	}
1992	}	2624	}
1993	},	2625	},
		2626	on_exticmd => sub {
		2627	my ($ns, $buf) = @_;
		2628
		2629	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2630
		2631	if (ref $msg) {
		2632	my ($type, $reply, @payload) =
		2633	"ARRAY" eq ref $msg
		2634	? @$msg
		2635	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2636
		2637	if (my $cb = $EXTICMD{$type}) {
		2638	my @reply = $cb->($ns, @payload);
		2639
		2640	$ns->ext_reply ($reply, @reply)
		2641	if $reply;
		2642	}
		2643	} else {
		2644	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2645	}
		2646
		2647	cf::override;
		2648	},
1994	);	2649	);
1995		2650
1996	=item $client->async (\&cb)	2651	=item $client->async (\&cb)
1997		2652
1998	Create a new coroutine, running the specified callback. The coroutine will	2653	Create a new coroutine, running the specified callback. The coroutine will
…		…
2039	our $safe = new Safe "safe";	2694	our $safe = new Safe "safe";
2040	our $safe_hole = new Safe::Hole;	2695	our $safe_hole = new Safe::Hole;
2041		2696
2042	$SIG{FPE} = 'IGNORE';	2697	$SIG{FPE} = 'IGNORE';
2043		2698
2044	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2699	$safe->permit_only (Opcode::opset qw(
		2700	:base_core :base_mem :base_orig :base_math
		2701	grepstart grepwhile mapstart mapwhile
		2702	sort time
		2703	));
2045		2704
2046	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
2047		2706
2048	=pod	2707	=pod
2049		2708
2050	The following fucntions and emthods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2051		2710
2052	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove name archname title slaying race
		2714
2053	cf::object::player player	2715	cf::object::player
2054	cf::player peaceful	2716	player
2055	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2056		2723
2057	=cut	2724	=cut
2058		2725
2059	for (	2726	for (
2060	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove inv name archname title slaying race)],
2061	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2062	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2063	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2064	) {	2732	) {
2065	no strict 'refs';	2733	no strict 'refs';
…		…
2136	=back	2804	=back
2137		2805
2138	=cut	2806	=cut
2139		2807
2140	#############################################################################	2808	#############################################################################
		2809	# the server's init and main functions
2141		2810
2142	=head2 EXTENSION DATABASE SUPPORT	2811	sub load_facedata($) {
		2812	my ($path) = @_;
2143		2813
2144	Crossfire maintains a very simple database for extension use. It can	2814	warn "loading facedata from $path\n";
2145	currently store anything that can be serialised using Storable, which
2146	excludes objects.
2147		2815
2148	The parameter C<$family> should best start with the name of the extension	2816	my $facedata;
2149	using it, it should be unique.	2817	0 < aio_load $path, $facedata
		2818	or die "$path: $!";
2150		2819
2151	=over 4	2820	$facedata = Coro::Storable::thaw $facedata;
2152		2821
2153	=item $hashref = cf::db_get $family	2822	$facedata->{version} == 2
		2823	or cf::cleanup "$path: version mismatch, cannot proceed.";
2154		2824
2155	Return a hashref for use by the extension C<$family>, which can be
2156	modified. After modifications, you have to call C<cf::db_dirty> or
2157	C<cf::db_sync>.
2158
2159	=item $value = cf::db_get $family => $key
2160
2161	Returns a single value from the database
2162
2163	=item cf::db_put $family => $hashref
2164
2165	Stores the given family hashref into the database. Updates are delayed, if
2166	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2167
2168	=item cf::db_put $family => $key => $value
2169
2170	Stores the given C<$value> in the family hash. Updates are delayed, if you
2171	want the data to be synced to disk immediately, use C<cf::db_sync>.
2172
2173	=item cf::db_dirty
2174
2175	Marks the database as dirty, to be updated at a later time.
2176
2177	=item cf::db_sync
2178
2179	Immediately write the database to disk I<if it is dirty>.
2180
2181	=cut
2182
2183	our $DB;
2184
2185	{
2186	my $path = cf::localdir . "/database.pst";
2187
2188	sub db_load() {
2189	$DB = stat $path ? Storable::retrieve $path : { };
2190	}	2825	{
		2826	my $faces = $facedata->{faceinfo};
2191		2827
2192	my $pid;	2828	while (my ($face, $info) = each %$faces) {
		2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
		2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2193		2834
2194	sub db_save() {	2835	cf::cede_to_tick;
2195	waitpid $pid, 0 if $pid;
2196	if (0 == ($pid = fork)) {
2197	$DB->{_meta}{version} = 1;
2198	Storable::nstore $DB, "$path~";
2199	rename "$path~", $path;
2200	cf::_exit 0 if defined $pid;
2201	}
2202	}
2203
2204	my $dirty;
2205
2206	sub db_sync() {
2207	db_save if $dirty;
2208	undef $dirty;
2209	}
2210
2211	my $idle = Event->idle (
2212	reentrant => 0,
2213	min => 10,
2214	max => 20,
2215	repeat => 0,
2216	data => WF_AUTOCANCEL,
2217	cb => \&db_sync,
2218	);
2219
2220	sub db_dirty() {
2221	$dirty = 1;
2222	$idle->start;
2223	}
2224
2225	sub db_get($;$) {
2226	@_ >= 2
2227	? $DB->{$_[0]}{$_[1]}
2228	: ($DB->{$_[0]} ||= { })
2229	}
2230
2231	sub db_put($$;$) {
2232	if (@_ >= 3) {
2233	$DB->{$_[0]}{$_[1]} = $_[2];
2234	} else {
2235	$DB->{$_[0]} = $_[1];
2236	}
2237	db_dirty;
2238	}
2239
2240	cf::global->attach (
2241	prio => 10000,
2242	on_cleanup => sub {
2243	db_sync;
2244	},	2836	}
2245	);
2246	}
2247		2837
2248	#############################################################################	2838	while (my ($face, $info) = each %$faces) {
2249	# the server's main()	2839	next unless $info->{smooth};
		2840	my $idx = cf::face::find $face
		2841	or next;
		2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
		2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2845	} else {
		2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2847	}
		2848
		2849	cf::cede_to_tick;
		2850	}
		2851	}
		2852
		2853	{
		2854	my $anims = $facedata->{animinfo};
		2855
		2856	while (my ($anim, $info) = each %$anims) {
		2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2858	cf::cede_to_tick;
		2859	}
		2860
		2861	cf::anim::invalidate_all; # d'oh
		2862	}
		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	my $soundconf = delete $res->{"res/sound.conf"};
		2871
		2872	while (my ($name, $info) = each %$res) {
		2873	my $meta = $enc->encode ({
		2874	name => $name,
		2875	%{ $info->{meta} || {} },
		2876	});
		2877
		2878	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2879
		2880	if ($info->{type} & 1) {
		2881	# prepend meta info
		2882
		2883	my $data = pack "(w/a*)*", $meta, $info->{data};
		2884	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2885
		2886	cf::face::set_data $idx, 0, $data, $chk;
		2887	} else {
		2888	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2889	}
		2890
		2891	cf::face::set_type $idx, $info->{type};
		2892
		2893	cf::cede_to_tick;
		2894	}
		2895
		2896	if ($soundconf) {
		2897	$soundconf = $enc->decode (delete $soundconf->{data});
		2898
		2899	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2900	my $sound = $soundconf->{compat}[$_]
		2901	or next;
		2902
		2903	my $face = cf::face::find "sound/$sound->[1]";
		2904	cf::sound::set $sound->[0] => $face;
		2905	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2906	}
		2907
		2908	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2909	my $face = cf::face::find "sound/$v";
		2910	cf::sound::set $k => $face;
		2911	}
		2912	}
		2913	}
		2914
		2915	1
		2916	}
		2917
		2918	register_exticmd fx_want => sub {
		2919	my ($ns, $want) = @_;
		2920
		2921	while (my ($k, $v) = each %$want) {
		2922	$ns->fx_want ($k, $v);
		2923	}
		2924	};
		2925
		2926	sub reload_regions {
		2927	load_resource_file "$MAPDIR/regions"
		2928	or die "unable to load regions file\n";
		2929
		2930	for (cf::region::list) {
		2931	$_->{match} = qr/$_->{match}/
		2932	if exists $_->{match};
		2933	}
		2934	}
		2935
		2936	sub reload_facedata {
		2937	load_facedata "$DATADIR/facedata"
		2938	or die "unable to load facedata\n";
		2939	}
		2940
		2941	sub reload_archetypes {
		2942	load_resource_file "$DATADIR/archetypes"
		2943	or die "unable to load archetypes\n";
		2944	#d# NEED to laod twice to resolve forward references
		2945	# this really needs to be done in an extra post-pass
		2946	# (which needs to be synchronous, so solve it differently)
		2947	load_resource_file "$DATADIR/archetypes"
		2948	or die "unable to load archetypes\n";
		2949	}
		2950
		2951	sub reload_treasures {
		2952	load_resource_file "$DATADIR/treasures"
		2953	or die "unable to load treasurelists\n";
		2954	}
		2955
		2956	sub reload_resources {
		2957	warn "reloading resource files...\n";
		2958
		2959	reload_regions;
		2960	reload_facedata;
		2961	#reload_archetypes;#d#
		2962	reload_archetypes;
		2963	reload_treasures;
		2964
		2965	warn "finished reloading resource files\n";
		2966	}
		2967
		2968	sub init {
		2969	reload_resources;
		2970	}
2250		2971
2251	sub cfg_load {	2972	sub cfg_load {
2252	open my $fh, "<:utf8", cf::confdir . "/config"	2973	open my $fh, "<:utf8", "$CONFDIR/config"
2253	or return;	2974	or return;
2254		2975
2255	local $/;	2976	local $/;
2256	*CFG = YAML::Syck::Load <$fh>;	2977	*CFG = YAML::Syck::Load <$fh>;
2257		2978
…		…
2277	Event::one_event;	2998	Event::one_event;
2278	})->prio (Coro::PRIO_MAX);	2999	})->prio (Coro::PRIO_MAX);
2279	};	3000	};
2280		3001
2281	cfg_load;	3002	cfg_load;
2282	db_load;	3003	db_init;
2283	load_extensions;	3004	load_extensions;
2284		3005
2285	$TICK_WATCHER->start;	3006	$TICK_WATCHER->start;
2286	Event::loop;	3007	Event::loop;
2287	}	3008	}
…		…
2294	for my $signal (qw(INT HUP TERM)) {	3015	for my $signal (qw(INT HUP TERM)) {
2295	Event->signal (	3016	Event->signal (
2296	reentrant => 0,	3017	reentrant => 0,
2297	data => WF_AUTOCANCEL,	3018	data => WF_AUTOCANCEL,
2298	signal => $signal,	3019	signal => $signal,
		3020	prio => 0,
2299	cb => sub {	3021	cb => sub {
2300	cf::cleanup "SIG$signal";	3022	cf::cleanup "SIG$signal";
2301	},	3023	},
2302	);	3024	);
2303	}	3025	}
		3026	}
		3027
		3028	sub write_runtime {
		3029	my $runtime = "$LOCALDIR/runtime";
		3030
		3031	# first touch the runtime file to show we are still running:
		3032	# the fsync below can take a very very long time.
		3033
		3034	IO::AIO::aio_utime $runtime, undef, undef;
		3035
		3036	my $guard = cf::lock_acquire "write_runtime";
		3037
		3038	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3039	or return;
		3040
		3041	my $value = $cf::RUNTIME + 90 + 10;
		3042	# 10 is the runtime save interval, for a monotonic clock
		3043	# 60 allows for the watchdog to kill the server.
		3044
		3045	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3046	and return;
		3047
		3048	# always fsync - this file is important
		3049	aio_fsync $fh
		3050	and return;
		3051
		3052	# touch it again to show we are up-to-date
		3053	aio_utime $fh, undef, undef;
		3054
		3055	close $fh
		3056	or return;
		3057
		3058	aio_rename "$runtime~", $runtime
		3059	and return;
		3060
		3061	warn "runtime file written.\n";
		3062
		3063	1
2304	}	3064	}
2305		3065
2306	sub emergency_save() {	3066	sub emergency_save() {
2307	my $freeze_guard = cf::freeze_mainloop;	3067	my $freeze_guard = cf::freeze_mainloop;
2308		3068
…		…
2325	my $map = $cf::MAP{$path} or next;	3085	my $map = $cf::MAP{$path} or next;
2326	$map->valid or next;	3086	$map->valid or next;
2327	$map->save;	3087	$map->save;
2328	}	3088	}
2329	warn "end emergency map save\n";	3089	warn "end emergency map save\n";
		3090
		3091	warn "begin emergency database checkpoint\n";
		3092	BDB::db_env_txn_checkpoint $DB_ENV;
		3093	warn "end emergency database checkpoint\n";
2330	};	3094	};
2331		3095
2332	warn "leave emergency perl save\n";	3096	warn "leave emergency perl save\n";
2333	}	3097	}
2334		3098
		3099	sub post_cleanup {
		3100	my ($make_core) = @_;
		3101
		3102	warn Carp::longmess "post_cleanup backtrace"
		3103	if $make_core;
		3104	}
		3105
2335	sub reload() {	3106	sub do_reload_perl() {
2336	# can/must only be called in main	3107	# can/must only be called in main
2337	if ($Coro::current != $Coro::main) {	3108	if ($Coro::current != $Coro::main) {
2338	warn "can only reload from main coroutine";	3109	warn "can only reload from main coroutine";
2339	return;	3110	return;
2340	}	3111	}
2341		3112
2342	warn "reloading...";	3113	warn "reloading...";
2343		3114
2344	warn "cancelling server ticker";	3115	warn "entering sync_job";
2345	$TICK_WATCHER->cancel;
2346		3116
		3117	cf::sync_job {
		3118	cf::write_runtime; # external watchdog should not bark
2347	cf::emergency_save;	3119	cf::emergency_save;
		3120	cf::write_runtime; # external watchdog should not bark
2348		3121
2349	eval {	3122	warn "syncing database to disk";
		3123	BDB::db_env_txn_checkpoint $DB_ENV;
		3124
2350	# if anything goes wrong in here, we should simply crash as we already saved	3125	# if anything goes wrong in here, we should simply crash as we already saved
2351
2352	warn "syncing database to disk";
2353	cf::db_sync;
2354		3126
2355	warn "cancelling all WF_AUTOCANCEL watchers";	3127	warn "cancelling all WF_AUTOCANCEL watchers";
2356	for (Event::all_watchers) {	3128	for (Event::all_watchers) {
2357	$_->cancel if $_->data & WF_AUTOCANCEL;	3129	$_->cancel if $_->data & WF_AUTOCANCEL;
2358	}	3130	}
2359		3131
2360	warn "flushing outstanding aio requests";	3132	warn "flushing outstanding aio requests";
2361	for (;;) {	3133	for (;;) {
		3134	BDB::flush;
2362	IO::AIO::flush;	3135	IO::AIO::flush;
2363	Coro::cede;	3136	Coro::cede;
2364	last unless IO::AIO::nreqs;	3137	last unless IO::AIO::nreqs || BDB::nreqs;
2365	warn "iterate...";	3138	warn "iterate...";
2366	}	3139	}
		3140
		3141	++$RELOAD;
2367		3142
2368	warn "cancelling all extension coros";	3143	warn "cancelling all extension coros";
2369	$_->cancel for values %EXT_CORO;	3144	$_->cancel for values %EXT_CORO;
2370	%EXT_CORO = ();	3145	%EXT_CORO = ();
2371		3146
2372	warn "removing commands";	3147	warn "removing commands";
2373	%COMMAND = ();	3148	%COMMAND = ();
2374		3149
2375	warn "removing ext commands";	3150	warn "removing ext/exti commands";
2376	%EXTCMD = ();	3151	%EXTCMD = ();
		3152	%EXTICMD = ();
2377		3153
2378	warn "unloading/nuking all extensions";	3154	warn "unloading/nuking all extensions";
2379	for my $pkg (@EXTS) {	3155	for my $pkg (@EXTS) {
2380	warn "... unloading $pkg";	3156	warn "... unloading $pkg";
2381		3157
…		…
2411	Symbol::delete_package "safe::$_"	3187	Symbol::delete_package "safe::$_"
2412	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3188	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2413		3189
2414	warn "unloading cf.pm \"a bit\"";	3190	warn "unloading cf.pm \"a bit\"";
2415	delete $INC{"cf.pm"};	3191	delete $INC{"cf.pm"};
		3192	delete $INC{"cf/pod.pm"};
2416		3193
2417	# don't, removes xs symbols, too,	3194	# don't, removes xs symbols, too,
2418	# and global variables created in xs	3195	# and global variables created in xs
2419	#Symbol::delete_package __PACKAGE__;	3196	#Symbol::delete_package __PACKAGE__;
2420		3197
…		…
2424	require cf;	3201	require cf;
2425	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3202	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2426		3203
2427	warn "loading config and database again";	3204	warn "loading config and database again";
2428	cf::cfg_load;	3205	cf::cfg_load;
2429	cf::db_load;
2430		3206
2431	warn "loading extensions";	3207	warn "loading extensions";
2432	cf::load_extensions;	3208	cf::load_extensions;
2433		3209
2434	warn "reattaching attachments to objects/players";	3210	warn "reattaching attachments to objects/players";
2435	_global_reattach;	3211	_global_reattach; # objects, sockets
2436	warn "reattaching attachments to maps";	3212	warn "reattaching attachments to maps";
2437	reattach $_ for values %MAP;	3213	reattach $_ for values %MAP;
		3214	warn "reattaching attachments to players";
		3215	reattach $_ for values %PLAYER;
2438		3216
2439	warn "restarting server ticker";	3217	warn "leaving sync_job";
2440		3218
2441	$TICK_WATCHER->start;	3219	1
2442	};	3220	} or do {
2443
2444	if ($@) {
2445	warn $@;	3221	warn $@;
2446	warn "error while reloading, exiting.";	3222	warn "error while reloading, exiting.";
2447	exit 1;	3223	exit 1;
2448	}	3224	};
2449		3225
2450	warn "reloaded";	3226	warn "reloaded";
2451	};	3227	};
2452		3228
2453	our $RELOAD_WATCHER; # used only during reload	3229	our $RELOAD_WATCHER; # used only during reload
2454		3230
		3231	sub reload_perl() {
		3232	# doing reload synchronously and two reloads happen back-to-back,
		3233	# coro crashes during coro_state_free->destroy here.
		3234
		3235	$RELOAD_WATCHER ||= Event->timer (
		3236	reentrant => 0,
		3237	after => 0,
		3238	data => WF_AUTOCANCEL,
		3239	cb => sub {
		3240	do_reload_perl;
		3241	undef $RELOAD_WATCHER;
		3242	},
		3243	);
		3244	}
		3245
2455	register_command "reload" => sub {	3246	register_command "reload" => sub {
2456	my ($who, $arg) = @_;	3247	my ($who, $arg) = @_;
2457		3248
2458	if ($who->flag (FLAG_WIZ)) {	3249	if ($who->flag (FLAG_WIZ)) {
2459	$who->message ("reloading server.");	3250	$who->message ("reloading server.");
2460		3251	async { reload_perl };
2461	# doing reload synchronously and two reloads happen back-to-back,
2462	# coro crashes during coro_state_free->destroy here.
2463
2464	$RELOAD_WATCHER ||= Event->timer (
2465	reentrant => 0,
2466	after => 0,
2467	data => WF_AUTOCANCEL,
2468	cb => sub {
2469	reload;
2470	undef $RELOAD_WATCHER;
2471	},
2472	);
2473	}	3252	}
2474	};	3253	};
2475		3254
2476	unshift @INC, $LIBDIR;	3255	unshift @INC, $LIBDIR;
2477		3256
2478	my $bug_warning = 0;	3257	my $bug_warning = 0;
2479		3258
		3259	our @WAIT_FOR_TICK;
		3260	our @WAIT_FOR_TICK_BEGIN;
		3261
		3262	sub wait_for_tick {
		3263	return unless $TICK_WATCHER->is_active;
		3264	return if $Coro::current == $Coro::main;
		3265
		3266	my $signal = new Coro::Signal;
		3267	push @WAIT_FOR_TICK, $signal;
		3268	$signal->wait;
		3269	}
		3270
		3271	sub wait_for_tick_begin {
		3272	return unless $TICK_WATCHER->is_active;
		3273	return if $Coro::current == $Coro::main;
		3274
		3275	my $signal = new Coro::Signal;
		3276	push @WAIT_FOR_TICK_BEGIN, $signal;
		3277	$signal->wait;
		3278	}
		3279
		3280	my $min = 1e6;#d#
		3281	my $avg = 10;
2480	$TICK_WATCHER = Event->timer (	3282	$TICK_WATCHER = Event->timer (
2481	reentrant => 0,	3283	reentrant => 0,
2482	parked => 1,	3284	parked => 1,
2483	prio => -1,	3285	prio => 0,
2484	at => $NEXT_TICK || $TICK,	3286	at => $NEXT_TICK || $TICK,
2485	data => WF_AUTOCANCEL,	3287	data => WF_AUTOCANCEL,
2486	cb => sub {	3288	cb => sub {
2487	if ($Coro::current != $Coro::main) {	3289	if ($Coro::current != $Coro::main) {
2488	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3290	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2489	unless ++$bug_warning > 10;	3291	unless ++$bug_warning > 10;
2490	return;	3292	return;
2491	}	3293	}
2492		3294
2493	$NOW = Event::time;	3295	$NOW = $tick_start = Event::time;
2494		3296
2495	cf::server_tick; # one server iteration	3297	cf::server_tick; # one server iteration
		3298
		3299	0 && sync_job {#d#
		3300	for(1..10) {
		3301	my $t = Event::time;
		3302	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3303	or die;
		3304
		3305	$map->width (50);
		3306	$map->height (50);
		3307	$map->alloc;
		3308	$map->_load_objects ("/tmp/x.map", 1);
		3309	my $t = Event::time - $t;
		3310
		3311	#next unless $t < 0.0013;#d#
		3312	if ($t < $min) {
		3313	$min = $t;
		3314	}
		3315	$avg = $avg * 0.99 + $t * 0.01;
		3316	}
		3317	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3318	exit 0;
		3319	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3320	};
		3321
2496	$RUNTIME += $TICK;	3322	$RUNTIME += $TICK;
2497	$NEXT_TICK += $TICK;	3323	$NEXT_TICK += $TICK;
2498		3324
2499	$WAIT_FOR_TICK->broadcast;	3325	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2500	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3326	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3327	Coro::async_pool {
		3328	write_runtime
		3329	or warn "ERROR: unable to write runtime file: $!";
		3330	};
		3331	}
2501		3332
2502	my $AFTER = Event::time;	3333	# my $AFTER = Event::time;
2503	warn $AFTER - $NOW;#d#	3334	# warn $AFTER - $NOW;#d#
		3335
		3336	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3337	$sig->send;
		3338	}
		3339	while (my $sig = shift @WAIT_FOR_TICK) {
		3340	$sig->send;
		3341	}
		3342
		3343	$NOW = Event::time;
2504		3344
2505	# if we are delayed by four ticks or more, skip them all	3345	# if we are delayed by four ticks or more, skip them all
2506	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3346	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2507		3347
2508	$TICK_WATCHER->at ($NEXT_TICK);	3348	$TICK_WATCHER->at ($NEXT_TICK);
2509	$TICK_WATCHER->start;	3349	$TICK_WATCHER->start;
		3350
		3351	$LOAD = ($NOW - $tick_start) / $TICK;
		3352	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3353
		3354	_post_tick;
		3355
		3356
2510	},	3357	},
2511	);	3358	);
2512		3359
		3360	{
2513	IO::AIO::max_poll_time $TICK * 0.2;	3361	BDB::max_poll_time $TICK * 0.1;
		3362	$BDB_POLL_WATCHER = Event->io (
		3363	reentrant => 0,
		3364	fd => BDB::poll_fileno,
		3365	poll => 'r',
		3366	prio => 0,
		3367	data => WF_AUTOCANCEL,
		3368	cb => \&BDB::poll_cb,
		3369	);
		3370	BDB::min_parallel 8;
2514		3371
		3372	BDB::set_sync_prepare {
		3373	my $status;
		3374	my $current = $Coro::current;
		3375	(
		3376	sub {
		3377	$status = $!;
		3378	$current->ready; undef $current;
		3379	},
		3380	sub {
		3381	Coro::schedule while defined $current;
		3382	$! = $status;
		3383	},
		3384	)
		3385	};
		3386
		3387	unless ($DB_ENV) {
		3388	$DB_ENV = BDB::db_env_create;
		3389
		3390	cf::sync_job {
		3391	eval {
		3392	BDB::db_env_open
		3393	$DB_ENV,
		3394	$BDBDIR,
		3395	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3396	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3397	0666;
		3398
		3399	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3400
		3401	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3402	$DB_ENV->set_lk_detect;
		3403	};
		3404
		3405	cf::cleanup "db_env_open(db): $@" if $@;
		3406	};
		3407	}
		3408	}
		3409
		3410	{
		3411	IO::AIO::min_parallel 8;
		3412
2515	undef $Coro::AIO::WATCHER;	3413	undef $Coro::AIO::WATCHER;
		3414	IO::AIO::max_poll_time $TICK * 0.1;
2516	$AIO_POLL_WATCHER = Event->io (	3415	$AIO_POLL_WATCHER = Event->io (
2517	reentrant => 0,	3416	reentrant => 0,
		3417	data => WF_AUTOCANCEL,
2518	fd => IO::AIO::poll_fileno,	3418	fd => IO::AIO::poll_fileno,
2519	poll => 'r',	3419	poll => 'r',
2520	prio => 6,	3420	prio => 6,
2521	data => WF_AUTOCANCEL,
2522	cb => \&IO::AIO::poll_cb,	3421	cb => \&IO::AIO::poll_cb,
2523	);	3422	);
		3423	}
2524		3424
2525	$WRITE_RUNTIME_WATCHER = Event->timer (	3425	my $_log_backtrace;
2526	reentrant => 0,	3426
2527	data => WF_AUTOCANCEL,	3427	sub _log_backtrace {
2528	after => 1,	3428	my ($msg, @addr) = @_;
2529	interval => 10,	3429
2530	prio => 6, # keep it lowest so it acts like a watchdog	3430	$msg =~ s/\n//;
2531	cb => Coro::unblock_sub {	3431
2532	write_runtime	3432	# limit the # of concurrent backtraces
2533	or warn "ERROR: unable to write runtime file: $!";	3433	if ($_log_backtrace < 2) {
		3434	++$_log_backtrace;
		3435	async {
		3436	my @bt = fork_call {
		3437	@addr = map { sprintf "%x", $_ } @addr;
		3438	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3439	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3440	or die "addr2line: $!";
		3441
		3442	my @funcs;
		3443	my @res = <$fh>;
		3444	chomp for @res;
		3445	while (@res) {
		3446	my ($func, $line) = splice @res, 0, 2, ();
		3447	push @funcs, "[$func] $line";
		3448	}
		3449
		3450	@funcs
		3451	};
		3452
		3453	LOG llevInfo, "[ABT] $msg\n";
		3454	LOG llevInfo, "[ABT] $_\n" for @bt;
		3455	--$_log_backtrace;
		3456	};
		3457	} else {
		3458	LOG llevInfo, "[ABT] $msg\n";
		3459	LOG llevInfo, "[ABT] [suppressed]\n";
2534	},	3460	}
2535	);	3461	}
		3462
		3463	# load additional modules
		3464	use cf::pod;
2536		3465
2537	END { cf::emergency_save }	3466	END { cf::emergency_save }
2538		3467
2539	1	3468	1
2540		3469

Diff Legend

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