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.208 by root, Mon Feb 12 00:27:20 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 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 ();
20	use BDB ();	27	use BDB ();
21	use Data::Dumper;	28	use Data::Dumper;
22	use Digest::MD5;	29	use Digest::MD5;
23	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
24	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	33	use Time::HiRes;
27	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
28		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
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		42
31	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
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		44
35	# 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?
36	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
37		47
38	$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
39		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
40	our %COMMAND = ();	52	our %COMMAND = ();
41	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
42		54
43	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
47		60
		61	our $RELOAD; # number of reloads so far
48	our @EVENT;	62	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		63
51	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(!)
52	our $TICK_WATCHER;	77	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	80	our $NEXT_TICK;
56	our $NOW;	81	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		83
59	our $BDB_POLL_WATCHER;	84	our $BDB_POLL_WATCHER;
…		…
65	our $RUNTIME;	90	our $RUNTIME;
66		91
67	our %PLAYER; # all users	92	our %PLAYER; # all users
68	our %MAP; # all maps	93	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		95
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	103	binmode STDOUT;
80	binmode STDERR;	104	binmode STDERR;
81		105
82	# read virtual server time, if available	106	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
87	}	111	}
88		112
89	mkdir cf::localdir;	113	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		115
96	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
97		117
98	sub cf::map::normalise;	118	sub cf::map::normalise;
99		119
…		…
110	=item $cf::RUNTIME	130	=item $cf::RUNTIME
111		131
112	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
113	every server tick.	133	every server tick.
114		134
115	=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
116		138
117	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		143
120	=item $cf::NOW	144	=item $cf::NOW
121		145
122	The time of the last (current) server tick.	146	The time of the last (current) server tick.
123		147
124	=item $cf::TICK	148	=item $cf::TICK
125		149
126	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.
127		161
128	=item %cf::CFG	162	=item %cf::CFG
129		163
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	165	from wherever your confdir points to.
132		166
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		168
135	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
136	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
137	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.
138	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.
139		178
140	=back	179	=back
141		180
142	=cut	181	=cut
143		182
144	BEGIN {	183	BEGIN {
145	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	185	my $msg = join "", @_;
147	utf8::encode $msg;
148		186
149	$msg .= "\n"	187	$msg .= "\n"
150	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
151		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
152	LOG llevError, $msg;	193	LOG llevError, $msg;
153	};	194	};
154	}	195	}
155		196
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		204
163	# 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
164	# within the Safe compartment.	206	# within the Safe compartment.
165	for my $pkg (qw(	207	for my $pkg (qw(
166	cf::global cf::attachable	208	cf::global cf::attachable
…		…
174	}	216	}
175		217
176	$Event::DIED = sub {	218	$Event::DIED = sub {
177	warn "error in event callback: @_";	219	warn "error in event callback: @_";
178	};	220	};
		221
		222	#############################################################################
179		223
180	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
181		225
182	=over 4	226	=over 4
183		227
…		…
202	$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;
203	$d	247	$d
204	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
205	}	249	}
206		250
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
210		252
211	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
212		254
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
221		256
222	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
223		258
224	=cut	259	=cut
225		260
226	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
228	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
229	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
230		265
231	=item cf::lock_wait $string	266	=item cf::lock_wait $string
232		267
233	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
234		269
…		…
237	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
238	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
239	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
240	returned.	275	returned.
241		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
242	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
243	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
244		286
245	=cut	287	=cut
246		288
247	our %LOCK;	289	our %LOCK;
248		290
…		…
268	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
270	}	312	}
271	}	313	}
272		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
273	sub freeze_mainloop {	321	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
275		323
276	my $guard = Coro::guard {	324	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	325	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	326	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
282	$guard	328	$guard
		329	}
		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
283	}	385	}
284		386
285	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
286		388
287	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
…		…
292		394
293	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
294		396
295	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
296		398
297	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
300		403
301	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
302	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
303	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
304	fast or be very important.	407	fast or be very important.
…		…
307		410
308	sub sync_job(&) {	411	sub sync_job(&) {
309	my ($job) = @_;	412	my ($job) = @_;
310		413
311	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
312	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
314		419
315	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
327		432
328	while ($busy) {	433	while ($busy) {
329	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
330	}	435	}
331		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
		443
332	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
333	} else {	445	} else {
334	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
335		447
336	$job->()	448	$job->()
…		…
355	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
356		468
357	$coro	469	$coro
358	}	470	}
359		471
360	sub write_runtime {	472	=item fork_call { }, $args
361	my $runtime = cf::localdir . "/runtime";
362		473
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
364	or return;	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
365		478
366	my $value = $cf::RUNTIME + 90 + 10;	479	=cut
367	# 10 is the runtime save interval, for a monotonic clock
368	# 60 allows for the watchdog to kill the server.
369		480
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	481	sub fork_call(&@) {
371	and return;	482	my ($cb, @args) = @_;
372		483
373	# always fsync - this file is important	484	# we seemingly have to make a local copy of the whole thing,
374	aio_fsync $fh	485	# otherwise perl prematurely frees the stuff :/
375	and return;	486	# TODO: investigate and fix (liekly this will be rather laborious)
376		487
377	close $fh	488	my @res = Coro::Util::fork_eval {
378	or return;	489	reset_signals;
		490	&$cb
		491	}, @args;
379		492
380	aio_rename "$runtime~", $runtime	493	wantarray ? @res : $res[-1]
381	and return;	494	}
382		495
		496	=item $value = cf::db_get $family => $key
		497
		498	Returns a single value from the environment database.
		499
		500	=item cf::db_put $family => $key => $value
		501
		502	Stores the given C<$value> in the family. It can currently store binary
		503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		504
		505	=cut
		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
383	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
		610	}
		611
		612	=item cf::datalog type => key => value, ...
		613
		614	Log a datalog packet of the given type with the given key-value pairs.
		615
		616	=cut
		617
		618	sub datalog($@) {
		619	my ($type, %kv) = @_;
		620	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384	}	621	}
385		622
386	=back	623	=back
387		624
388	=cut	625	=cut
…		…
395	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
396	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
397		634
398	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
399	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
400	crossfire+).	637	Crossfire TRT).
401		638
402	=over 4	639	=over 4
403		640
404	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
405		642
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
569		806
570	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		811
575	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	813	my $pkg = shift @arg;
577		814
578	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
608	}	845	}
609		846
610	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
611	} else {	848	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	850	}
614		851
615	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
616	}	853	}
617		854
…		…
619	if (ref $_[0]) {	856	if (ref $_[0]) {
620	_object_attach @_;	857	_object_attach @_;
621	} else {	858	} else {
622	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
623	}	860	}
		861	_recalc_want;
624	};	862	};
625		863
626	# all those should be optimised	864	# all those should be optimised
627	sub cf::attachable::detach {	865	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
632	reattach ($obj);	870	reattach ($obj);
633	} else {	871	} else {
634	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
635	}	873	}
		874	_recalc_want;
