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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.336 by root, Tue Aug 21 00:31:18 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.64 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
		24	use Coro::Util ();
19		25
		26	use JSON::XS 1.4 ();
		27	use BDB ();
20	use Data::Dumper;	28	use Data::Dumper;
21	use Digest::MD5;	29	use Digest::MD5;
22	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
23	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
26		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		44
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
33		47
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
36	our %COMMAND = ();	52	our %COMMAND = ();
37	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
38		54
39	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
43		60
		61	our $RELOAD; # number of reloads so far
44	our @EVENT;	62	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		63
47	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	77	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	80	our $NEXT_TICK;
52	our $NOW;	81	our $NOW;
53	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
54		83
		84	our $BDB_POLL_WATCHER;
		85	our $DB_ENV;
		86
55	our %CFG;	87	our %CFG;
56		88
57	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
58	our $RUNTIME;	90	our $RUNTIME;
59		91
60	our %PLAYER; # all users	92	our %PLAYER; # all users
61	our %MAP; # all maps	93	our %MAP; # all maps
62	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
63	our $RANDOM_MAPS = cf::localdir . "/random";
64
65	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
66	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
67		95
68	# 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 ∕
69	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
70		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
71	binmode STDOUT;	103	binmode STDOUT;
72	binmode STDERR;	104	binmode STDERR;
73		105
74	# read virtual server time, if available	106	# read virtual server time, if available
75	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
76	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
77	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
78	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
79	}	111	}
80		112
81	mkdir cf::localdir;	113	mkdir $_
82	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
83	mkdir cf::localdir . "/" . cf::tmpdir;
84	mkdir cf::localdir . "/" . cf::uniquedir;
85	mkdir $RANDOM_MAPS;
86		115
87	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
88		117
89	sub cf::map::normalise;	118	sub cf::map::normalise;
90		119
…		…
101	=item $cf::RUNTIME	130	=item $cf::RUNTIME
102		131
103	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
104	every server tick.	133	every server tick.
105		134
106	=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
107		138
108	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
109	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.
110		143
111	=item $cf::NOW	144	=item $cf::NOW
112		145
113	The time of the last (current) server tick.	146	The time of the last (current) server tick.
114		147
115	=item $cf::TICK	148	=item $cf::TICK
116		149
117	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.
118		161
119	=item %cf::CFG	162	=item %cf::CFG
120		163
121	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
122	from wherever your confdir points to.	165	from wherever your confdir points to.
123		166
124	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
125		168
126	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
127	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
128	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.
129	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.
130		178
131	=back	179	=back
132		180
133	=cut	181	=cut
134		182
135	BEGIN {	183	BEGIN {
136	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
137	my $msg = join "", @_;	185	my $msg = join "", @_;
138	utf8::encode $msg;
139		186
140	$msg .= "\n"	187	$msg .= "\n"
141	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
142		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
143	LOG llevError, $msg;	193	LOG llevError, $msg;
144	};	194	};
145	}	195	}
146		196
147	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
148	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
149	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
150	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
151	@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';
152	@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)
153		204
154	# 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
155	# within the Safe compartment.	206	# within the Safe compartment.
156	for my $pkg (qw(	207	for my $pkg (qw(
157	cf::global cf::attachable	208	cf::global cf::attachable
…		…
165	}	216	}
166		217
167	$Event::DIED = sub {	218	$Event::DIED = sub {
168	warn "error in event callback: @_";	219	warn "error in event callback: @_";
169	};	220	};
		221
		222	#############################################################################
170		223
171	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
172		225
173	=over 4	226	=over 4
174		227
…		…
193	$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;
194	$d	247	$d
195	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
196	}	249	}
197		250
198	use JSON::Syck (); # TODO# replace by JSON::PC once working
199
200	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
201		252
202	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
203		254
204	=cut
205
206	sub from_json($) {
207	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
208	JSON::Syck::Load $_[0]
209	}
210
211	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
212		256
213	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
214		258
215	=cut	259	=cut
216		260
217	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
218	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
219	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
220	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
221		265
222	=item cf::lock_wait $string	266	=item cf::lock_wait $string
223		267
224	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
225		269
…		…
231	returned.	275	returned.
232		276
233	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
234	uses map_find and cf::map::load uses map_load).	278	uses map_find and cf::map::load uses map_load).
235		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
236	=cut	284	=cut
237		285
238	our %LOCK;	286	our %LOCK;
239		287
240	sub lock_wait($) {	288	sub lock_wait($) {
…		…
259	# wake up all waiters, to be on the safe side	307	# wake up all waiters, to be on the safe side
260	$_->ready for @{ delete $LOCK{$key} };	308	$_->ready for @{ delete $LOCK{$key} };
261	}	309	}
262	}	310	}
263		311
		312	sub lock_active($) {
		313	my ($key) = @_;
		314
		315	! ! $LOCK{$key}
		316	}
		317
264	sub freeze_mainloop {	318	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;	319	return unless $TICK_WATCHER->is_active;
266		320
267	my $guard = Coro::guard {	321	my $guard = Coro::guard {
268	$TICK_WATCHER->start;	322	$TICK_WATCHER->start;
269	$WRITE_RUNTIME_WATCHER->start;
270	};	323	};
271	$WRITE_RUNTIME_WATCHER->stop;
272	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
273	$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;
274	}	382	}
275		383
276	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
277		385
278	Currently the same as Coro::async_pool, meaning you cannot use	386	Currently the same as Coro::async_pool, meaning you cannot use
…		…
283		391
284	BEGIN { *async = \&Coro::async_pool }	392	BEGIN { *async = \&Coro::async_pool }
285		393
286	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
287		395
288	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)
289	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
290	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.
291		400
292	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
293	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
294	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
295	fast or be very important.	404	fast or be very important.
…		…
298		407
299	sub sync_job(&) {	408	sub sync_job(&) {
300	my ($job) = @_;	409	my ($job) = @_;
301		410
302	if ($Coro::current == $Coro::main) {	411	if ($Coro::current == $Coro::main) {
		412	my $time = Event::time;
		413
303	# this is the main coro, too bad, we have to block	414	# this is the main coro, too bad, we have to block
304	# till the operation succeeds, freezing the server :/	415	# till the operation succeeds, freezing the server :/
305		416
306	# TODO: use suspend/resume instead	417	# TODO: use suspend/resume instead
307	# (but this is cancel-safe)	418	# (but this is cancel-safe)
…		…
318		429
319	while ($busy) {	430	while ($busy) {
320	Coro::cede or Event::one_event;	431	Coro::cede or Event::one_event;
321	}	432	}
322		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
323	wantarray ? @res : $res[0]	441	wantarray ? @res : $res[0]
324	} else {	442	} else {
325	# we are in another coroutine, how wonderful, everything just works	443	# we are in another coroutine, how wonderful, everything just works
326		444
327	$job->()	445	$job->()
…		…
346	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
347		465
348	$coro	466	$coro
349	}	467	}
350		468
351	sub write_runtime {	469	=item fork_call { }, $args
352	my $runtime = cf::localdir . "/runtime";
353		470
354	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	471	Executes the given code block with the given arguments in a seperate
355	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.
356		475
357	my $value = $cf::RUNTIME + 90 + 10;	476	=cut
358	# 10 is the runtime save interval, for a monotonic clock
359	# 60 allows for the watchdog to kill the server.
360		477
361	(aio_write $fh, 0, (length $value), $value, 0) <= 0	478	sub fork_call(&@) {
362	and return;	479	my ($cb, @args) = @_;
363		480
364	# always fsync - this file is important	481	# we seemingly have to make a local copy of the whole thing,
365	aio_fsync $fh	482	# otherwise perl prematurely frees the stuff :/
366	and return;	483	# TODO: investigate and fix (liekly this will be rather laborious)
367		484
368	close $fh	485	my @res = Coro::Util::fork_eval {
369	or return;	486	reset_signals;
		487	&$cb
		488	}, @args;
370		489
371	aio_rename "$runtime~", $runtime	490	wantarray ? @res : $res[-1]
372	and return;	491	}
373		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	};
374	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 });
375	}	618	}
376		619
377	=back	620	=back
378		621
379	=cut	622	=cut
…		…
386	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")
387	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
388		631
389	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>
390	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
391	crossfire+).	634	Crossfire TRT).
392		635
393	=over 4	636	=over 4
394		637
395	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
396		639
…		…
559	$registry = $CB_TYPE[$object_type] ||= [];	802	$registry = $CB_TYPE[$object_type] ||= [];
560		803
561	} elsif ($type eq "subtype") {	804	} elsif ($type eq "subtype") {
562	defined $object_type or Carp::croak "subtype specified without type";	805	defined $object_type or Carp::croak "subtype specified without type";
563	my $object_subtype = shift @arg;	806	my $object_subtype = shift @arg;
564	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	807	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
565		808
566	} elsif ($type eq "package") {	809	} elsif ($type eq "package") {
567	my $pkg = shift @arg;	810	my $pkg = shift @arg;
568		811
569	while (my ($name, $id) = each %cb_id) {	812	while (my ($name, $id) = each %cb_id) {
…		…
598	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
599	}	842	}
600		843
601	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
602	} else {	845	} else {
603	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
604	}	847	}
605		848
606	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
607	}	850	}
608		851
…		…
610	if (ref $_[0]) {	853	if (ref $_[0]) {
611	_object_attach @_;	854	_object_attach @_;
612	} else {	855	} else {
613	_attach shift->_attach_registry, @_;	856	_attach shift->_attach_registry, @_;
614	}	857	}
		858	_recalc_want;