636	};	875	};
637		876
638	sub cf::attachable::attached {	877	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
640		879
…		…
655	";	894	";
656	die if $@;	895	die if $@;
657	}	896	}
658		897
659	our $override;	898	our $override;
660	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661		900
662	sub override {	901	sub override {
663	$override = 1;	902	$override = 1;
664	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
665	}	904	}
666		905
667	sub do_invoke {	906	sub do_invoke {
668	my $event = shift;	907	my $event = shift;
669	my $callbacks = shift;	908	my $callbacks = shift;
670		909
671	@invoke_results = ();	910	@INVOKE_RESULTS = ();
672		911
673	local $override;	912	local $override;
674		913
675	for (@$callbacks) {	914	for (@$callbacks) {
676	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
693		932
694	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
695		934
696	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
698	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699		938
700	=back	939	=back
701		940
702	=cut	941	=cut
703		942
704	#############################################################################	943	#############################################################################
705	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
706		956
707	sub reattach {	957	sub reattach {
708	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
709	my ($obj) = @_;	959	my ($obj) = @_;
710		960
…		…
787	}	1037	}
788	} else {	1038	} else {
789	aio_unlink $filename;	1039	aio_unlink $filename;
790	aio_unlink "$filename.pst";	1040	aio_unlink "$filename.pst";
791	}	1041	}
792
793	#d##TODO# nuke non .map-files if exist
794	if ($filename =~ s/\.map$//) {
795	aio_unlink $filename;
796	aio_unlink "$filename.pst";
797	}
798	}	1042	}
799	}	1043	}
800		1044
801	sub object_freezer_as_string {	1045	sub object_freezer_as_string {
802	my ($rdata, $objs) = @_;	1046	my ($rdata, $objs) = @_;
…		…
808		1052
809	sub object_thawer_load {	1053	sub object_thawer_load {
810	my ($filename) = @_;	1054	my ($filename) = @_;
811		1055
812	my ($data, $av);	1056	my ($data, $av);
813
814	#d#TODO remove .map if file does not exist
815	aio_stat $filename and $filename =~ s/\.map$//;
816		1057
817	(aio_load $filename, $data) >= 0	1058	(aio_load $filename, $data) >= 0
818	or return;	1059	or return;
819		1060
820	unless (aio_stat "$filename.pst") {	1061	unless (aio_stat "$filename.pst") {
…		…
822	or return;	1063	or return;
823	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
824	}	1065	}
825		1066
826	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
827	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
828	return ($data, $av);	1069	return ($data, $av);
829	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
830		1077
831	#############################################################################	1078	#############################################################################
832	# command handling &c	1079	# command handling &c
833		1080
834	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
847	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
848	}	1095	}
849		1096
850	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
851		1098
852	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
853		1104
854	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
855	called.	1106	called.
856		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
857	=cut	1119	=cut
858		1120
859	sub register_extcmd {	1121	sub register_extcmd {
860	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
861		1123
862	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
863	}	1131	}
864		1132
865	cf::player->attach (	1133	cf::player->attach (
866	on_command => sub {	1134	on_command => sub {
867	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
876	cf::override;	1144	cf::override;
877	},	1145	},
878	on_extcmd => sub {	1146	on_extcmd => sub {
879	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
880		1148
881	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882		1150
883	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
884	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
885	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
886	$pl->ext_reply ($msg->{msgid}, %reply);
887	}
888	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
889	} else {	1166	} else {
890	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
891	}	1168	}
892		1169
893	cf::override;	1170	cf::override;
894	},	1171	},
895	);	1172	);
896		1173
897	sub load_extension {
898	my ($path) = @_;
899
900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
901	my $base = $1;
902	my $pkg = $1;
903	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "ext::$pkg";
905
906	warn "... loading '$path' into '$pkg'\n";
907
908	open my $fh, "<:utf8", $path
909	or die "$path: $!";
910
911	my $source =
912	"package $pkg; use strict; use utf8;\n"
913	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })
915	. "\n};\n1";
916
917	unless (eval $source) {
918	my $msg = $@ ? "$path: $@\n"
919	: "extension disabled.\n";
920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921	warn $@;
922	warn "mandatory extension failed to load, exiting.\n";
923	exit 1;
924	}
925	die $@;
926	}
927
928	push @EXTS, $pkg;
929	}
930
931	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
932	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
933	next unless -r $ext;	1179	next unless -r $path;
934	eval {	1180
935	load_extension $ext;	1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
936	1	1238	}
937	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
938	}	1244	};
939	}	1245	}
940		1246
941	#############################################################################	1247	#############################################################################
942		1248
		1249	=back
		1250
943	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
944		1252
945	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
946		1254
947	=cut	1255	=cut
…		…
959	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
960		1268
961	=cut	1269	=cut
962		1270
963	sub playerdir($) {	1271	sub playerdir($) {
964	cf::localdir	1272	"$PLAYERDIR/"
965	. "/"
966	. cf::playerdir
967	. "/"
968	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
969	}	1274	}
970		1275
971	sub path($) {	1276	sub path($) {
972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973		1278
974	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
975	}	1280	}
976		1281
977	sub find_active($) {	1282	sub find_active($) {
978	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
979	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
992	my $login = $_[0];	1297	my $login = $_[0];
993		1298
994	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
995		1300
996	$cf::PLAYER{$_[0]} || do {	1301	$cf::PLAYER{$_[0]} || do {
		1302	# rename old playerfiles to new ones
		1303	#TODO: remove when no longer required
		1304	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1305	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1306	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1307	aio_unlink +(playerdir $login) . "/$login.pl";
		1308
997	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
998	or return;	1310	or return;
999	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
1000	}	1312	}
1001	}	1313	}
…		…
1013		1325
1014	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1015	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1016		1328
1017	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1018	Coro::cede;	1330	cf::cede_to_tick;
1019	}	1331	}
1020		1332
1021	sub new($) {	1333	sub new($) {
1022	my ($login) = @_;	1334	my ($login) = @_;
1023		1335
…		…
1029	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1030		1342
1031	$self	1343	$self
1032	}	1344	}
1033		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
		1354	}
		1355
1034	=item $pl->quit_character	1356	=item $pl->quit_character
1035		1357
1036	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
1037	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1038		1360
1039	=cut	1361	=cut
1040		1362
1041	sub quit_character {	1363	sub quit_character {
1042	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1043		1367
1044	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1045	$pl->password ("*"); # this should lock out the player until we nuked the dir	1369	$pl->password ("*"); # this should lock out the player until we nuked the dir
1046		1370
1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1052	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1053	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1054	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1055	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1056	$pl->destroy;	1380	$pl->destroy;
		1381
		1382	my $prefix = qr<^~\Q$name\E/>;
		1383
		1384	# nuke player maps
		1385	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1386
1057	IO::AIO::aio_rmtree $temp;	1387	IO::AIO::aio_rmtree $temp;
		1388	}
		1389
		1390	=item $pl->kick
		1391
		1392	Kicks a player out of the game. This destroys the connection.
		1393
		1394	=cut
		1395
		1396	sub kick {
		1397	my ($pl, $kicker) = @_;
		1398
		1399	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1400	$pl->killer ("kicked");
		1401	$pl->ns->destroy;
1058	}	1402	}
1059		1403
1060	=item cf::player::list_logins	1404	=item cf::player::list_logins
1061		1405
1062	Returns am arrayref of all valid playernames in the system, can take a	1406	Returns am arrayref of all valid playernames in the system, can take a
1063	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1064		1408
1065	=cut	1409	=cut
1066		1410
1067	sub list_logins {	1411	sub list_logins {
1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1069	or return [];	1413	or return [];
1070		1414
1071	my @logins;	1415	my @logins;
1072		1416
1073	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1108	}	1452	}
1109		1453
1110	\@paths	1454	\@paths
1111	}	1455	}
1112		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1113	=item $player->ext_reply ($msgid, $msgtype, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1114		1508
1115	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1116		1510
1117	=cut	1511	=cut
1118		1512
1119	sub ext_reply($$$%) {	1513	sub ext_reply($$@) {
1120	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1121		1515
1122	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1123
1124	$self->send ("ext " . cf::to_json \%msg);
1125	}	1517	}
1126		1518
1127	package cf;	1519	=item $player->ext_msg ($type, @msg)
		1520
		1521	Sends an ext event to the client.
		1522
		1523	=cut
		1524
		1525	sub ext_msg($$@) {
		1526	my ($self, $type, @msg) = @_;
		1527
		1528	$self->ns->ext_msg ($type, @msg);
		1529	}
		1530
		1531	=head3 cf::region
		1532
		1533	=over 4
		1534
		1535	=cut
		1536
		1537	package cf::region;
		1538
		1539	=item cf::region::find_by_path $path
		1540
		1541	Tries to decuce the likely region for a map knowing only its path.
		1542
		1543	=cut
		1544
		1545	sub find_by_path($) {
		1546	my ($path) = @_;
		1547
		1548	my ($match, $specificity);
		1549
		1550	for my $region (list) {
		1551	if ($region->{match} && $path =~ $region->{match}) {
		1552	($match, $specificity) = ($region, $region->specificity)
		1553	if $region->specificity > $specificity;
		1554	}
		1555	}
		1556
		1557	$match
		1558	}
1128		1559
1129	=back	1560	=back
1130
1131		1561
1132	=head3 cf::map	1562	=head3 cf::map
1133		1563
1134	=over 4	1564	=over 4
1135		1565
…		…
1190	my ($self, $merge) = @_;	1620	my ($self, $merge) = @_;
1191		1621
1192	# we have to keep some variables in memory intact	1622	# we have to keep some variables in memory intact
1193	local $self->{path};	1623	local $self->{path};
1194	local $self->{load_path};	1624	local $self->{load_path};
1195	local $self->{deny_save};
1196	local $self->{deny_reset};
1197		1625
1198	$self->SUPER::thawer_merge ($merge);	1626	$self->SUPER::thawer_merge ($merge);
1199	}	1627	}
1200		1628
1201	sub normalise {	1629	sub normalise {
…		…
1248	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1249	return $self;	1677	return $self;
1250	}	1678	}
1251	}	1679	}
1252		1680
1253	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1254	()	1682	()
1255	}	1683	}
1256		1684
1257	sub init {	1685	sub init {
1258	my ($self) = @_;	1686	my ($self) = @_;
…		…
1273		1701
1274	# the original (read-only) location	1702	# the original (read-only) location
1275	sub load_path {	1703	sub load_path {
1276	my ($self) = @_;	1704	my ($self) = @_;
1277		1705
1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1706	"$MAPDIR/$self->{path}.map"
1279	}	1707	}
1280		1708
1281	# the temporary/swap location	1709	# the temporary/swap location
1282	sub save_path {	1710	sub save_path {
1283	my ($self) = @_;	1711	my ($self) = @_;
1284		1712
1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1714	"$TMPDIR/$path.map"
1287	}	1715	}
1288		1716
1289	# the unique path, undef == no special unique path	1717	# the unique path, undef == no special unique path
1290	sub uniq_path {	1718	sub uniq_path {
1291	my ($self) = @_;	1719	my ($self) = @_;
1292		1720
1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1722	"$UNIQUEDIR/$path"
1295	}	1723	}
1296		1724
1297	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1298	# all maps in C++...	1726	# all maps in C++...
1299	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1301		1729
1302	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1303	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1304	}	1732	}
1305		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
1306	sub unlink_save {	1742	sub unlink_save {
1307	my ($self) = @_;	1743	my ($self) = @_;
1308		1744
1309	utf8::encode (my $save = $self->save_path);	1745	utf8::encode (my $save = $self->save_path);
1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313	#d#TODO remove .map and also nuke
1314	$save =~ s/\.map// or return;#d#
1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317	}	1748	}
1318		1749
1319	sub load_header_from($) {	1750	sub load_header_from($) {
1320	my ($self, $path) = @_;	1751	my ($self, $path) = @_;
1321		1752
…		…
1371	$self->load_header_orig	1802	$self->load_header_orig
1372	or return;	1803	or return;
1373	$self->prepare_orig;	1804	$self->prepare_orig;
1374	}	1805	}
1375		1806
		1807	$self->{deny_reset} = 1
		1808	if $self->no_reset;
		1809
		1810	$self->default_region (cf::region::find_by_path $self->{path})
		1811	unless $self->default_region;
		1812
1376	1	1813	1
1377	}	1814	}
1378		1815
1379	sub find;	1816	sub find;
1380	sub find {	1817	sub find {
…		…
1392	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1393		1830
1394	$map->load_header	1831	$map->load_header
1395	or return;	1832	or return;
1396		1833
1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398	# doing this can freeze the server in a sync job, obviously	1835	# doing this can freeze the server in a sync job, obviously
1399	#$cf::WAIT_FOR_TICK->wait;	1836	#$cf::WAIT_FOR_TICK->wait;
1400	$map->reset;	1837	$map->reset;
1401	undef $guard;	1838	undef $guard;
1402	return find $path;	1839	return find $path;
…		…
1413	my ($self) = @_;	1850	my ($self) = @_;
1414		1851
1415	local $self->{deny_reset} = 1; # loading can take a long time	1852	local $self->{deny_reset} = 1; # loading can take a long time
1416		1853
1417	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1418	my $guard = cf::lock_acquire "map_load:$path";	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1419		1859
1420	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1421		1861
1422	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1423		1863
1424	$self->alloc;	1864	$self->alloc;
1425		1865
1426	$self->pre_load;	1866	$self->pre_load;
		1867	cf::cede_to_tick;
1427		1868
1428	$self->_load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1429	or return;	1870	or return;
1430		1871
1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432	if delete $self->{load_original};	1873	if delete $self->{load_original};
1433		1874
1434	if (my $uniq = $self->uniq_path) {	1875	if (my $uniq = $self->uniq_path) {
1435	utf8::encode $uniq;	1876	utf8::encode $uniq;
1436	if (aio_open $uniq, O_RDONLY, 0) {	1877	if (aio_open $uniq, O_RDONLY, 0) {
1437	$self->clear_unique_items;	1878	$self->clear_unique_items;
1438	$self->_load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1439	}	1880	}
1440	}	1881	}
1441		1882
1442	Coro::cede;	1883	cf::cede_to_tick;
1443
1444	# now do the right thing for maps	1884	# now do the right thing for maps
1445	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1446
1447	unless ($self->{deny_activate}) {
1448	$self->decay_objects;
1449	$self->fix_auto_apply;
1450	$self->update_buttons;
1451	Coro::cede;
1452	$self->set_darkness_map;
1453	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1454	unless $self->difficulty;	1887	unless $self->difficulty;
1455	Coro::cede;	1888	cf::cede_to_tick;
		1889
		1890	unless ($self->{deny_activate}) {
		1891	$self->decay_objects;
		1892	$self->fix_auto_apply;
		1893	$self->update_buttons;
		1894	cf::cede_to_tick;
		1895	$self->set_darkness_map;
		1896	cf::cede_to_tick;
1456	$self->activate;	1897	$self->activate;
		1898	}
		1899
		1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
		1902
		1903	$self->in_memory (cf::MAP_IN_MEMORY);
1457	}	1904	}
1458		1905
1459	$self->post_load;	1906	$self->post_load;
1460
1461	$self->in_memory (cf::MAP_IN_MEMORY);
1462	}	1907	}
1463		1908
1464	sub customise_for {	1909	sub customise_for {
1465	my ($self, $ob) = @_;	1910	my ($self, $ob) = @_;
1466		1911
1467	return find "~" . $ob->name . "/" . $self->{path}	1912	return find "~" . $ob->name . "/" . $self->{path}
1468	if $self->per_player;	1913	if $self->per_player;
1469		1914
		1915	# return find "?party/" . $ob->name . "/" . $self->{path}
		1916	# if $self->per_party;
		1917
1470	$self	1918	$self
1471	}	1919	}
1472		1920
1473	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1474	sub load_diag {	1922	sub load_neighbours {
1475	my ($map) = @_;	1923	my ($map) = @_;
1476		1924
1477	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1478		1926
1479	for (0 .. 3) {	1927	for (0 .. 3) {
1480	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1481	or next;	1929	or next;
1482	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1483	or next;	1931	or next;
1484	$neigh->load;	1932	$neigh->load;
1485		1933
		1934	push @neigh,
1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1488	}	1937	}
1489		1938
1490	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1491	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1492	or next;	1942	or next;
1493	$neigh->load;	1943	$neigh->load;
1494	}	1944	}
1495	}	1945	}
1496		1946
…		…
1501	}	1951	}
1502		1952
1503	sub do_load_sync {	1953	sub do_load_sync {
1504	my ($map) = @_;	1954	my ($map) = @_;
1505		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1506	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1507	}	1960	}
1508		1961
1509	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
1510	our $MAP_PREFETCHER = undef;	1963	our $MAP_PREFETCHER = undef;
1511		1964
1512	sub find_async {	1965	sub find_async {
1513	my ($path, $origin) = @_;	1966	my ($path, $origin, $load) = @_;
1514		1967
1515	$path = normalise $path, $origin && $origin->{path};	1968	$path = normalise $path, $origin && $origin->{path};
1516		1969
1517	if (my $map = $cf::MAP{$path}) {	1970	if (my $map = $cf::MAP{$path}) {
1518	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1519	}	1972	}
1520		1973
1521	undef $MAP_PREFETCH{$path};	1974	$MAP_PREFETCH{$path} |= $load;
		1975
1522	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1523	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1524	for my $path (keys %MAP_PREFETCH) {	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1525	my $map = find $path	1979	if (my $map = find $k) {
1526	or next;
1527	$map->load;	1980	$map->load if $v;
		1981	}
1528		1982
1529	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$k};
1530	}	1984	}
1531	}	1985	}
1532	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1533	};	1987	};
1534	$MAP_PREFETCHER->prio (6);	1988	$MAP_PREFETCHER->prio (6);
…		…
1537	}	1991	}
1538		1992
1539	sub save {	1993	sub save {
1540	my ($self) = @_;	1994	my ($self) = @_;
1541		1995
1542	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		1997
1544	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1545		1999
1546	return unless $self->dirty;	2000	return unless $self->dirty;
1547		2001
…		…
1570	my ($self) = @_;	2024	my ($self) = @_;
1571		2025
1572	# save first because save cedes	2026	# save first because save cedes
1573	$self->save;	2027	$self->save;
1574		2028
1575	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		2030
1577	return if $self->players;	2031	return if $self->players;
1578	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1579	return if $self->{deny_save};	2033	return if $self->{deny_save};
1580		2034
…		…
1584		2038
1585	sub reset_at {	2039	sub reset_at {
1586	my ($self) = @_;	2040	my ($self) = @_;
1587		2041
1588	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
1590	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1591		2044
1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594		2047
…		…
1605	my ($self) = @_;	2058	my ($self) = @_;
1606		2059
1607	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1608		2061
1609	return if $self->players;	2062	return if $self->players;
1610	return if $self->isa ("ext::map_per_player");#d#
1611		2063
1612	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1613		2075
1614	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
1615		2077
1616	$self->in_memory (cf::MAP_SWAPPED);
1617	$self->clear;	2078	$self->clear;
1618		2079
1619	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1620		2081
1621	$self->unlink_save;	2082	$self->unlink_save;
…		…
1640	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1641		2102
1642	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1643	}	2104	}
1644		2105
		2106	=item $maps = cf::map::tmp_maps
		2107
		2108	Returns an arrayref with all map paths of currently instantiated and saved
		2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
		2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
		2123
		2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
1645	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1646		2143
1647	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1648	instantiated unique items. May block.	2145	instantiated unique items. May block.
1649		2146
1650	=cut	2147	=cut
1651		2148
1652	sub unique_maps() {	2149	sub unique_maps() {
1653	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2150	[
1654	or return;	2151	map {
1655
1656	my @paths;
1657
1658	for (@$files) {
1659	utf8::decode $_;	2152	utf8::decode $_;
1660	next if /\.pst$/;	2153	/\.map$/
1661	next unless /^$PATH_SEP/o;	2154	? normalise $_
1662		2155	: ()
1663	push @paths, cf::map::normalise $_;	2156	} @{ aio_readdir $UNIQUEDIR or [] }
1664	}	2157	]
1665
1666	\@paths
1667	}	2158	}
1668		2159
1669	package cf;	2160	package cf;
1670		2161
1671	=back	2162	=back
…		…
1717		2208
1718	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719		2210
1720	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1721	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1722	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $dialog = $pl->{npc_dialog};
		2219	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2220
		2221	} else {
1723	$msg = $npc->name . " says: $msg" if $npc;	2222	$msg = $npc->name . " says: $msg" if $npc;
1724	$self->message ($msg, $flags);	2223	$self->message ($msg, $flags);
		2224	}
1725	}	2225	}
		2226	}
		2227
		2228	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2229
		2230	=cut
		2231
		2232	sub cf::object::send_msg {
		2233	my $pl = shift->contr
		2234	or return;
		2235	$pl->send_msg (@_);
1726	}	2236	}
1727		2237
1728	=item $player_object->may ("access")	2238	=item $player_object->may ("access")
1729		2239
1730	Returns wether the given player is authorized to access resource "access"	2240	Returns wether the given player is authorized to access resource "access"
…		…
1777	$self->deactivate_recursive;	2287	$self->deactivate_recursive;
1778		2288
1779	return if UNIVERSAL::isa $self->map, "ext::map_link";	2289	return if UNIVERSAL::isa $self->map, "ext::map_link";
1780		2290
1781	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2291	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782	if $self->map;	2292	if $self->map && $self->map->{path} ne "{link}";
1783		2293
1784	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2294	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1785	}	2295	}
1786		2296
1787	sub cf::object::player::leave_link {	2297	sub cf::object::player::leave_link {
1788	my ($self, $map, $x, $y) = @_;	2298	my ($self, $map, $x, $y) = @_;
		2299
		2300	return unless $self->contr->active;
1789		2301
1790	my $link_pos = delete $self->{_link_pos};	2302	my $link_pos = delete $self->{_link_pos};
1791		2303
1792	unless ($map) {	2304	unless ($map) {
1793	# restore original map position	2305	# restore original map position
…		…
1807	# use -1 or undef as default coordinates, not 0, 0	2319	# use -1 or undef as default coordinates, not 0, 0
1808	($x, $y) = ($map->enter_x, $map->enter_y)	2320	($x, $y) = ($map->enter_x, $map->enter_y)
1809	if $x <=0 && $y <= 0;	2321	if $x <=0 && $y <= 0;
1810		2322
1811	$map->load;	2323	$map->load;
1812	$map->load_diag;	2324	$map->load_neighbours;
1813		2325
1814	return unless $self->contr->active;	2326	return unless $self->contr->active;
1815	$self->activate_recursive;	2327	$self->activate_recursive;
		2328
		2329	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816	$self->enter_map ($map, $x, $y);	2330	$self->enter_map ($map, $x, $y);
1817	}	2331	}
1818		2332
1819	cf::player->attach (	2333	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1820	on_logout => sub {
1821	my ($pl) = @_;
1822		2334
1823	# abort map switching before logout	2335	Moves the player to the given map-path and coordinates by first freezing
1824	if ($pl->ob->{_link_pos}) {	2336	her, loading and preparing them map, calling the provided $check callback
1825	cf::sync_job {	2337	that has to return the map if sucecssful, and then unfreezes the player on
1826	$pl->ob->leave_link	2338	the new (success) or old (failed) map position. In either case, $done will
1827	};	2339	be called at the end of this process.
1828	}
1829	},
1830	on_login => sub {
1831	my ($pl) = @_;
1832		2340
1833	# try to abort aborted map switching on player login :)
1834	# should happen only on crashes
1835	if ($pl->ob->{_link_pos}) {
1836	$pl->ob->enter_link;
1837	(async {
1838	# we need this sleep as the login has a concurrent enter_exit running
1839	# and this sleep increases chances of the player not ending up in scorn
1840	$pl->ob->reply (undef,
1841	"There was an internal problem at your last logout, "
1842	. "the server will try to bring you to your intended destination in a second.",
1843	cf::NDI_RED);
1844	Coro::Timer::sleep 1;
1845	$pl->ob->leave_link;
1846	})->prio (2);
1847	}
1848	},
1849	);
1850
1851	=item $player_object->goto ($path, $x, $y)
1852
1853	=cut	2341	=cut
		2342
		2343	our $GOTOGEN;
1854		2344
1855	sub cf::object::player::goto {	2345	sub cf::object::player::goto {
1856	my ($self, $path, $x, $y) = @_;	2346	my ($self, $path, $x, $y, $check, $done) = @_;
		2347
		2348	# do generation counting so two concurrent goto's will be executed in-order
		2349	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857		2350
1858	$self->enter_link;	2351	$self->enter_link;
1859		2352
1860	(async {	2353	(async {
1861	my $map = eval {	2354	my $map = eval {
1862	my $map = cf::map::find $path;	2355	my $map = cf::map::find $path;
		2356
		2357	if ($map) {
1863	$map = $map->customise_for ($self) if $map;	2358	$map = $map->customise_for ($self);
		2359	$map = $check->($map) if $check && $map;
		2360	} else {
		2361	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2362	}
		2363
1864	$map	2364	$map
		2365	};
		2366
		2367	if ($@) {
		2368	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	LOG llevError | logBacktrace, Carp::longmess $@;
1865	} or	2370	}
1866	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867		2371
		2372	if ($gen == $self->{_goto_generation}) {
		2373	delete $self->{_goto_generation};
1868	$self->leave_link ($map, $x, $y);	2374	$self->leave_link ($map, $x, $y);
		2375	}
		2376
		2377	$done->() if $done;
1869	})->prio (1);	2378	})->prio (1);
1870	}	2379	}
1871		2380
1872	=item $player_object->enter_exit ($exit_object)	2381	=item $player_object->enter_exit ($exit_object)
1873		2382
…		…
1912		2421
1913	$rmp->{random_seed} ||= $exit->random_seed;	2422	$rmp->{random_seed} ||= $exit->random_seed;
1914		2423
1915	my $data = cf::to_json $rmp;	2424	my $data = cf::to_json $rmp;
1916	my $md5 = Digest::MD5::md5_hex $data;	2425	my $md5 = Digest::MD5::md5_hex $data;
1917	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2426	my $meta = "$RANDOMDIR/$md5.meta";
1918		2427
1919	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2428	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920	aio_write $fh, 0, (length $data), $data, 0;	2429	aio_write $fh, 0, (length $data), $data, 0;
1921	undef $fh;	2430	undef $fh;
1922	aio_rename "$meta~", $meta;	2431	aio_rename "$meta~", $meta;
…		…
1931		2440
1932	return unless $self->type == cf::PLAYER;	2441	return unless $self->type == cf::PLAYER;
1933		2442
1934	if ($exit->slaying eq "/!") {	2443	if ($exit->slaying eq "/!") {
1935	#TODO: this should de-fi-ni-te-ly not be a sync-job	2444	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2445	# the problem is that $exit might not survive long enough
		2446	# so it needs to be done right now, right here
1936	cf::sync_job { prepare_random_map $exit };	2447	cf::sync_job { prepare_random_map $exit };
1937	}	2448	}
1938		2449
1939	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2450	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940	my $hp = $exit->stats->hp;	2451	my $hp = $exit->stats->hp;
1941	my $sp = $exit->stats->sp;	2452	my $sp = $exit->stats->sp;
1942		2453
1943	$self->enter_link;	2454	$self->enter_link;
		2455
		2456	# if exit is damned, update players death & WoR home-position
		2457	$self->contr->savebed ($slaying, $hp, $sp)
		2458	if $exit->flag (FLAG_DAMNED);
1944		2459
1945	(async {	2460	(async {
1946	$self->deactivate_recursive; # just to be sure	2461	$self->deactivate_recursive; # just to be sure
1947	unless (eval {	2462	unless (eval {
1948	$self->goto ($slaying, $hp, $sp);	2463	$self->goto ($slaying, $hp, $sp);
1949		2464
1950	1;	2465	1;
1951	}) {	2466	}) {
1952	$self->message ("Something went wrong deep within the crossfire server. "	2467	$self->message ("Something went wrong deep within the crossfire server. "
1953	. "I'll try to bring you back to the map you were before. "	2468	. "I'll try to bring you back to the map you were before. "
1954	. "Please report this to the dungeon master!",	2469	. "Please report this to the dungeon master!",
1955	cf::NDI_UNIQUE | cf::NDI_RED);	2470	cf::NDI_UNIQUE | cf::NDI_RED);
1956		2471
1957	warn "ERROR in enter_exit: $@";	2472	warn "ERROR in enter_exit: $@";
1958	$self->leave_link;	2473	$self->leave_link;
1959	}	2474	}
1960	})->prio (1);	2475	})->prio (1);
…		…
1973		2488
1974	sub cf::client::send_drawinfo {	2489	sub cf::client::send_drawinfo {
1975	my ($self, $text, $flags) = @_;	2490	my ($self, $text, $flags) = @_;
1976		2491
1977	utf8::encode $text;	2492	utf8::encode $text;
1978	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2493	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979	}	2494	}
1980		2495
		2496	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2497
		2498	Send a drawinfo or msg packet to the client, formatting the msg for the
		2499	client if neccessary. C<$type> should be a string identifying the type of
		2500	the message, with C<log> being the default. If C<$color> is negative, suppress
		2501	the message unless the client supports the msg packet.
		2502
		2503	=cut
		2504
		2505	sub cf::client::send_msg {
		2506	my ($self, $channel, $msg, $color, @extra) = @_;
		2507
		2508	$msg = $self->pl->expand_cfpod ($msg);
		2509
		2510	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2511
		2512	if (ref $channel) {
		2513	# send meta info to client, if not yet sent
		2514	unless (exists $self->{channel}{$channel->{id}}) {
		2515	$self->{channel}{$channel->{id}} = $channel;
		2516	$self->ext_msg (channel_info => $channel);
		2517	}
		2518
		2519	$channel = $channel->{id};
		2520	}
		2521
		2522	return unless @extra || length $msg;
		2523
		2524	if ($self->can_msg) {
		2525	# default colour, mask it out
		2526	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2527	if $color & cf::NDI_DEF;
		2528
		2529	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2530	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2531	} else {
		2532	if ($color >= 0) {
		2533	# replace some tags by gcfclient-compatible ones
		2534	for ($msg) {
		2535	1 while
		2536	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2537	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2538	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2539	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2540	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2541	}
		2542
		2543	$color &= cf::NDI_COLOR_MASK;
		2544
		2545	utf8::encode $msg;
		2546
		2547	if (0 && $msg =~ /\[/) {
		2548	# COMMAND/INFO
		2549	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2550	} else {
		2551	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2552	$self->send_packet ("drawinfo $color $msg")
		2553	}
		2554	}
		2555	}
		2556	}
		2557
		2558	=item $client->ext_msg ($type, @msg)
		2559
		2560	Sends an ext event to the client.
		2561
		2562	=cut
		2563
		2564	sub cf::client::ext_msg($$@) {
		2565	my ($self, $type, @msg) = @_;
		2566
		2567	if ($self->extcmd == 2) {
		2568	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2569	} elsif ($self->extcmd == 1) { # TODO: remove
		2570	push @msg, msgtype => "event_$type";
		2571	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2572	}
		2573	}
		2574
		2575	=item $client->ext_reply ($msgid, @msg)
		2576
		2577	Sends an ext reply to the client.
		2578
		2579	=cut
		2580
		2581	sub cf::client::ext_reply($$@) {
		2582	my ($self, $id, @msg) = @_;
		2583
		2584	if ($self->extcmd == 2) {
		2585	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2586	} elsif ($self->extcmd == 1) {
		2587	#TODO: version 1, remove
		2588	unshift @msg, msgtype => "reply", msgid => $id;
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2590	}
		2591	}
1981		2592
1982	=item $success = $client->query ($flags, "text", \&cb)	2593	=item $success = $client->query ($flags, "text", \&cb)
1983		2594
1984	Queues a query to the client, calling the given callback with	2595	Queues a query to the client, calling the given callback with
1985	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2596	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1986	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2597	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987		2598
1988	Queries can fail, so check the return code. Or don't, as queries will become	2599	Queries can fail, so check the return code. Or don't, as queries will
1989	reliable at some point in the future.	2600	become reliable at some point in the future.
1990		2601
1991	=cut	2602	=cut
1992		2603
1993	sub cf::client::query {	2604	sub cf::client::query {
1994	my ($self, $flags, $text, $cb) = @_;	2605	my ($self, $flags, $text, $cb) = @_;
…		…
2002	utf8::encode $text;	2613	utf8::encode $text;
2003	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2614	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004		2615
2005	$self->send_packet ($self->{query_queue}[0][0])	2616	$self->send_packet ($self->{query_queue}[0][0])
2006	if @{ $self->{query_queue} } == 1;	2617	if @{ $self->{query_queue} } == 1;
		2618
		2619	1
2007	}	2620	}
2008		2621
2009	cf::client->attach (	2622	cf::client->attach (
		2623	on_connect => sub {
		2624	my ($ns) = @_;
		2625
		2626	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2627	},
2010	on_reply => sub {	2628	on_reply => sub {
2011	my ($ns, $msg) = @_;	2629	my ($ns, $msg) = @_;
2012		2630
2013	# this weird shuffling is so that direct followup queries	2631	# this weird shuffling is so that direct followup queries
2014	# get handled first	2632	# get handled first
…		…
2026	} else {	2644	} else {
2027	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2645	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028	}	2646	}
2029	}	2647	}
2030	},	2648	},
		2649	on_exticmd => sub {
		2650	my ($ns, $buf) = @_;
		2651
		2652	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2653
		2654	if (ref $msg) {
		2655	my ($type, $reply, @payload) =
		2656	"ARRAY" eq ref $msg
		2657	? @$msg
		2658	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2659
		2660	my @reply;
		2661
		2662	if (my $cb = $EXTICMD{$type}) {
		2663	@reply = $cb->($ns, @payload);
		2664	}
		2665
		2666	$ns->ext_reply ($reply, @reply)
		2667	if $reply;
		2668
		2669	} else {
		2670	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2671	}
		2672
		2673	cf::override;
		2674	},
2031	);	2675	);
2032		2676
2033	=item $client->async (\&cb)	2677	=item $client->async (\&cb)
2034		2678
2035	Create a new coroutine, running the specified callback. The coroutine will	2679	Create a new coroutine, running the specified callback. The coroutine will
…		…
2076	our $safe = new Safe "safe";	2720	our $safe = new Safe "safe";
2077	our $safe_hole = new Safe::Hole;	2721	our $safe_hole = new Safe::Hole;
2078		2722
2079	$SIG{FPE} = 'IGNORE';	2723	$SIG{FPE} = 'IGNORE';
2080		2724
2081	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2725	$safe->permit_only (Opcode::opset qw(
		2726	:base_core :base_mem :base_orig :base_math
		2727	grepstart grepwhile mapstart mapwhile
		2728	sort time
		2729	));