615	};	859	};
616		860
617	# all those should be optimised	861	# all those should be optimised
618	sub cf::attachable::detach {	862	sub cf::attachable::detach {
619	my ($obj, $name) = @_;	863	my ($obj, $name) = @_;
…		…
622	delete $obj->{_attachment}{$name};	866	delete $obj->{_attachment}{$name};
623	reattach ($obj);	867	reattach ($obj);
624	} else {	868	} else {
625	Carp::croak "cannot, currently, detach class attachments";	869	Carp::croak "cannot, currently, detach class attachments";
626	}	870	}
		871	_recalc_want;
627	};	872	};
628		873
629	sub cf::attachable::attached {	874	sub cf::attachable::attached {
630	my ($obj, $name) = @_;	875	my ($obj, $name) = @_;
631		876
…		…
646	";	891	";
647	die if $@;	892	die if $@;
648	}	893	}
649		894
650	our $override;	895	our $override;
651	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?
652		897
653	sub override {	898	sub override {
654	$override = 1;	899	$override = 1;
655	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
656	}	901	}
657		902
658	sub do_invoke {	903	sub do_invoke {
659	my $event = shift;	904	my $event = shift;
660	my $callbacks = shift;	905	my $callbacks = shift;
661		906
662	@invoke_results = ();	907	@INVOKE_RESULTS = ();
663		908
664	local $override;	909	local $override;
665		910
666	for (@$callbacks) {	911	for (@$callbacks) {
667	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
684		929
685	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
686		931
687	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
688	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
689	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
690		935
691	=back	936	=back
692		937
693	=cut	938	=cut
694		939
695	#############################################################################	940	#############################################################################
696	# 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	}
697		953
698	sub reattach {	954	sub reattach {
699	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
700	my ($obj) = @_;	956	my ($obj) = @_;
701		957
…		…
778	}	1034	}
779	} else {	1035	} else {
780	aio_unlink $filename;	1036	aio_unlink $filename;
781	aio_unlink "$filename.pst";	1037	aio_unlink "$filename.pst";
782	}	1038	}
783
784	#d##TODO# nuke non .map-files if exist
785	if ($filename =~ s/\.map$//) {
786	aio_unlink $filename;
787	aio_unlink "$filename.pst";
788	}
789	}	1039	}
790	}	1040	}
791		1041
792	sub object_freezer_as_string {	1042	sub object_freezer_as_string {
793	my ($rdata, $objs) = @_;	1043	my ($rdata, $objs) = @_;
…		…
799		1049
800	sub object_thawer_load {	1050	sub object_thawer_load {
801	my ($filename) = @_;	1051	my ($filename) = @_;
802		1052
803	my ($data, $av);	1053	my ($data, $av);
804
805	#d#TODO remove .map if file does not exist
806	aio_stat $filename and $filename =~ s/\.map$//;
807		1054
808	(aio_load $filename, $data) >= 0	1055	(aio_load $filename, $data) >= 0
809	or return;	1056	or return;
810		1057
811	unless (aio_stat "$filename.pst") {	1058	unless (aio_stat "$filename.pst") {
…		…
813	or return;	1060	or return;
814	$av = eval { (Storable::thaw $av)->{objs} };	1061	$av = eval { (Storable::thaw $av)->{objs} };
815	}	1062	}
816		1063
817	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
818	$filename, length $data, scalar @{$av || []};#d#	1065	$filename, length $data, scalar @{$av || []};
819	return ($data, $av);	1066	return ($data, $av);
820	}	1067	}
		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
821		1074
822	#############################################################################	1075	#############################################################################
823	# command handling &c	1076	# command handling &c
824		1077
825	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
…		…
838	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
839	}	1092	}
840		1093
841	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
842		1095
843	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.
844		1101
845	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
846	called.	1103	called.
847		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
848	=cut	1116	=cut
849		1117
850	sub register_extcmd {	1118	sub register_extcmd {
851	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
852		1120
853	$EXTCMD{$name} = $cb;	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
854	}	1128	}
855		1129
856	cf::player->attach (	1130	cf::player->attach (
857	on_command => sub {	1131	on_command => sub {
858	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
867	cf::override;	1141	cf::override;
868	},	1142	},
869	on_extcmd => sub {	1143	on_extcmd => sub {
870	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
871		1145
872	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873		1147
874	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
875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1154	if (my $cb = $EXTCMD{$type}) {
876	if (my %reply = $cb->($pl, $msg)) {	1155	my @reply = $cb->($pl, @payload);
		1156
877	$pl->ext_reply ($msg->{msgid}, %reply);	1157	$pl->ext_reply ($reply, @reply)
878	}	1158	if $reply;
879	}	1159	}
880	} else {	1160	} else {
881	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1161	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882	}	1162	}
883		1163
884	cf::override;	1164	cf::override;
885	},	1165	},
886	);	1166	);
887		1167
888	sub load_extension {
889	my ($path) = @_;
890
891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
892	my $base = $1;
893	my $pkg = $1;
894	$pkg =~ s/[^[:word:]]/_/g;
895	$pkg = "ext::$pkg";
896
897	warn "... loading '$path' into '$pkg'\n";
898
899	open my $fh, "<:utf8", $path
900	or die "$path: $!";
901
902	my $source =
903	"package $pkg; use strict; use utf8;\n"
904	. "#line 1 \"$path\"\n{\n"
905	. (do { local $/; <$fh> })
906	. "\n};\n1";
907
908	unless (eval $source) {
909	my $msg = $@ ? "$path: $@\n"
910	: "extension disabled.\n";
911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912	warn $@;
913	warn "mandatory extension failed to load, exiting.\n";
914	exit 1;
915	}
916	die $@;
917	}
918
919	push @EXTS, $pkg;
920	}
921
922	sub load_extensions {	1168	sub load_extensions {
		1169	cf::sync_job {
		1170	my %todo;
		1171
923	for my $ext (<$LIBDIR/*.ext>) {	1172	for my $path (<$LIBDIR/*.ext>) {
924	next unless -r $ext;	1173	next unless -r $path;
925	eval {	1174
926	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;
927	1	1232	}
928	} or warn "$ext not loaded: $@";	1233
		1234	skip:
		1235	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1236	unless $progress;
		1237	}
929	}	1238	};
930	}	1239	}
931		1240
932	#############################################################################	1241	#############################################################################
933		1242
		1243	=back
		1244
934	=head2 CORE EXTENSIONS	1245	=head2 CORE EXTENSIONS
935		1246
936	Functions and methods that extend core crossfire objects.	1247	Functions and methods that extend core crossfire objects.
937		1248
938	=cut	1249	=cut
…		…
950	Returns the given player object, loading it if necessary (might block).	1261	Returns the given player object, loading it if necessary (might block).
951		1262
952	=cut	1263	=cut
953		1264
954	sub playerdir($) {	1265	sub playerdir($) {
955	cf::localdir	1266	"$PLAYERDIR/"
956	. "/"
957	. cf::playerdir
958	. "/"
959	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1267	. (ref $_[0] ? $_[0]->ob->name : $_[0])
960	}	1268	}
961		1269
962	sub path($) {	1270	sub path($) {
963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1271	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964		1272
965	(playerdir $login) . "/$login.pl"	1273	(playerdir $login) . "/playerdata"
966	}	1274	}
967		1275
968	sub find_active($) {	1276	sub find_active($) {
969	$cf::PLAYER{$_[0]}	1277	$cf::PLAYER{$_[0]}
970	and $cf::PLAYER{$_[0]}->active	1278	and $cf::PLAYER{$_[0]}->active
…		…
983	my $login = $_[0];	1291	my $login = $_[0];
984		1292
985	my $guard = cf::lock_acquire "user_find:$login";	1293	my $guard = cf::lock_acquire "user_find:$login";
986		1294
987	$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
988	my $pl = load_pl path $login	1303	my $pl = load_pl path $login
989	or return;	1304	or return;
990	$cf::PLAYER{$login} = $pl	1305	$cf::PLAYER{$login} = $pl
991	}	1306	}
992	}	1307	}
…		…
1020	$cf::PLAYER{$login} = $self;	1335	$cf::PLAYER{$login} = $self;
1021		1336
1022	$self	1337	$self
1023	}	1338	}
1024		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
1025	=item $pl->quit_character	1350	=item $pl->quit_character
1026		1351
1027	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
1028	be destroyed. May block for a long time.	1353	be destroyed. May block for a long time.
1029		1354
1030	=cut	1355	=cut
1031		1356
1032	sub quit_character {	1357	sub quit_character {
1033	my ($pl) = @_;	1358	my ($pl) = @_;
		1359
		1360	my $name = $pl->ob->name;
1034		1361
1035	$pl->{deny_save} = 1;	1362	$pl->{deny_save} = 1;
1036	$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
1037		1364
1038	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1365	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1043	my $path = playerdir $pl;	1370	my $path = playerdir $pl;
1044	my $temp = "$path~$cf::RUNTIME~deleting~";	1371	my $temp = "$path~$cf::RUNTIME~deleting~";
1045	aio_rename $path, $temp;	1372	aio_rename $path, $temp;
1046	delete $cf::PLAYER{$pl->ob->name};	1373	delete $cf::PLAYER{$pl->ob->name};
1047	$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
1048	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;
1049	}	1396	}
1050		1397
1051	=item cf::player::list_logins	1398	=item cf::player::list_logins
1052		1399
1053	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
1054	while and may block, so not sync_job-capable, ever.	1401	while and may block, so not sync_job-capable, ever.
1055		1402
1056	=cut	1403	=cut
1057		1404
1058	sub list_logins {	1405	sub list_logins {
1059	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1406	my $dirs = aio_readdir $PLAYERDIR
1060	or return [];	1407	or return [];
1061		1408
1062	my @logins;	1409	my @logins;
1063		1410
1064	for my $login (@$dirs) {	1411	for my $login (@$dirs) {
…		…
1099	}	1446	}
1100		1447
1101	\@paths	1448	\@paths
1102	}	1449	}
1103		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
1104	=item $player->ext_reply ($msgid, $msgtype, %msg)	1501	=item $player->ext_reply ($msgid, @msg)
1105		1502
1106	Sends an ext reply to the player.	1503	Sends an ext reply to the player.
1107		1504
1108	=cut	1505	=cut
1109		1506
1110	sub ext_reply($$$%) {	1507	sub ext_reply($$@) {
1111	my ($self, $id, %msg) = @_;	1508	my ($self, $id, @msg) = @_;
1112		1509
1113	$msg{msgid} = $id;	1510	$self->ns->ext_reply ($id, @msg)
1114
1115	$self->send ("ext " . cf::to_json \%msg);
1116	}	1511	}
1117		1512
1118	package cf;	1513	=item $player->ext_msg ($type, @msg)
		1514
		1515	Sends an ext event to the client.
		1516
		1517	=cut
		1518
		1519	sub ext_msg($$@) {
		1520	my ($self, $type, @msg) = @_;
		1521
		1522	$self->ns->ext_msg ($type, @msg);
		1523	}
		1524
		1525	=head3 cf::region
		1526
		1527	=over 4
		1528
		1529	=cut
		1530
		1531	package cf::region;
		1532
		1533	=item cf::region::find_by_path $path
		1534
		1535	Tries to decuce the likely region for a map knowing only its path.
		1536
		1537	=cut
		1538
		1539	sub find_by_path($) {
		1540	my ($path) = @_;
		1541
		1542	my ($match, $specificity);
		1543
		1544	for my $region (list) {
		1545	if ($region->{match} && $path =~ $region->{match}) {
		1546	($match, $specificity) = ($region, $region->specificity)
		1547	if $region->specificity > $specificity;
		1548	}
		1549	}
		1550
		1551	$match
		1552	}
1119		1553
1120	=back	1554	=back
1121
1122		1555
1123	=head3 cf::map	1556	=head3 cf::map
1124		1557
1125	=over 4	1558	=over 4
1126		1559
…		…
1181	my ($self, $merge) = @_;	1614	my ($self, $merge) = @_;
1182		1615
1183	# we have to keep some variables in memory intact	1616	# we have to keep some variables in memory intact
1184	local $self->{path};	1617	local $self->{path};
1185	local $self->{load_path};	1618	local $self->{load_path};
1186	local $self->{deny_save};
1187	local $self->{deny_reset};
1188		1619
1189	$self->SUPER::thawer_merge ($merge);	1620	$self->SUPER::thawer_merge ($merge);
1190	}	1621	}
1191		1622
1192	sub normalise {	1623	sub normalise {
…		…
1239	$self->init; # pass $1 etc.	1670	$self->init; # pass $1 etc.
1240	return $self;	1671	return $self;
1241	}	1672	}
1242	}	1673	}
1243		1674
1244	Carp::carp "unable to resolve path '$path' (base '$base').";	1675	Carp::cluck "unable to resolve path '$path' (base '$base').";
1245	()	1676	()
1246	}	1677	}
1247		1678
1248	sub init {	1679	sub init {
1249	my ($self) = @_;	1680	my ($self) = @_;
…		…
1264		1695
1265	# the original (read-only) location	1696	# the original (read-only) location
1266	sub load_path {	1697	sub load_path {
1267	my ($self) = @_;	1698	my ($self) = @_;
1268		1699
1269	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1700	"$MAPDIR/$self->{path}.map"
1270	}	1701	}
1271		1702
1272	# the temporary/swap location	1703	# the temporary/swap location
1273	sub save_path {	1704	sub save_path {
1274	my ($self) = @_;	1705	my ($self) = @_;
1275		1706
1276	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1707	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1708	"$TMPDIR/$path.map"
1278	}	1709	}
1279		1710
1280	# the unique path, undef == no special unique path	1711	# the unique path, undef == no special unique path
1281	sub uniq_path {	1712	sub uniq_path {
1282	my ($self) = @_;	1713	my ($self) = @_;
1283		1714
1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1715	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1716	"$UNIQUEDIR/$path"
1286	}	1717	}
1287		1718
1288	# and all this just because we cannot iterate over	1719	# and all this just because we cannot iterate over
1289	# all maps in C++...	1720	# all maps in C++...
1290	sub change_all_map_light {	1721	sub change_all_map_light {
…		…
1292		1723
1293	$_->change_map_light ($change)	1724	$_->change_map_light ($change)
1294	for grep $_->outdoor, values %cf::MAP;	1725	for grep $_->outdoor, values %cf::MAP;
1295	}	1726	}
1296		1727
		1728	sub decay_objects {
		1729	my ($self) = @_;
		1730
		1731	return if $self->{deny_reset};
		1732
		1733	$self->do_decay_objects;
		1734	}
		1735
1297	sub unlink_save {	1736	sub unlink_save {
1298	my ($self) = @_;	1737	my ($self) = @_;
1299		1738
1300	utf8::encode (my $save = $self->save_path);	1739	utf8::encode (my $save = $self->save_path);
1301	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1740	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1302	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1741	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1303
1304	#d#TODO remove .map and also nuke
1305	$save =~ s/\.map// or return;#d#
1306	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1307	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1308	}	1742	}
1309		1743
1310	sub load_header_from($) {	1744	sub load_header_from($) {
1311	my ($self, $path) = @_;	1745	my ($self, $path) = @_;
1312		1746
…		…
1362	$self->load_header_orig	1796	$self->load_header_orig
1363	or return;	1797	or return;
1364	$self->prepare_orig;	1798	$self->prepare_orig;
1365	}	1799	}
1366		1800
		1801	$self->{deny_reset} = 1
		1802	if $self->no_reset;
		1803
		1804	$self->default_region (cf::region::find_by_path $self->{path})
		1805	unless $self->default_region;
		1806
1367	1	1807	1
1368	}	1808	}
1369		1809
1370	sub find;	1810	sub find;
1371	sub find {	1811	sub find {
…		…
1383	$map->{last_save} = $cf::RUNTIME;	1823	$map->{last_save} = $cf::RUNTIME;
1384		1824
1385	$map->load_header	1825	$map->load_header
1386	or return;	1826	or return;
1387		1827
1388	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1828	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1389	# doing this can freeze the server in a sync job, obviously	1829	# doing this can freeze the server in a sync job, obviously
1390	#$cf::WAIT_FOR_TICK->wait;	1830	#$cf::WAIT_FOR_TICK->wait;
1391	$map->reset;	1831	$map->reset;
1392	undef $guard;	1832	undef $guard;
1393	return find $path;	1833	return find $path;
…		…
1404	my ($self) = @_;	1844	my ($self) = @_;
1405		1845
1406	local $self->{deny_reset} = 1; # loading can take a long time	1846	local $self->{deny_reset} = 1; # loading can take a long time
1407		1847
1408	my $path = $self->{path};	1848	my $path = $self->{path};
		1849
		1850	{
1409	my $guard = cf::lock_acquire "map_load:$path";	1851	my $guard = cf::lock_acquire "map_load:$path";
1410		1852
1411	return if $self->in_memory != cf::MAP_SWAPPED;	1853	return if $self->in_memory != cf::MAP_SWAPPED;
1412		1854
1413	$self->in_memory (cf::MAP_LOADING);	1855	$self->in_memory (cf::MAP_LOADING);
1414		1856
1415	$self->alloc;	1857	$self->alloc;
1416		1858
1417	$self->pre_load;	1859	$self->pre_load;
1418
1419	$self->_load_objects ($self->{load_path}, 1)
1420	or return;
1421
1422	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423	if delete $self->{load_original};
1424
1425	if (my $uniq = $self->uniq_path) {
1426	utf8::encode $uniq;
1427	if (aio_open $uniq, O_RDONLY, 0) {
1428	$self->clear_unique_items;
1429	$self->_load_objects ($uniq, 0);
1430	}
1431	}
1432
1433	Coro::cede;
1434
1435	# now do the right thing for maps
1436	$self->link_multipart_objects;
1437
1438	unless ($self->{deny_activate}) {
1439	$self->decay_objects;
1440	$self->fix_auto_apply;
1441	$self->update_buttons;
1442	Coro::cede;	1860	Coro::cede;
1443	$self->set_darkness_map;	1861
		1862	$self->_load_objects ($self->{load_path}, 1)
		1863	or return;
		1864
		1865	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1866	if delete $self->{load_original};
		1867
		1868	if (my $uniq = $self->uniq_path) {
		1869	utf8::encode $uniq;
		1870	if (aio_open $uniq, O_RDONLY, 0) {
		1871	$self->clear_unique_items;
		1872	$self->_load_objects ($uniq, 0);
		1873	}
		1874	}
		1875
		1876	Coro::cede;
		1877	# now do the right thing for maps
		1878	$self->link_multipart_objects;
1444	$self->difficulty ($self->estimate_difficulty)	1879	$self->difficulty ($self->estimate_difficulty)
1445	unless $self->difficulty;	1880	unless $self->difficulty;
1446	Coro::cede;	1881	Coro::cede;
		1882
		1883	unless ($self->{deny_activate}) {
		1884	$self->decay_objects;
		1885	$self->fix_auto_apply;
		1886	$self->update_buttons;
		1887	Coro::cede;
		1888	$self->set_darkness_map;
		1889	Coro::cede;
1447	$self->activate;	1890	$self->activate;
		1891	}
		1892
		1893	$self->{last_save} = $cf::RUNTIME;
		1894	$self->last_access ($cf::RUNTIME);
		1895
		1896	$self->in_memory (cf::MAP_IN_MEMORY);
1448	}	1897	}
1449		1898
1450	$self->post_load;	1899	$self->post_load;
1451
1452	$self->in_memory (cf::MAP_IN_MEMORY);
1453	}	1900	}
1454		1901
1455	sub customise_for {	1902	sub customise_for {
1456	my ($self, $ob) = @_;	1903	my ($self, $ob) = @_;
1457		1904
1458	return find "~" . $ob->name . "/" . $self->{path}	1905	return find "~" . $ob->name . "/" . $self->{path}
1459	if $self->per_player;	1906	if $self->per_player;
1460		1907
		1908	# return find "?party/" . $ob->name . "/" . $self->{path}
		1909	# if $self->per_party;
		1910
1461	$self	1911	$self
1462	}	1912	}
1463		1913
1464	# find and load all maps in the 3x3 area around a map	1914	# find and load all maps in the 3x3 area around a map
1465	sub load_diag {	1915	sub load_neighbours {
1466	my ($map) = @_;	1916	my ($map) = @_;
1467		1917
1468	my @diag; # diagonal neighbours	1918	my @neigh; # diagonal neighbours
1469		1919
1470	for (0 .. 3) {	1920	for (0 .. 3) {
1471	my $neigh = $map->tile_path ($_)	1921	my $neigh = $map->tile_path ($_)
1472	or next;	1922	or next;
1473	$neigh = find $neigh, $map	1923	$neigh = find $neigh, $map
1474	or next;	1924	or next;
1475	$neigh->load;	1925	$neigh->load;
1476		1926
		1927	push @neigh,
1477	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1928	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1478	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1929	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1479	}	1930	}
1480		1931
1481	for (@diag) {	1932	for (grep defined $_->[0], @neigh) {
		1933	my ($path, $origin) = @$_;
1482	my $neigh = find @$_	1934	my $neigh = find $path, $origin
1483	or next;	1935	or next;
1484	$neigh->load;	1936	$neigh->load;
1485	}	1937	}
1486	}	1938	}
1487		1939
…		…
1511		1963
1512	undef $MAP_PREFETCH{$path};	1964	undef $MAP_PREFETCH{$path};
1513	$MAP_PREFETCHER ||= cf::async {	1965	$MAP_PREFETCHER ||= cf::async {
1514	while (%MAP_PREFETCH) {	1966	while (%MAP_PREFETCH) {
1515	for my $path (keys %MAP_PREFETCH) {	1967	for my $path (keys %MAP_PREFETCH) {
1516	my $map = find $path	1968	if (my $map = find $path) {
1517	or next;
1518	$map->load;	1969	$map->load;
		1970	}
1519		1971
1520	delete $MAP_PREFETCH{$path};	1972	delete $MAP_PREFETCH{$path};
1521	}	1973	}
1522	}	1974	}
1523	undef $MAP_PREFETCHER;	1975	undef $MAP_PREFETCHER;
…		…
1575		2027
1576	sub reset_at {	2028	sub reset_at {
1577	my ($self) = @_;	2029	my ($self) = @_;
1578		2030
1579	# TODO: safety, remove and allow resettable per-player maps	2031	# TODO: safety, remove and allow resettable per-player maps
1580	return 1e99 if $self->isa ("ext::map_per_player");#d#
1581	return 1e99 if $self->{deny_reset};	2032	return 1e99 if $self->{deny_reset};
1582		2033
1583	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2034	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1584	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2035	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1585		2036
…		…
1596	my ($self) = @_;	2047	my ($self) = @_;
1597		2048
1598	my $lock = cf::lock_acquire "map_data:$self->{path}";	2049	my $lock = cf::lock_acquire "map_data:$self->{path}";
1599		2050
1600	return if $self->players;	2051	return if $self->players;
1601	return if $self->isa ("ext::map_per_player");#d#
1602		2052
1603	warn "resetting map ", $self->path;#d#	2053	warn "resetting map ", $self->path;
		2054
		2055	$self->in_memory (cf::MAP_SWAPPED);
		2056
		2057	# need to save uniques path
		2058	unless ($self->{deny_save}) {
		2059	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2060
		2061	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2062	if $uniq;
		2063	}
1604		2064
1605	delete $cf::MAP{$self->path};	2065	delete $cf::MAP{$self->path};
1606		2066
1607	$self->in_memory (cf::MAP_SWAPPED);
1608	$self->clear;	2067	$self->clear;
1609		2068
1610	$_->clear_links_to ($self) for values %cf::MAP;	2069	$_->clear_links_to ($self) for values %cf::MAP;
1611		2070
1612	$self->unlink_save;	2071	$self->unlink_save;
…		…
1631	$cf::MAP{$self->path} = $self;	2090	$cf::MAP{$self->path} = $self;
1632		2091
1633	$self->reset; # polite request, might not happen	2092	$self->reset; # polite request, might not happen
1634	}	2093	}
1635		2094
		2095	=item $maps = cf::map::tmp_maps
		2096
		2097	Returns an arrayref with all map paths of currently instantiated and saved
		2098	maps. May block.
		2099
		2100	=cut
		2101
		2102	sub tmp_maps() {
		2103	[
		2104	map {
		2105	utf8::decode $_;
		2106	/\.map$/
		2107	? normalise $_
		2108	: ()
		2109	} @{ aio_readdir $TMPDIR or [] }
		2110	]
		2111	}
		2112
		2113	=item $maps = cf::map::random_maps
		2114
		2115	Returns an arrayref with all map paths of currently instantiated and saved
		2116	random maps. May block.
		2117
		2118	=cut
		2119
		2120	sub random_maps() {
		2121	[
		2122	map {
		2123	utf8::decode $_;
		2124	/\.map$/
		2125	? normalise "?random/$_"
		2126	: ()
		2127	} @{ aio_readdir $RANDOMDIR or [] }
		2128	]
		2129	}
		2130
1636	=item cf::map::unique_maps	2131	=item cf::map::unique_maps
1637		2132
1638	Returns an arrayref of paths of all shared maps that have	2133	Returns an arrayref of paths of all shared maps that have
1639	instantiated unique items. May block.	2134	instantiated unique items. May block.
1640		2135
1641	=cut	2136	=cut
1642		2137
1643	sub unique_maps() {	2138	sub unique_maps() {
1644	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2139	[
1645	or return;	2140	map {
1646
1647	my @paths;
1648
1649	for (@$files) {
1650	utf8::decode $_;	2141	utf8::decode $_;
1651	next if /\.pst$/;	2142	/\.map$/
1652	next unless /^$PATH_SEP/o;	2143	? normalise $_
1653		2144	: ()
1654	push @paths, cf::map::normalise $_;	2145	} @{ aio_readdir $UNIQUEDIR or [] }
1655	}	2146	]
1656
1657	\@paths
1658	}	2147	}
1659		2148
1660	package cf;	2149	package cf;
1661		2150
1662	=back	2151	=back
…		…
1708		2197
1709	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2198	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1710		2199
1711	if ($self->{record_replies}) {	2200	if ($self->{record_replies}) {
1712	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2201	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2202
1713	} else {	2203	} else {
		2204	my $pl = $self->contr;
		2205
		2206	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2207	my $dialog = $pl->{npc_dialog};
		2208	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2209
		2210	} else {
1714	$msg = $npc->name . " says: $msg" if $npc;	2211	$msg = $npc->name . " says: $msg" if $npc;
1715	$self->message ($msg, $flags);	2212	$self->message ($msg, $flags);
		2213	}
1716	}	2214	}
		2215	}
		2216
		2217	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2218
		2219	=cut
		2220
		2221	sub cf::object::send_msg {
		2222	my $pl = shift->contr
		2223	or return;
		2224	$pl->send_msg (@_);
1717	}	2225	}
1718		2226
1719	=item $player_object->may ("access")	2227	=item $player_object->may ("access")
1720		2228
1721	Returns wether the given player is authorized to access resource "access"	2229	Returns wether the given player is authorized to access resource "access"
…		…
1768	$self->deactivate_recursive;	2276	$self->deactivate_recursive;
1769		2277
1770	return if UNIVERSAL::isa $self->map, "ext::map_link";	2278	return if UNIVERSAL::isa $self->map, "ext::map_link";
1771		2279
1772	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2280	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1773	if $self->map;	2281	if $self->map && $self->map->{path} ne "{link}";
1774		2282
1775	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2283	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1776	}	2284	}
1777		2285
1778	sub cf::object::player::leave_link {	2286	sub cf::object::player::leave_link {
1779	my ($self, $map, $x, $y) = @_;	2287	my ($self, $map, $x, $y) = @_;
		2288
		2289	return unless $self->contr->active;
1780		2290
1781	my $link_pos = delete $self->{_link_pos};	2291	my $link_pos = delete $self->{_link_pos};
1782		2292
1783	unless ($map) {	2293	unless ($map) {
1784	# restore original map position	2294	# restore original map position
…		…
1798	# use -1 or undef as default coordinates, not 0, 0	2308	# use -1 or undef as default coordinates, not 0, 0
1799	($x, $y) = ($map->enter_x, $map->enter_y)	2309	($x, $y) = ($map->enter_x, $map->enter_y)
1800	if $x <=0 && $y <= 0;	2310	if $x <=0 && $y <= 0;
1801		2311
1802	$map->load;	2312	$map->load;
1803	$map->load_diag;	2313	$map->load_neighbours;
1804		2314
1805	return unless $self->contr->active;	2315	return unless $self->contr->active;
1806	$self->activate_recursive;	2316	$self->activate_recursive;
		2317
		2318	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1807	$self->enter_map ($map, $x, $y);	2319	$self->enter_map ($map, $x, $y);
1808	}	2320	}
1809		2321
1810	cf::player->attach (	2322	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1811	on_logout => sub {
1812	my ($pl) = @_;
1813		2323
1814	# abort map switching before logout	2324	Moves the player to the given map-path and coordinates by first freezing
1815	if ($pl->ob->{_link_pos}) {	2325	her, loading and preparing them map, calling the provided $check callback
1816	cf::sync_job {	2326	that has to return the map if sucecssful, and then unfreezes the player on
1817	$pl->ob->leave_link	2327	the new (success) or old (failed) map position. In either case, $done will
1818	};	2328	be called at the end of this process.
1819	}
1820	},
1821	on_login => sub {
1822	my ($pl) = @_;
1823		2329
1824	# try to abort aborted map switching on player login :)
1825	# should happen only on crashes
1826	if ($pl->ob->{_link_pos}) {
1827	$pl->ob->enter_link;
1828	(async {
1829	# we need this sleep as the login has a concurrent enter_exit running
1830	# and this sleep increases chances of the player not ending up in scorn
1831	$pl->ob->reply (undef,
1832	"There was an internal problem at your last logout, "
1833	. "the server will try to bring you to your intended destination in a second.",
1834	cf::NDI_RED);
1835	Coro::Timer::sleep 1;
1836	$pl->ob->leave_link;
1837	})->prio (2);
1838	}
1839	},
1840	);
1841
1842	=item $player_object->goto ($path, $x, $y)
1843
1844	=cut	2330	=cut
		2331
		2332	our $GOTOGEN;
1845		2333
1846	sub cf::object::player::goto {	2334	sub cf::object::player::goto {
1847	my ($self, $path, $x, $y) = @_;	2335	my ($self, $path, $x, $y, $check, $done) = @_;
		2336
		2337	# do generation counting so two concurrent goto's will be executed in-order
		2338	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1848		2339
1849	$self->enter_link;	2340	$self->enter_link;
1850		2341
1851	(async {	2342	(async {
1852	my $map = eval {	2343	my $map = eval {
1853	my $map = cf::map::find $path;	2344	my $map = cf::map::find $path;
		2345
		2346	if ($map) {
1854	$map = $map->customise_for ($self) if $map;	2347	$map = $map->customise_for ($self);
		2348	$map = $check->($map) if $check && $map;
		2349	} else {
		2350	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2351	}
		2352
1855	$map	2353	$map
		2354	};
		2355
		2356	if ($@) {
		2357	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2358	LOG llevError | logBacktrace, Carp::longmess $@;
1856	} or	2359	}
1857	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1858		2360
		2361	if ($gen == $self->{_goto_generation}) {
		2362	delete $self->{_goto_generation};
1859	$self->leave_link ($map, $x, $y);	2363	$self->leave_link ($map, $x, $y);
		2364	}
		2365
		2366	$done->() if $done;
1860	})->prio (1);	2367	})->prio (1);
1861	}	2368	}
1862		2369
1863	=item $player_object->enter_exit ($exit_object)	2370	=item $player_object->enter_exit ($exit_object)
1864		2371
…		…
1903		2410
1904	$rmp->{random_seed} ||= $exit->random_seed;	2411	$rmp->{random_seed} ||= $exit->random_seed;
1905		2412
1906	my $data = cf::to_json $rmp;	2413	my $data = cf::to_json $rmp;
1907	my $md5 = Digest::MD5::md5_hex $data;	2414	my $md5 = Digest::MD5::md5_hex $data;
1908	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2415	my $meta = "$RANDOMDIR/$md5.meta";
1909		2416
1910	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2417	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1911	aio_write $fh, 0, (length $data), $data, 0;	2418	aio_write $fh, 0, (length $data), $data, 0;
1912	undef $fh;	2419	undef $fh;
1913	aio_rename "$meta~", $meta;	2420	aio_rename "$meta~", $meta;
…		…
1922		2429
1923	return unless $self->type == cf::PLAYER;	2430	return unless $self->type == cf::PLAYER;
1924		2431
1925	if ($exit->slaying eq "/!") {	2432	if ($exit->slaying eq "/!") {
1926	#TODO: this should de-fi-ni-te-ly not be a sync-job	2433	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2434	# the problem is that $exit might not survive long enough
		2435	# so it needs to be done right now, right here
1927	cf::sync_job { prepare_random_map $exit };	2436	cf::sync_job { prepare_random_map $exit };
1928	}	2437	}
1929		2438
1930	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2439	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1931	my $hp = $exit->stats->hp;	2440	my $hp = $exit->stats->hp;
1932	my $sp = $exit->stats->sp;	2441	my $sp = $exit->stats->sp;
1933		2442
1934	$self->enter_link;	2443	$self->enter_link;
		2444
		2445	# if exit is damned, update players death & WoR home-position
		2446	$self->contr->savebed ($slaying, $hp, $sp)
		2447	if $exit->flag (FLAG_DAMNED);
1935		2448
1936	(async {	2449	(async {
1937	$self->deactivate_recursive; # just to be sure	2450	$self->deactivate_recursive; # just to be sure
1938	unless (eval {	2451	unless (eval {
1939	$self->goto ($slaying, $hp, $sp);	2452	$self->goto ($slaying, $hp, $sp);
1940		2453
1941	1;	2454	1;
1942	}) {	2455	}) {
1943	$self->message ("Something went wrong deep within the crossfire server. "	2456	$self->message ("Something went wrong deep within the crossfire server. "
1944	. "I'll try to bring you back to the map you were before. "	2457	. "I'll try to bring you back to the map you were before. "
1945	. "Please report this to the dungeon master!",	2458	. "Please report this to the dungeon master!",
1946	cf::NDI_UNIQUE | cf::NDI_RED);	2459	cf::NDI_UNIQUE | cf::NDI_RED);
1947		2460
1948	warn "ERROR in enter_exit: $@";	2461	warn "ERROR in enter_exit: $@";
1949	$self->leave_link;	2462	$self->leave_link;
1950	}	2463	}
1951	})->prio (1);	2464	})->prio (1);
…		…
1964		2477
1965	sub cf::client::send_drawinfo {	2478	sub cf::client::send_drawinfo {
1966	my ($self, $text, $flags) = @_;	2479	my ($self, $text, $flags) = @_;
1967		2480
1968	utf8::encode $text;	2481	utf8::encode $text;
1969	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2482	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1970	}	2483	}
1971		2484
		2485	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2486
		2487	Send a drawinfo or msg packet to the client, formatting the msg for the
		2488	client if neccessary. C<$type> should be a string identifying the type of
		2489	the message, with C<log> being the default. If C<$color> is negative, suppress
		2490	the message unless the client supports the msg packet.
		2491
		2492	=cut
		2493
		2494	sub cf::client::send_msg {
		2495	my ($self, $channel, $msg, $color, @extra) = @_;
		2496
		2497	$msg = $self->pl->expand_cfpod ($msg);
		2498
		2499	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2500
		2501	if (ref $channel) {
		2502	# send meta info to client, if not yet sent
		2503	unless (exists $self->{channel}{$channel->{id}}) {
		2504	$self->{channel}{$channel->{id}} = $channel;
		2505	$self->ext_msg (channel_info => $channel);
		2506	}
		2507
		2508	$channel = $channel->{id};
		2509	}
		2510
		2511	return unless @extra || length $msg;
		2512
		2513	if ($self->can_msg) {
		2514	# default colour, mask it out
		2515	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2516	if $color & cf::NDI_DEF;
		2517
		2518	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2519	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2520	} else {
		2521	if ($color >= 0) {
		2522	# replace some tags by gcfclient-compatible ones
		2523	for ($msg) {
		2524	1 while
		2525	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2526	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2527	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2528	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2529	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2530	}
		2531
		2532	$color &= cf::NDI_COLOR_MASK;
		2533
		2534	utf8::encode $msg;
		2535
		2536	if (0 && $msg =~ /\[/) {
		2537	# COMMAND/INFO
		2538	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2539	} else {
		2540	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2541	$self->send_packet ("drawinfo $color $msg")
		2542	}
		2543	}
		2544	}
		2545	}
		2546
		2547	=item $client->ext_msg ($type, @msg)
		2548
		2549	Sends an ext event to the client.
		2550
		2551	=cut
		2552
		2553	sub cf::client::ext_msg($$@) {
		2554	my ($self, $type, @msg) = @_;
		2555
		2556	my $extcmd = $self->extcmd;
		2557
		2558	if ($extcmd == 2) {
		2559	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2560	} elsif ($extcmd == 1) { # TODO: remove
		2561	push @msg, msgtype => "event_$type";
		2562	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2563	}
		2564	}
		2565
		2566	=item $client->ext_reply ($msgid, @msg)
		2567
		2568	Sends an ext reply to the client.
		2569
		2570	=cut
		2571
		2572	sub cf::client::ext_reply($$@) {
		2573	my ($self, $id, @msg) = @_;
		2574
		2575	if ($self->extcmd == 2) {
		2576	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2577	} elsif ($self->ns->extcmd == 1) {
		2578	#TODO: version 1, remove
		2579	unshift @msg, msgtype => "reply", msgid => $id;
		2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
		2582	}
1972		2583
1973	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
1974		2585
1975	Queues a query to the client, calling the given callback with	2586	Queues a query to the client, calling the given callback with
1976	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2587	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1977	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1978		2589
1979	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
1980	reliable at some point in the future.	2591	become reliable at some point in the future.
1981		2592
1982	=cut	2593	=cut
1983		2594
1984	sub cf::client::query {	2595	sub cf::client::query {
1985	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
1993	utf8::encode $text;	2604	utf8::encode $text;
1994	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1995		2606
1996	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
1997	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
1998	}	2611	}
1999		2612
2000	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
2001	on_reply => sub {	2619	on_reply => sub {
2002	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
2003		2621
2004	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
2005	# get handled first	2623	# get handled first
…		…
2017	} else {	2635	} else {
2018	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2019	}	2637	}
2020	}	2638	}
2021	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
2022	);	2663	);
2023		2664
2024	=item $client->async (\&cb)	2665	=item $client->async (\&cb)
2025		2666
2026	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
…		…
2067	our $safe = new Safe "safe";	2708	our $safe = new Safe "safe";
2068	our $safe_hole = new Safe::Hole;	2709	our $safe_hole = new Safe::Hole;
2069		2710
2070	$SIG{FPE} = 'IGNORE';	2711	$SIG{FPE} = 'IGNORE';
2071		2712
2072	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2713	$safe->permit_only (Opcode::opset qw(
		2714	:base_core :base_mem :base_orig :base_math
		2715	grepstart grepwhile mapstart mapwhile
		2716	sort time
		2717	));
2073		2718
2074	# here we export the classes and methods available to script code	2719	# here we export the classes and methods available to script code
2075		2720
2076	=pod	2721	=pod
2077		2722
2078	The following fucntions and emthods are available within a safe environment:	2723	The following functions and methods are available within a safe environment:
2079		2724
2080	cf::object contr pay_amount pay_player map	2725	cf::object
		2726	contr pay_amount pay_player map x y force_find force_add
		2727	insert remove name archname title slaying race
		2728
2081	cf::object::player player	2729	cf::object::player
2082	cf::player peaceful	2730	player
2083	cf::map trigger	2731
		2732	cf::player
		2733	peaceful
		2734
		2735	cf::map
		2736	trigger
2084		2737
2085	=cut	2738	=cut
2086		2739
2087	for (	2740	for (
2088	["cf::object" => qw(contr pay_amount pay_player map)],	2741	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2742	insert remove inv name archname title slaying race)],
2089	["cf::object::player" => qw(player)],	2743	["cf::object::player" => qw(player)],
2090	["cf::player" => qw(peaceful)],	2744	["cf::player" => qw(peaceful)],
2091	["cf::map" => qw(trigger)],	2745	["cf::map" => qw(trigger)],
2092	) {	2746	) {
2093	no strict 'refs';	2747	no strict 'refs';
…		…
2164	=back	2818	=back
2165		2819
2166	=cut	2820	=cut
2167		2821
2168	#############################################################################	2822	#############################################################################
2169
2170	=head2 EXTENSION DATABASE SUPPORT
2171
2172	Crossfire maintains a very simple database for extension use. It can
2173	currently store anything that can be serialised using Storable, which
2174	excludes objects.
2175
2176	The parameter C<$family> should best start with the name of the extension
2177	using it, it should be unique.
2178
2179	=over 4
2180
2181	=item $hashref = cf::db_get $family
2182
2183	Return a hashref for use by the extension C<$family>, which can be
2184	modified. After modifications, you have to call C<cf::db_dirty> or
2185	C<cf::db_sync>.
2186
2187	=item $value = cf::db_get $family => $key
2188
2189	Returns a single value from the database
2190
2191	=item cf::db_put $family => $hashref
2192
2193	Stores the given family hashref into the database. Updates are delayed, if
2194	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196	=item cf::db_put $family => $key => $value
2197
2198	Stores the given C<$value> in the family hash. Updates are delayed, if you
2199	want the data to be synced to disk immediately, use C<cf::db_sync>.
2200
2201	=item cf::db_dirty
2202
2203	Marks the database as dirty, to be updated at a later time.
2204
2205	=item cf::db_sync
2206
2207	Immediately write the database to disk I<if it is dirty>.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	{
2214	my $path = cf::localdir . "/database.pst";
2215
2216	sub db_load() {
2217	$DB = stat $path ? Storable::retrieve $path : { };
2218	}
2219
2220	my $pid;
2221
2222	sub db_save() {
2223	waitpid $pid, 0 if $pid;
2224	if (0 == ($pid = fork)) {
2225	$DB->{_meta}{version} = 1;
2226	Storable::nstore $DB, "$path~";
2227	rename "$path~", $path;
2228	cf::_exit 0 if defined $pid;
2229	}
2230	}
2231
2232	my $dirty;
2233
2234	sub db_sync() {
2235	db_save if $dirty;
2236	undef $dirty;
2237	}
2238
2239	my $idle = Event->idle (
2240	reentrant => 0,
2241	min => 10,
2242	max => 20,
2243	repeat => 0,
2244	data => WF_AUTOCANCEL,
2245	cb => \&db_sync,
2246	);
2247
2248	sub db_dirty() {
2249	$dirty = 1;
2250	$idle->start;
2251	}
2252
2253	sub db_get($;$) {
2254	@_ >= 2
2255	? $DB->{$_[0]}{$_[1]}
2256	: ($DB->{$_[0]} ||= { })
2257	}
2258
2259	sub db_put($$;$) {
2260	if (@_ >= 3) {
2261	$DB->{$_[0]}{$_[1]} = $_[2];
2262	} else {
2263	$DB->{$_[0]} = $_[1];
2264	}
2265	db_dirty;
2266	}
2267
2268	cf::global->attach (
2269	prio => 10000,
2270	on_cleanup => sub {
2271	db_sync;
2272	},
2273	);
2274	}
2275
2276	#############################################################################
2277	# the server's init and main functions	2823	# the server's init and main functions
2278		2824
2279	sub load_resources {	2825	sub load_facedata($) {
2280	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2826	my ($path) = @_;
		2827
		2828	my $enc = JSON::XS->new->utf8->canonical;
		2829
		2830	warn "loading facedata from $path\n";
		2831
		2832	my $facedata;
		2833	0 < aio_load $path, $facedata
		2834	or die "$path: $!";
		2835
		2836	$facedata = Coro::Storable::thaw $facedata;
		2837
		2838	$facedata->{version} == 2
		2839	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2840
		2841	# patch in the exptable
		2842	$facedata->{resource}{"res/exp_table"} = {
		2843	type => FT_RSRC,
		2844	data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
		2845	};
		2846	cf::cede_to_tick;
		2847
		2848	{
		2849	my $faces = $facedata->{faceinfo};
		2850
		2851	while (my ($face, $info) = each %$faces) {
		2852	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2853	cf::face::set_visibility $idx, $info->{visibility};
		2854	cf::face::set_magicmap $idx, $info->{magicmap};
		2855	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2856	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2857
		2858	cf::cede_to_tick;
		2859	}
		2860
		2861	while (my ($face, $info) = each %$faces) {
		2862	next unless $info->{smooth};
		2863	my $idx = cf::face::find $face
		2864	or next;
		2865	if (my $smooth = cf::face::find $info->{smooth}) {
		2866	cf::face::set_smooth $idx, $smooth;
		2867	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2868	} else {
		2869	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2870	}
		2871
		2872	cf::cede_to_tick;
		2873	}
		2874	}
		2875
		2876	{
		2877	my $anims = $facedata->{animinfo};
		2878
		2879	while (my ($anim, $info) = each %$anims) {
		2880	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2881	cf::cede_to_tick;
		2882	}
		2883
		2884	cf::anim::invalidate_all; # d'oh
		2885	}
		2886
		2887	{
		2888	# TODO: for gcfclient pleasure, we should give resources
		2889	# that gcfclient doesn't grok a >10000 face index.
		2890	my $res = $facedata->{resource};
		2891
		2892	my $soundconf = delete $res->{"res/sound.conf"};
		2893
		2894	while (my ($name, $info) = each %$res) {
		2895	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2896	my $data;
		2897
		2898	if ($info->{type} & 1) {
		2899	# prepend meta info
		2900
		2901	my $meta = $enc->encode ({
		2902	name => $name,
		2903	%{ $info->{meta} || {} },
		2904	});
		2905
		2906	$data = pack "(w/a*)*", $meta, $info->{data};
		2907	}
		2908
		2909	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2910	cf::face::set_type $idx, $info->{type};
		2911
		2912	cf::cede_to_tick;
		2913	}
		2914
		2915	if ($soundconf) {
		2916	$soundconf = $enc->decode (delete $soundconf->{data});
		2917
		2918	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2919	my $sound = $soundconf->{compat}[$_]
		2920	or next;
		2921
		2922	my $face = cf::face::find "sound/$sound->[1]";
		2923	cf::sound::set $sound->[0] => $face;
		2924	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2925	}
		2926
		2927	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2928	my $face = cf::face::find "sound/$v";
		2929	cf::sound::set $k => $face;
		2930	}
		2931	}
		2932	}
		2933
		2934	1
		2935	}
		2936
		2937	register_exticmd fx_want => sub {
		2938	my ($ns, $want) = @_;
		2939
		2940	while (my ($k, $v) = each %$want) {
		2941	$ns->fx_want ($k, $v);
		2942	}
		2943	};
		2944
		2945	sub reload_regions {
		2946	load_resource_file "$MAPDIR/regions"
2281	or die "unable to load regions file\n";#d#	2947	or die "unable to load regions file\n";
		2948
		2949	for (cf::region::list) {
		2950	$_->{match} = qr/$_->{match}/
		2951	if exists $_->{match};
		2952	}
		2953	}
		2954
		2955	sub reload_facedata {
		2956	load_facedata "$DATADIR/facedata"
		2957	or die "unable to load facedata\n";
		2958	}
		2959
		2960	sub reload_archetypes {
		2961	load_resource_file "$DATADIR/archetypes"
		2962	or die "unable to load archetypes\n";
		2963	#d# NEED to laod twice to resolve forward references
		2964	# this really needs to be done in an extra post-pass
		2965	# (which needs to be synchronous, so solve it differently)
		2966	load_resource_file "$DATADIR/archetypes"
		2967	or die "unable to load archetypes\n";
		2968	}
		2969
		2970	sub reload_treasures {
		2971	load_resource_file "$DATADIR/treasures"
		2972	or die "unable to load treasurelists\n";
		2973	}
		2974
		2975	sub reload_resources {
		2976	warn "reloading resource files...\n";
		2977
		2978	reload_regions;
		2979	reload_facedata;
		2980	#reload_archetypes;#d#
		2981	reload_archetypes;
		2982	reload_treasures;
		2983
		2984	warn "finished reloading resource files\n";
		2985	}
		2986
		2987	sub init {
		2988	reload_resources;
2282	}	2989	}
2283		2990
2284	sub cfg_load {	2991	sub cfg_load {
2285	open my $fh, "<:utf8", cf::confdir . "/config"	2992	open my $fh, "<:utf8", "$CONFDIR/config"
2286	or return;	2993	or return;
2287		2994
2288	local $/;	2995	local $/;
2289	*CFG = YAML::Syck::Load <$fh>;	2996	*CFG = YAML::Syck::Load <$fh>;
2290		2997
…		…
2298	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3005	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2299	and die "WARNING: m(un)lockall failed: $!\n";	3006	and die "WARNING: m(un)lockall failed: $!\n";
2300	};	3007	};
2301	warn $@ if $@;	3008	warn $@ if $@;
2302	}	3009	}
2303	}
2304
2305	sub init {
2306	load_resources;
2307	}	3010	}
2308		3011
2309	sub main {	3012	sub main {
2310	# we must not ever block the main coroutine	3013	# we must not ever block the main coroutine
2311	local $Coro::idle = sub {	3014	local $Coro::idle = sub {
…		…
2314	Event::one_event;	3017	Event::one_event;
2315	})->prio (Coro::PRIO_MAX);	3018	})->prio (Coro::PRIO_MAX);
2316	};	3019	};
2317		3020
2318	cfg_load;	3021	cfg_load;
2319	db_load;	3022	db_init;
2320	load_extensions;	3023	load_extensions;
2321		3024
2322	$TICK_WATCHER->start;	3025	$TICK_WATCHER->start;
2323	Event::loop;	3026	Event::loop;
2324	}	3027	}
…		…
2339	},	3042	},
2340	);	3043	);
2341	}	3044	}
2342	}	3045	}
2343		3046
		3047	sub write_runtime {
		3048	my $runtime = "$LOCALDIR/runtime";
		3049
		3050	# first touch the runtime file to show we are still running:
		3051	# the fsync below can take a very very long time.
		3052
		3053	IO::AIO::aio_utime $runtime, undef, undef;
		3054
		3055	my $guard = cf::lock_acquire "write_runtime";
		3056
		3057	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3058	or return;
		3059
		3060	my $value = $cf::RUNTIME + 90 + 10;
		3061	# 10 is the runtime save interval, for a monotonic clock
		3062	# 60 allows for the watchdog to kill the server.
		3063
		3064	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3065	and return;
		3066
		3067	# always fsync - this file is important
		3068	aio_fsync $fh
		3069	and return;
		3070
		3071	# touch it again to show we are up-to-date
		3072	aio_utime $fh, undef, undef;
		3073
		3074	close $fh
		3075	or return;
		3076
		3077	aio_rename "$runtime~", $runtime
		3078	and return;
		3079
		3080	warn "runtime file written.\n";
		3081
		3082	1
		3083	}
		3084
2344	sub emergency_save() {	3085	sub emergency_save() {
2345	my $freeze_guard = cf::freeze_mainloop;	3086	my $freeze_guard = cf::freeze_mainloop;
2346		3087
2347	warn "enter emergency perl save\n";	3088	warn "enter emergency perl save\n";
2348		3089
…		…
2363	my $map = $cf::MAP{$path} or next;	3104	my $map = $cf::MAP{$path} or next;
2364	$map->valid or next;	3105	$map->valid or next;
2365	$map->save;	3106	$map->save;
2366	}	3107	}
2367	warn "end emergency map save\n";	3108	warn "end emergency map save\n";
		3109
		3110	warn "begin emergency database checkpoint\n";
		3111	BDB::db_env_txn_checkpoint $DB_ENV;
		3112	warn "end emergency database checkpoint\n";
2368	};	3113	};
2369		3114
2370	warn "leave emergency perl save\n";	3115	warn "leave emergency perl save\n";
2371	}	3116	}
2372		3117
		3118	sub post_cleanup {
		3119	my ($make_core) = @_;
		3120
		3121	warn Carp::longmess "post_cleanup backtrace"
		3122	if $make_core;
		3123	}
		3124
2373	sub reload() {	3125	sub do_reload_perl() {
2374	# can/must only be called in main	3126	# can/must only be called in main
2375	if ($Coro::current != $Coro::main) {	3127	if ($Coro::current != $Coro::main) {
2376	warn "can only reload from main coroutine";	3128	warn "can only reload from main coroutine";
2377	return;	3129	return;
2378	}	3130	}
2379		3131
2380	warn "reloading...";	3132	warn "reloading...";
2381		3133
2382	warn "cancelling server ticker";	3134	warn "entering sync_job";
2383	$TICK_WATCHER->cancel;
2384		3135
		3136	cf::sync_job {
		3137	cf::write_runtime; # external watchdog should not bark
2385	cf::emergency_save;	3138	cf::emergency_save;
		3139	cf::write_runtime; # external watchdog should not bark
2386		3140
2387	eval {	3141	warn "syncing database to disk";
		3142	BDB::db_env_txn_checkpoint $DB_ENV;
		3143
2388	# if anything goes wrong in here, we should simply crash as we already saved	3144	# if anything goes wrong in here, we should simply crash as we already saved
2389
2390	warn "syncing database to disk";
2391	cf::db_sync;
2392		3145
2393	warn "cancelling all WF_AUTOCANCEL watchers";	3146	warn "cancelling all WF_AUTOCANCEL watchers";
2394	for (Event::all_watchers) {	3147	for (Event::all_watchers) {
2395	$_->cancel if $_->data & WF_AUTOCANCEL;	3148	$_->cancel if $_->data & WF_AUTOCANCEL;
2396	}	3149	}
2397		3150
2398	warn "flushing outstanding aio requests";	3151	warn "flushing outstanding aio requests";
2399	for (;;) {	3152	for (;;) {
		3153	BDB::flush;
2400	IO::AIO::flush;	3154	IO::AIO::flush;
2401	Coro::cede;	3155	Coro::cede;
2402	last unless IO::AIO::nreqs;	3156	last unless IO::AIO::nreqs || BDB::nreqs;
2403	warn "iterate...";	3157	warn "iterate...";
2404	}	3158	}
		3159
		3160	++$RELOAD;
2405		3161
2406	warn "cancelling all extension coros";	3162	warn "cancelling all extension coros";
2407	$_->cancel for values %EXT_CORO;	3163	$_->cancel for values %EXT_CORO;
2408	%EXT_CORO = ();	3164	%EXT_CORO = ();
2409		3165
2410	warn "removing commands";	3166	warn "removing commands";
2411	%COMMAND = ();	3167	%COMMAND = ();
2412		3168
2413	warn "removing ext commands";	3169	warn "removing ext/exti commands";
2414	%EXTCMD = ();	3170	%EXTCMD = ();
		3171	%EXTICMD = ();
2415		3172
2416	warn "unloading/nuking all extensions";	3173	warn "unloading/nuking all extensions";
2417	for my $pkg (@EXTS) {	3174	for my $pkg (@EXTS) {
2418	warn "... unloading $pkg";	3175	warn "... unloading $pkg";
2419		3176
…		…
2449	Symbol::delete_package "safe::$_"	3206	Symbol::delete_package "safe::$_"
2450	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3207	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2451		3208
2452	warn "unloading cf.pm \"a bit\"";	3209	warn "unloading cf.pm \"a bit\"";
2453	delete $INC{"cf.pm"};	3210	delete $INC{"cf.pm"};
		3211	delete $INC{"cf/pod.pm"};
2454		3212
2455	# don't, removes xs symbols, too,	3213	# don't, removes xs symbols, too,
2456	# and global variables created in xs	3214	# and global variables created in xs
2457	#Symbol::delete_package __PACKAGE__;	3215	#Symbol::delete_package __PACKAGE__;
2458		3216
…		…
2462	require cf;	3220	require cf;
2463	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3221	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2464		3222
2465	warn "loading config and database again";	3223	warn "loading config and database again";
2466	cf::cfg_load;	3224	cf::cfg_load;
2467	cf::db_load;
2468		3225
2469	warn "loading extensions";	3226	warn "loading extensions";
2470	cf::load_extensions;	3227	cf::load_extensions;
2471		3228
2472	warn "reattaching attachments to objects/players";	3229	warn "reattaching attachments to objects/players";
2473	_global_reattach;	3230	_global_reattach; # objects, sockets
2474	warn "reattaching attachments to maps";	3231	warn "reattaching attachments to maps";
2475	reattach $_ for values %MAP;	3232	reattach $_ for values %MAP;
		3233	warn "reattaching attachments to players";
		3234	reattach $_ for values %PLAYER;
2476		3235
2477	warn "loading reloadable resources";	3236	warn "leaving sync_job";
2478	load_resources;
2479		3237
2480	warn "restarting server ticker";	3238	1
2481		3239	} or do {
2482	$TICK_WATCHER->start;
2483	};
2484
2485	if ($@) {
2486	warn $@;	3240	warn $@;
2487	warn "error while reloading, exiting.";	3241	warn "error while reloading, exiting.";
2488	exit 1;	3242	exit 1;
2489	}	3243	};
2490		3244
2491	warn "reloaded";	3245	warn "reloaded";
2492	};	3246	};
2493		3247
2494	our $RELOAD_WATCHER; # used only during reload	3248	our $RELOAD_WATCHER; # used only during reload
2495		3249
		3250	sub reload_perl() {
		3251	# doing reload synchronously and two reloads happen back-to-back,
		3252	# coro crashes during coro_state_free->destroy here.
		3253
		3254	$RELOAD_WATCHER ||= Event->timer (
		3255	reentrant => 0,
		3256	after => 0,
		3257	data => WF_AUTOCANCEL,
		3258	cb => sub {
		3259	do_reload_perl;
		3260	undef $RELOAD_WATCHER;
		3261	},
		3262	);
		3263	}
		3264
2496	register_command "reload" => sub {	3265	register_command "reload" => sub {
2497	my ($who, $arg) = @_;	3266	my ($who, $arg) = @_;
2498		3267
2499	if ($who->flag (FLAG_WIZ)) {	3268	if ($who->flag (FLAG_WIZ)) {
2500	$who->message ("reloading server.");	3269	$who->message ("reloading server.");
2501		3270	async { reload_perl };
2502	# doing reload synchronously and two reloads happen back-to-back,
2503	# coro crashes during coro_state_free->destroy here.
2504
2505	$RELOAD_WATCHER ||= Event->timer (
2506	reentrant => 0,
2507	after => 0,
2508	data => WF_AUTOCANCEL,
2509	cb => sub {
2510	reload;
2511	undef $RELOAD_WATCHER;
2512	},
2513	);
2514	}	3271	}
2515	};	3272	};
2516		3273
2517	unshift @INC, $LIBDIR;	3274	unshift @INC, $LIBDIR;
2518		3275
2519	my $bug_warning = 0;	3276	my $bug_warning = 0;
2520		3277
		3278	our @WAIT_FOR_TICK;
		3279	our @WAIT_FOR_TICK_BEGIN;
		3280
		3281	sub wait_for_tick {
		3282	return unless $TICK_WATCHER->is_active;
		3283	return if $Coro::current == $Coro::main;
		3284
		3285	my $signal = new Coro::Signal;
		3286	push @WAIT_FOR_TICK, $signal;
		3287	$signal->wait;
		3288	}
		3289
		3290	sub wait_for_tick_begin {
		3291	return unless $TICK_WATCHER->is_active;
		3292	return if $Coro::current == $Coro::main;
		3293
		3294	my $signal = new Coro::Signal;
		3295	push @WAIT_FOR_TICK_BEGIN, $signal;
		3296	$signal->wait;
		3297	}
		3298
		3299	my $min = 1e6;#d#
		3300	my $avg = 10;
2521	$TICK_WATCHER = Event->timer (	3301	$TICK_WATCHER = Event->timer (
2522	reentrant => 0,	3302	reentrant => 0,
2523	parked => 1,	3303	parked => 1,
2524	prio => 0,	3304	prio => 0,
2525	at => $NEXT_TICK || $TICK,	3305	at => $NEXT_TICK || $TICK,
…		…
2529	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3309	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2530	unless ++$bug_warning > 10;	3310	unless ++$bug_warning > 10;
2531	return;	3311	return;
2532	}	3312	}
2533		3313
2534	$NOW = Event::time;	3314	$NOW = $tick_start = Event::time;
2535		3315
2536	cf::server_tick; # one server iteration	3316	cf::server_tick; # one server iteration
		3317
		3318	0 && sync_job {#d#
		3319	for(1..10) {
		3320	my $t = Event::time;
		3321	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3322	or die;
		3323
		3324	$map->width (50);
		3325	$map->height (50);
		3326	$map->alloc;
		3327	$map->_load_objects ("/tmp/x.map", 1);
		3328	my $t = Event::time - $t;
		3329
		3330	#next unless $t < 0.0013;#d#
		3331	if ($t < $min) {
		3332	$min = $t;
		3333	}
		3334	$avg = $avg * 0.99 + $t * 0.01;
		3335	}
		3336	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3337	exit 0;
		3338	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3339	};
		3340
2537	$RUNTIME += $TICK;	3341	$RUNTIME += $TICK;
2538	$NEXT_TICK += $TICK;	3342	$NEXT_TICK += $TICK;
2539		3343
2540	$WAIT_FOR_TICK->broadcast;	3344	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2541	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3345	$NEXT_RUNTIME_WRITE = $NOW + 10;
2542		3346	Coro::async_pool {
2543	Event::sweep;	3347	write_runtime
2544	Coro::cede_notself;	3348	or warn "ERROR: unable to write runtime file: $!";
		3349	};
2545		3350	}
		3351
2546	# my $AFTER = Event::time;	3352	# my $AFTER = Event::time;
2547	# warn $AFTER - $NOW;#d#	3353	# warn $AFTER - $NOW;#d#
2548		3354
		3355	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3356	$sig->send;
		3357	}
		3358	while (my $sig = shift @WAIT_FOR_TICK) {
		3359	$sig->send;
		3360	}
		3361
		3362	$NOW = Event::time;
		3363
2549	# if we are delayed by four ticks or more, skip them all	3364	# if we are delayed by four ticks or more, skip them all
2550	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3365	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2551		3366
2552	$TICK_WATCHER->at ($NEXT_TICK);	3367	$TICK_WATCHER->at ($NEXT_TICK);
2553	$TICK_WATCHER->start;	3368	$TICK_WATCHER->start;
		3369
		3370	$LOAD = ($NOW - $tick_start) / $TICK;
		3371	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3372
		3373	_post_tick;
		3374
		3375
2554	},	3376	},
2555	);	3377	);
2556		3378
		3379	{
		3380	BDB::max_poll_time $TICK * 0.1;
		3381	$BDB_POLL_WATCHER = Event->io (
		3382	reentrant => 0,
		3383	fd => BDB::poll_fileno,
		3384	poll => 'r',
		3385	prio => 0,
		3386	data => WF_AUTOCANCEL,
		3387	cb => \&BDB::poll_cb,
		3388	);
		3389	BDB::min_parallel 8;
		3390
		3391	BDB::set_sync_prepare {
		3392	my $status;
		3393	my $current = $Coro::current;
		3394	(
		3395	sub {
		3396	$status = $!;
		3397	$current->ready; undef $current;
		3398	},
		3399	sub {
		3400	Coro::schedule while defined $current;
		3401	$! = $status;
		3402	},
		3403	)
		3404	};
		3405
		3406	unless ($DB_ENV) {
		3407	$DB_ENV = BDB::db_env_create;
		3408
		3409	cf::sync_job {
		3410	eval {
		3411	BDB::db_env_open
		3412	$DB_ENV,
		3413	$BDBDIR,
		3414	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3415	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3416	0666;
		3417
		3418	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3419
		3420	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3421	$DB_ENV->set_lk_detect;
		3422	};
		3423
		3424	cf::cleanup "db_env_open(db): $@" if $@;
		3425	};
		3426	}
		3427	}
		3428
		3429	{
		3430	IO::AIO::min_parallel 8;
		3431
		3432	undef $Coro::AIO::WATCHER;
2557	IO::AIO::max_poll_time $TICK * 0.1;	3433	IO::AIO::max_poll_time $TICK * 0.1;
2558
2559	undef $Coro::AIO::WATCHER;
2560	$AIO_POLL_WATCHER = Event->io (	3434	$AIO_POLL_WATCHER = Event->io (
2561	reentrant => 0,	3435	reentrant => 0,
		3436	data => WF_AUTOCANCEL,
2562	fd => IO::AIO::poll_fileno,	3437	fd => IO::AIO::poll_fileno,
2563	poll => 'r',	3438	poll => 'r',
2564	prio => 6,	3439	prio => 6,
2565	data => WF_AUTOCANCEL,
2566	cb => \&IO::AIO::poll_cb,	3440	cb => \&IO::AIO::poll_cb,
2567	);	3441	);
		3442	}
2568		3443
2569	$WRITE_RUNTIME_WATCHER = Event->timer (	3444	my $_log_backtrace;
2570	reentrant => 0,	3445
2571	data => WF_AUTOCANCEL,	3446	sub _log_backtrace {
2572	after => 1,	3447	my ($msg, @addr) = @_;
2573	interval => 10,	3448
2574	prio => 6, # keep it lowest so it acts like a watchdog	3449	$msg =~ s/\n//;
2575	cb => Coro::unblock_sub {	3450
2576	write_runtime	3451	# limit the # of concurrent backtraces
2577	or warn "ERROR: unable to write runtime file: $!";	3452	if ($_log_backtrace < 2) {
		3453	++$_log_backtrace;
		3454	async {
		3455	my @bt = fork_call {
		3456	@addr = map { sprintf "%x", $_ } @addr;
		3457	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3458	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3459	or die "addr2line: $!";
		3460
		3461	my @funcs;
		3462	my @res = <$fh>;
		3463	chomp for @res;
		3464	while (@res) {
		3465	my ($func, $line) = splice @res, 0, 2, ();
		3466	push @funcs, "[$func] $line";
		3467	}
		3468
		3469	@funcs
		3470	};
		3471
		3472	LOG llevInfo, "[ABT] $msg\n";
		3473	LOG llevInfo, "[ABT] $_\n" for @bt;
		3474	--$_log_backtrace;
		3475	};
		3476	} else {
		3477	LOG llevInfo, "[ABT] $msg\n";
		3478	LOG llevInfo, "[ABT] [suppressed]\n";
2578	},	3479	}
2579	);	3480	}
		3481
		3482	# load additional modules
		3483	use cf::pod;
2580		3484
2581	END { cf::emergency_save }	3485	END { cf::emergency_save }
2582		3486
2583	1	3487	1
2584		3488

Diff Legend

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