2082		2730
2083	# here we export the classes and methods available to script code	2731	# here we export the classes and methods available to script code
2084		2732
2085	=pod	2733	=pod
2086		2734
2087	The following fucntions and emthods are available within a safe environment:	2735	The following functions and methods are available within a safe environment:
2088		2736
2089	cf::object contr pay_amount pay_player map	2737	cf::object
		2738	contr pay_amount pay_player map x y force_find force_add
		2739	insert remove name archname title slaying race decrease_ob_nr
		2740
2090	cf::object::player player	2741	cf::object::player
2091	cf::player peaceful	2742	player
2092	cf::map trigger	2743
		2744	cf::player
		2745	peaceful
		2746
		2747	cf::map
		2748	trigger
2093		2749
2094	=cut	2750	=cut
2095		2751
2096	for (	2752	for (
2097	["cf::object" => qw(contr pay_amount pay_player map)],	2753	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2754	insert remove inv name archname title slaying race
		2755	decrease_ob_nr)],
2098	["cf::object::player" => qw(player)],	2756	["cf::object::player" => qw(player)],
2099	["cf::player" => qw(peaceful)],	2757	["cf::player" => qw(peaceful)],
2100	["cf::map" => qw(trigger)],	2758	["cf::map" => qw(trigger)],
2101	) {	2759	) {
2102	no strict 'refs';	2760	no strict 'refs';
…		…
2173	=back	2831	=back
2174		2832
2175	=cut	2833	=cut
2176		2834
2177	#############################################################################	2835	#############################################################################
2178
2179	=head2 EXTENSION DATABASE SUPPORT
2180
2181	Crossfire maintains a very simple database for extension use. It can
2182	currently store anything that can be serialised using Storable, which
2183	excludes objects.
2184
2185	The parameter C<$family> should best start with the name of the extension
2186	using it, it should be unique.
2187
2188	=over 4
2189
2190	=item $value = cf::db_get $family => $key
2191
2192	Returns a single value from the database.
2193
2194	=item cf::db_put $family => $key => $value
2195
2196	Stores the given C<$value> in the family.
2197
2198	=cut
2199
2200	our $DB;
2201
2202	sub db_load() {
2203	unless ($DB) {
2204	$DB = BDB::db_create $DB_ENV;
2205
2206	cf::sync_job {
2207	eval {
2208	$DB->set_flags (BDB::CHKSUM);
2209
2210	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2211	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2212	cf::cleanup "db_open(db): $!" if $!;
2213	};
2214	cf::cleanup "db_open(db): $@" if $@;
2215	};
2216
2217	my $path = cf::localdir . "/database.pst";
2218	if (stat $path) {
2219	cf::sync_job {
2220	my $pst = Storable::retrieve $path;
2221
2222	cf::db_put (board => data => $pst->{board});
2223	cf::db_put (guildrules => data => $pst->{guildrules});
2224	cf::db_put (rent => balance => $pst->{rent}{balance});
2225	BDB::db_env_txn_checkpoint $DB_ENV;
2226
2227	unlink $path;
2228	};
2229	}
2230	}
2231	}
2232
2233	sub db_get($$) {
2234	my $key = "$_[0]/$_[1]";
2235
2236	cf::sync_job {
2237	BDB::db_get $DB, undef, $key, my $data;
2238
2239	$! ? ()
2240	: Compress::LZF::sthaw $data
2241	}
2242	}
2243
2244	sub db_put($$$) {
2245	BDB::dbreq_pri 4;
2246	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2247	}
2248
2249	#############################################################################
2250	# the server's init and main functions	2836	# the server's init and main functions
2251		2837
2252	sub load_resources {	2838	sub load_facedata($) {
2253	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2839	my ($path) = @_;
		2840
		2841	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		2842
		2843	warn "loading facedata from $path\n";
		2844
		2845	my $facedata;
		2846	0 < aio_load $path, $facedata
		2847	or die "$path: $!";
		2848
		2849	$facedata = Coro::Storable::thaw $facedata;
		2850
		2851	$facedata->{version} == 2
		2852	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2853
		2854	# patch in the exptable
		2855	$facedata->{resource}{"res/exp_table"} = {
		2856	type => FT_RSRC,
		2857	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2858	};
		2859	cf::cede_to_tick;
		2860
		2861	{
		2862	my $faces = $facedata->{faceinfo};
		2863
		2864	while (my ($face, $info) = each %$faces) {
		2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
		2868	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2869	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2870
		2871	cf::cede_to_tick;
		2872	}
		2873
		2874	while (my ($face, $info) = each %$faces) {
		2875	next unless $info->{smooth};
		2876	my $idx = cf::face::find $face
		2877	or next;
		2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
		2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2881	} else {
		2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2883	}
		2884
		2885	cf::cede_to_tick;
		2886	}
		2887	}
		2888
		2889	{
		2890	my $anims = $facedata->{animinfo};
		2891
		2892	while (my ($anim, $info) = each %$anims) {
		2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2894	cf::cede_to_tick;
		2895	}
		2896
		2897	cf::anim::invalidate_all; # d'oh
		2898	}
		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904
		2905	my $soundconf = delete $res->{"res/sound.conf"};
		2906
		2907	while (my ($name, $info) = each %$res) {
		2908	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2909	my $data;
		2910
		2911	if ($info->{type} & 1) {
		2912	# prepend meta info
		2913
		2914	my $meta = $enc->encode ({
		2915	name => $name,
		2916	%{ $info->{meta} || {} },
		2917	});
		2918
		2919	$data = pack "(w/a*)*", $meta, $info->{data};
		2920	} else {
		2921	$data = $info->{data};
		2922	}
		2923
		2924	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2925	cf::face::set_type $idx, $info->{type};
		2926
		2927	cf::cede_to_tick;
		2928	}
		2929
		2930	if ($soundconf) {
		2931	$soundconf = $enc->decode (delete $soundconf->{data});
		2932
		2933	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2934	my $sound = $soundconf->{compat}[$_]
		2935	or next;
		2936
		2937	my $face = cf::face::find "sound/$sound->[1]";
		2938	cf::sound::set $sound->[0] => $face;
		2939	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2940	}
		2941
		2942	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2943	my $face = cf::face::find "sound/$v";
		2944	cf::sound::set $k => $face;
		2945	}
		2946	}
		2947	}
		2948
		2949	1
		2950	}
		2951
		2952	register_exticmd fx_want => sub {
		2953	my ($ns, $want) = @_;
		2954
		2955	while (my ($k, $v) = each %$want) {
		2956	$ns->fx_want ($k, $v);
		2957	}
		2958	};
		2959
		2960	sub reload_regions {
		2961	load_resource_file "$MAPDIR/regions"
2254	or die "unable to load regions file\n";#d#	2962	or die "unable to load regions file\n";
2255	}
2256		2963
2257	sub cfg_load {	2964	for (cf::region::list) {
		2965	$_->{match} = qr/$_->{match}/
		2966	if exists $_->{match};
		2967	}
		2968	}
		2969
		2970	sub reload_facedata {
		2971	load_facedata "$DATADIR/facedata"
		2972	or die "unable to load facedata\n";
		2973	}
		2974
		2975	sub reload_archetypes {
		2976	load_resource_file "$DATADIR/archetypes"
		2977	or die "unable to load archetypes\n";
		2978	#d# NEED to laod twice to resolve forward references
		2979	# this really needs to be done in an extra post-pass
		2980	# (which needs to be synchronous, so solve it differently)
		2981	load_resource_file "$DATADIR/archetypes"
		2982	or die "unable to load archetypes\n";
		2983	}
		2984
		2985	sub reload_treasures {
		2986	load_resource_file "$DATADIR/treasures"
		2987	or die "unable to load treasurelists\n";
		2988	}
		2989
		2990	sub reload_resources {
		2991	warn "reloading resource files...\n";
		2992
		2993	reload_regions;
		2994	reload_facedata;
		2995	#reload_archetypes;#d#
		2996	reload_archetypes;
		2997	reload_treasures;
		2998
		2999	warn "finished reloading resource files\n";
		3000	}
		3001
		3002	sub init {
		3003	reload_resources;
		3004	}
		3005
		3006	sub reload_config {
2258	open my $fh, "<:utf8", cf::confdir . "/config"	3007	open my $fh, "<:utf8", "$CONFDIR/config"
2259	or return;	3008	or return;
2260		3009
2261	local $/;	3010	local $/;
2262	*CFG = YAML::Syck::Load <$fh>;	3011	*CFG = YAML::Syck::Load <$fh>;
2263		3012
…		…
2271	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3020	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2272	and die "WARNING: m(un)lockall failed: $!\n";	3021	and die "WARNING: m(un)lockall failed: $!\n";
2273	};	3022	};
2274	warn $@ if $@;	3023	warn $@ if $@;
2275	}	3024	}
2276	}
2277
2278	sub init {
2279	load_resources;
2280	}	3025	}
2281		3026
2282	sub main {	3027	sub main {
2283	# we must not ever block the main coroutine	3028	# we must not ever block the main coroutine
2284	local $Coro::idle = sub {	3029	local $Coro::idle = sub {
…		…
2286	(async {	3031	(async {
2287	Event::one_event;	3032	Event::one_event;
2288	})->prio (Coro::PRIO_MAX);	3033	})->prio (Coro::PRIO_MAX);
2289	};	3034	};
2290		3035
2291	cfg_load;	3036	reload_config;
2292	db_load;	3037	db_init;
2293	load_extensions;	3038	load_extensions;
2294		3039
2295	$TICK_WATCHER->start;	3040	$TICK_WATCHER->start;
2296	Event::loop;	3041	Event::loop;
2297	}	3042	}
…		…
2312	},	3057	},
2313	);	3058	);
2314	}	3059	}
2315	}	3060	}
2316		3061
		3062	sub write_runtime {
		3063	my $runtime = "$LOCALDIR/runtime";
		3064
		3065	# first touch the runtime file to show we are still running:
		3066	# the fsync below can take a very very long time.
		3067
		3068	IO::AIO::aio_utime $runtime, undef, undef;
		3069
		3070	my $guard = cf::lock_acquire "write_runtime";
		3071
		3072	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3073	or return;
		3074
		3075	my $value = $cf::RUNTIME + 90 + 10;
		3076	# 10 is the runtime save interval, for a monotonic clock
		3077	# 60 allows for the watchdog to kill the server.
		3078
		3079	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3080	and return;
		3081
		3082	# always fsync - this file is important
		3083	aio_fsync $fh
		3084	and return;
		3085
		3086	# touch it again to show we are up-to-date
		3087	aio_utime $fh, undef, undef;
		3088
		3089	close $fh
		3090	or return;
		3091
		3092	aio_rename "$runtime~", $runtime
		3093	and return;
		3094
		3095	warn "runtime file written.\n";
		3096
		3097	1
		3098	}
		3099
2317	sub emergency_save() {	3100	sub emergency_save() {
2318	my $freeze_guard = cf::freeze_mainloop;	3101	my $freeze_guard = cf::freeze_mainloop;
2319		3102
2320	warn "enter emergency perl save\n";	3103	warn "enter emergency perl save\n";
2321		3104
…		…
2345	};	3128	};
2346		3129
2347	warn "leave emergency perl save\n";	3130	warn "leave emergency perl save\n";
2348	}	3131	}
2349		3132
		3133	sub post_cleanup {
		3134	my ($make_core) = @_;
		3135
		3136	warn Carp::longmess "post_cleanup backtrace"
		3137	if $make_core;
		3138	}
		3139
2350	sub reload() {	3140	sub do_reload_perl() {
2351	# can/must only be called in main	3141	# can/must only be called in main
2352	if ($Coro::current != $Coro::main) {	3142	if ($Coro::current != $Coro::main) {
2353	warn "can only reload from main coroutine";	3143	warn "can only reload from main coroutine";
2354	return;	3144	return;
2355	}	3145	}
2356		3146
2357	warn "reloading...";	3147	warn "reloading...";
2358		3148
2359	warn "cancelling server ticker";	3149	warn "entering sync_job";
2360	$TICK_WATCHER->cancel;
2361		3150
		3151	cf::sync_job {
		3152	cf::write_runtime; # external watchdog should not bark
2362	cf::emergency_save;	3153	cf::emergency_save;
		3154	cf::write_runtime; # external watchdog should not bark
2363		3155
2364	eval {	3156	warn "syncing database to disk";
		3157	BDB::db_env_txn_checkpoint $DB_ENV;
		3158
2365	# if anything goes wrong in here, we should simply crash as we already saved	3159	# if anything goes wrong in here, we should simply crash as we already saved
2366		3160
2367	warn "cancelling all WF_AUTOCANCEL watchers";	3161	warn "cancelling all WF_AUTOCANCEL watchers";
2368	for (Event::all_watchers) {	3162	for (Event::all_watchers) {
2369	$_->cancel if $_->data & WF_AUTOCANCEL;	3163	$_->cancel if $_->data & WF_AUTOCANCEL;
2370	}	3164	}
2371
2372	warn "syncing database to disk";
2373	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2374		3165
2375	warn "flushing outstanding aio requests";	3166	warn "flushing outstanding aio requests";
2376	for (;;) {	3167	for (;;) {
2377	BDB::flush;	3168	BDB::flush;
2378	IO::AIO::flush;	3169	IO::AIO::flush;
2379	Coro::cede;	3170	Coro::cede;
2380	last unless IO::AIO::nreqs || BDB::nreqs;	3171	last unless IO::AIO::nreqs || BDB::nreqs;
2381	warn "iterate...";	3172	warn "iterate...";
2382	}	3173	}
2383		3174
		3175	++$RELOAD;
		3176
2384	warn "cancelling all extension coros";	3177	warn "cancelling all extension coros";
2385	$_->cancel for values %EXT_CORO;	3178	$_->cancel for values %EXT_CORO;
2386	%EXT_CORO = ();	3179	%EXT_CORO = ();
2387		3180
2388	warn "removing commands";	3181	warn "removing commands";
2389	%COMMAND = ();	3182	%COMMAND = ();
2390		3183
2391	warn "removing ext commands";	3184	warn "removing ext/exti commands";
2392	%EXTCMD = ();	3185	%EXTCMD = ();
		3186	%EXTICMD = ();
2393		3187
2394	warn "unloading/nuking all extensions";	3188	warn "unloading/nuking all extensions";
2395	for my $pkg (@EXTS) {	3189	for my $pkg (@EXTS) {
2396	warn "... unloading $pkg";	3190	warn "... unloading $pkg";
2397		3191
…		…
2427	Symbol::delete_package "safe::$_"	3221	Symbol::delete_package "safe::$_"
2428	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3222	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2429		3223
2430	warn "unloading cf.pm \"a bit\"";	3224	warn "unloading cf.pm \"a bit\"";
2431	delete $INC{"cf.pm"};	3225	delete $INC{"cf.pm"};
		3226	delete $INC{"cf/pod.pm"};
2432		3227
2433	# don't, removes xs symbols, too,	3228	# don't, removes xs symbols, too,
2434	# and global variables created in xs	3229	# and global variables created in xs
2435	#Symbol::delete_package __PACKAGE__;	3230	#Symbol::delete_package __PACKAGE__;
2436		3231
…		…
2439	warn "reloading cf.pm";	3234	warn "reloading cf.pm";
2440	require cf;	3235	require cf;
2441	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3236	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2442		3237
2443	warn "loading config and database again";	3238	warn "loading config and database again";
2444	cf::cfg_load;	3239	cf::reload_config;
2445	cf::db_load;
2446		3240
2447	warn "loading extensions";	3241	warn "loading extensions";
2448	cf::load_extensions;	3242	cf::load_extensions;
2449		3243
2450	warn "reattaching attachments to objects/players";	3244	warn "reattaching attachments to objects/players";
2451	_global_reattach;	3245	_global_reattach; # objects, sockets
2452	warn "reattaching attachments to maps";	3246	warn "reattaching attachments to maps";
2453	reattach $_ for values %MAP;	3247	reattach $_ for values %MAP;
		3248	warn "reattaching attachments to players";
		3249	reattach $_ for values %PLAYER;
2454		3250
2455	warn "loading reloadable resources";	3251	warn "leaving sync_job";
2456	load_resources;
2457		3252
2458	warn "restarting server ticker";	3253	1
2459		3254	} or do {
2460	$TICK_WATCHER->start;
2461	};
2462
2463	if ($@) {
2464	warn $@;	3255	warn $@;
2465	warn "error while reloading, exiting.";	3256	warn "error while reloading, exiting.";
2466	exit 1;	3257	exit 1;
2467	}	3258	};
2468		3259
2469	warn "reloaded";	3260	warn "reloaded";
2470	};	3261	};
2471		3262
2472	our $RELOAD_WATCHER; # used only during reload	3263	our $RELOAD_WATCHER; # used only during reload
2473		3264
		3265	sub reload_perl() {
		3266	# doing reload synchronously and two reloads happen back-to-back,
		3267	# coro crashes during coro_state_free->destroy here.
		3268
		3269	$RELOAD_WATCHER ||= Event->timer (
		3270	reentrant => 0,
		3271	after => 0,
		3272	data => WF_AUTOCANCEL,
		3273	cb => sub {
		3274	do_reload_perl;
		3275	undef $RELOAD_WATCHER;
		3276	},
		3277	);
		3278	}
		3279
2474	register_command "reload" => sub {	3280	register_command "reload" => sub {
2475	my ($who, $arg) = @_;	3281	my ($who, $arg) = @_;
2476		3282
2477	if ($who->flag (FLAG_WIZ)) {	3283	if ($who->flag (FLAG_WIZ)) {
2478	$who->message ("reloading server.");	3284	$who->message ("reloading server.");
2479		3285	async { reload_perl };
2480	# doing reload synchronously and two reloads happen back-to-back,
2481	# coro crashes during coro_state_free->destroy here.
2482
2483	$RELOAD_WATCHER ||= Event->timer (
2484	reentrant => 0,
2485	after => 0,
2486	data => WF_AUTOCANCEL,
2487	cb => sub {
2488	reload;
2489	undef $RELOAD_WATCHER;
2490	},
2491	);
2492	}	3286	}
2493	};	3287	};
2494		3288
2495	unshift @INC, $LIBDIR;	3289	unshift @INC, $LIBDIR;
2496		3290
2497	my $bug_warning = 0;	3291	my $bug_warning = 0;
2498		3292
		3293	our @WAIT_FOR_TICK;
		3294	our @WAIT_FOR_TICK_BEGIN;
		3295
		3296	sub wait_for_tick {
		3297	return unless $TICK_WATCHER->is_active;
		3298	return if $Coro::current == $Coro::main;
		3299
		3300	my $signal = new Coro::Signal;
		3301	push @WAIT_FOR_TICK, $signal;
		3302	$signal->wait;
		3303	}
		3304
		3305	sub wait_for_tick_begin {
		3306	return unless $TICK_WATCHER->is_active;
		3307	return if $Coro::current == $Coro::main;
		3308
		3309	my $signal = new Coro::Signal;
		3310	push @WAIT_FOR_TICK_BEGIN, $signal;
		3311	$signal->wait;
		3312	}
		3313
		3314	my $min = 1e6;#d#
		3315	my $avg = 10;
2499	$TICK_WATCHER = Event->timer (	3316	$TICK_WATCHER = Event->timer (
2500	reentrant => 0,	3317	reentrant => 0,
2501	parked => 1,	3318	parked => 1,
2502	prio => 0,	3319	prio => 0,
2503	at => $NEXT_TICK || $TICK,	3320	at => $NEXT_TICK || $TICK,
…		…
2507	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3324	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508	unless ++$bug_warning > 10;	3325	unless ++$bug_warning > 10;
2509	return;	3326	return;
2510	}	3327	}
2511		3328
2512	$NOW = Event::time;	3329	$NOW = $tick_start = Event::time;
2513		3330
2514	cf::server_tick; # one server iteration	3331	cf::server_tick; # one server iteration
		3332
		3333	0 && sync_job {#d#
		3334	for(1..10) {
		3335	my $t = Event::time;
		3336	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3337	or die;
		3338
		3339	$map->width (50);
		3340	$map->height (50);
		3341	$map->alloc;
		3342	$map->_load_objects ("/tmp/x.map", 1);
		3343	my $t = Event::time - $t;
		3344
		3345	#next unless $t < 0.0013;#d#
		3346	if ($t < $min) {
		3347	$min = $t;
		3348	}
		3349	$avg = $avg * 0.99 + $t * 0.01;
		3350	}
		3351	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3352	exit 0;
		3353	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3354	};
		3355
2515	$RUNTIME += $TICK;	3356	$RUNTIME += $TICK;
2516	$NEXT_TICK += $TICK;	3357	$NEXT_TICK += $TICK;
2517		3358
2518	$WAIT_FOR_TICK->broadcast;	3359	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3360	$NEXT_RUNTIME_WRITE = $NOW + 10;
2520		3361	Coro::async_pool {
2521	Event::sweep;	3362	write_runtime
2522	Coro::cede_notself;	3363	or warn "ERROR: unable to write runtime file: $!";
		3364	};
2523		3365	}
		3366
2524	# my $AFTER = Event::time;	3367	# my $AFTER = Event::time;
2525	# warn $AFTER - $NOW;#d#	3368	# warn $AFTER - $NOW;#d#
2526		3369
		3370	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3371	$sig->send;
		3372	}
		3373	while (my $sig = shift @WAIT_FOR_TICK) {
		3374	$sig->send;
		3375	}
		3376
		3377	$NOW = Event::time;
		3378
2527	# if we are delayed by four ticks or more, skip them all	3379	# if we are delayed by four ticks or more, skip them all
2528	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3380	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2529		3381
2530	$TICK_WATCHER->at ($NEXT_TICK);	3382	$TICK_WATCHER->at ($NEXT_TICK);
2531	$TICK_WATCHER->start;	3383	$TICK_WATCHER->start;
		3384
		3385	$LOAD = ($NOW - $tick_start) / $TICK;
		3386	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3387
		3388	_post_tick;
		3389
		3390
2532	},	3391	},
2533	);	3392	);
2534		3393
2535	{	3394	{
2536	BDB::max_poll_time $TICK * 0.1;	3395	BDB::max_poll_time $TICK * 0.1;
…		…
2564		3423
2565	cf::sync_job {	3424	cf::sync_job {
2566	eval {	3425	eval {
2567	BDB::db_env_open	3426	BDB::db_env_open
2568	$DB_ENV,	3427	$DB_ENV,
2569	$BDB_ENV_DIR,	3428	$BDBDIR,
2570	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3429	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2571	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3430	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2572	0666;	3431	0666;
2573		3432
2574	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3433	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2575		3434
2576	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3435	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2577	$DB_ENV->set_lk_detect;	3436	$DB_ENV->set_lk_detect;
2578	};	3437	};
2579		3438
…		…
2587		3446
2588	undef $Coro::AIO::WATCHER;	3447	undef $Coro::AIO::WATCHER;
2589	IO::AIO::max_poll_time $TICK * 0.1;	3448	IO::AIO::max_poll_time $TICK * 0.1;
2590	$AIO_POLL_WATCHER = Event->io (	3449	$AIO_POLL_WATCHER = Event->io (
2591	reentrant => 0,	3450	reentrant => 0,
		3451	data => WF_AUTOCANCEL,
2592	fd => IO::AIO::poll_fileno,	3452	fd => IO::AIO::poll_fileno,
2593	poll => 'r',	3453	poll => 'r',
2594	prio => 6,	3454	prio => 6,
2595	data => WF_AUTOCANCEL,
2596	cb => \&IO::AIO::poll_cb,	3455	cb => \&IO::AIO::poll_cb,
2597	);	3456	);
2598	}	3457	}
2599		3458
2600	$WRITE_RUNTIME_WATCHER = Event->timer (	3459	my $_log_backtrace;
2601	reentrant => 0,	3460
2602	data => WF_AUTOCANCEL,	3461	sub _log_backtrace {
2603	after => 1,	3462	my ($msg, @addr) = @_;
2604	interval => 10,	3463
2605	prio => 6, # keep it lowest so it acts like a watchdog	3464	$msg =~ s/\n//;
2606	cb => Coro::unblock_sub {	3465
2607	write_runtime	3466	# limit the # of concurrent backtraces
2608	or warn "ERROR: unable to write runtime file: $!";	3467	if ($_log_backtrace < 2) {
		3468	++$_log_backtrace;
		3469	async {
		3470	my @bt = fork_call {
		3471	@addr = map { sprintf "%x", $_ } @addr;
		3472	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3473	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3474	or die "addr2line: $!";
		3475
		3476	my @funcs;
		3477	my @res = <$fh>;
		3478	chomp for @res;
		3479	while (@res) {
		3480	my ($func, $line) = splice @res, 0, 2, ();
		3481	push @funcs, "[$func] $line";
		3482	}
		3483
		3484	@funcs
		3485	};
		3486
		3487	LOG llevInfo, "[ABT] $msg\n";
		3488	LOG llevInfo, "[ABT] $_\n" for @bt;
		3489	--$_log_backtrace;
		3490	};
		3491	} else {
		3492	LOG llevInfo, "[ABT] $msg\n";
		3493	LOG llevInfo, "[ABT] [suppressed]\n";
2609	},	3494	}
2610	);	3495	}
		3496
		3497	# load additional modules
		3498	use cf::pod;
2611		3499
2612	END { cf::emergency_save }	3500	END { cf::emergency_save }
2613		3501
2614	1	3502	1
2615		3503

Diff Legend

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