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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.352 by root, Sun Sep 2 04:57:14 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	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362		473
363	my $runtime = cf::localdir . "/runtime";	474	Executes the given code block with the given arguments in a seperate
		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.
364		478
365	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	=cut
366	or return;
367		480
368	my $value = $cf::RUNTIME + 90 + 10;	481	sub fork_call(&@) {
369	# 10 is the runtime save interval, for a monotonic clock	482	my ($cb, @args) = @_;
370	# 60 allows for the watchdog to kill the server.
371		483
372	(aio_write $fh, 0, (length $value), $value, 0) <= 0	484	# we seemingly have to make a local copy of the whole thing,
373	and return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
374		487
375	# always fsync - this file is important	488	my @res = Coro::Util::fork_eval {
376	aio_fsync $fh	489	reset_signals;
377	and return;	490	&$cb
		491	}, @args;
378		492
379	close $fh	493	wantarray ? @res : $res[-1]
380	or return;	494	}
381		495
382	aio_rename "$runtime~", $runtime	496	=item $value = cf::db_get $family => $key
383	and return;
384		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	};
385	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 });
386	}	621	}
387		622
388	=back	623	=back
389		624
390	=cut	625	=cut
…		…
397	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")
398	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
399		634
400	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>
401	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
402	crossfire+).	637	Crossfire TRT).
403		638
404	=over 4	639	=over 4
405		640
406	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
407		642
…		…
570	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
571		806
572	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
573	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
574	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
575	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576		811
577	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
578	my $pkg = shift @arg;	813	my $pkg = shift @arg;
579		814
580	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
609	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
610	}	845	}
611		846
612	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
613	} else {	848	} else {
614	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
615	}	850	}
616		851
617	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
618	}	853	}
619		854
…		…
621	if (ref $_[0]) {	856	if (ref $_[0]) {
622	_object_attach @_;	857	_object_attach @_;
623	} else {	858	} else {
624	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
625	}	860	}
		861	_recalc_want;
626	};	862	};
627		863
628	# all those should be optimised	864	# all those should be optimised
629	sub cf::attachable::detach {	865	sub cf::attachable::detach {
630	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
633	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
634	reattach ($obj);	870	reattach ($obj);
635	} else {	871	} else {
636	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
637	}	873	}
		874	_recalc_want;
638	};	875	};
639		876
640	sub cf::attachable::attached {	877	sub cf::attachable::attached {
641	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
642		879
…		…
657	";	894	";
658	die if $@;	895	die if $@;
659	}	896	}
660		897
661	our $override;	898	our $override;
662	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?
663		900
664	sub override {	901	sub override {
665	$override = 1;	902	$override = 1;
666	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
667	}	904	}
668		905
669	sub do_invoke {	906	sub do_invoke {
670	my $event = shift;	907	my $event = shift;
671	my $callbacks = shift;	908	my $callbacks = shift;
672		909
673	@invoke_results = ();	910	@INVOKE_RESULTS = ();
674		911
675	local $override;	912	local $override;
676		913
677	for (@$callbacks) {	914	for (@$callbacks) {
678	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
695		932
696	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
697		934
698	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
699	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
700	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
701		938
702	=back	939	=back
703		940
704	=cut	941	=cut
705		942
706	#############################################################################	943	#############################################################################
707	# 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	}
708		956
709	sub reattach {	957	sub reattach {
710	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
711	my ($obj) = @_;	959	my ($obj) = @_;
712		960
…		…
789	}	1037	}
790	} else {	1038	} else {
791	aio_unlink $filename;	1039	aio_unlink $filename;
792	aio_unlink "$filename.pst";	1040	aio_unlink "$filename.pst";
793	}	1041	}
794
795	#d##TODO# nuke non .map-files if exist
796	if ($filename =~ s/\.map$//) {
797	aio_unlink $filename;
798	aio_unlink "$filename.pst";
799	}
800	}	1042	}
801	}	1043	}
802		1044
803	sub object_freezer_as_string {	1045	sub object_freezer_as_string {
804	my ($rdata, $objs) = @_;	1046	my ($rdata, $objs) = @_;
…		…
810		1052
811	sub object_thawer_load {	1053	sub object_thawer_load {
812	my ($filename) = @_;	1054	my ($filename) = @_;
813		1055
814	my ($data, $av);	1056	my ($data, $av);
815
816	#d#TODO remove .map if file does not exist
817	aio_stat $filename and $filename =~ s/\.map$//;
818		1057
819	(aio_load $filename, $data) >= 0	1058	(aio_load $filename, $data) >= 0
820	or return;	1059	or return;
821		1060
822	unless (aio_stat "$filename.pst") {	1061	unless (aio_stat "$filename.pst") {
…		…
824	or return;	1063	or return;
825	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
826	}	1065	}
827		1066
828	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
829	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
830	return ($data, $av);	1069	return ($data, $av);
831	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
832		1077
833	#############################################################################	1078	#############################################################################
834	# command handling &c	1079	# command handling &c
835		1080
836	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
849	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
850	}	1095	}
851		1096
852	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
853		1098
854	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.
855		1104
856	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
857	called.	1106	called.
858		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
859	=cut	1119	=cut
860		1120
861	sub register_extcmd {	1121	sub register_extcmd {
862	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
863		1123
864	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
865	}	1131	}
866		1132
867	cf::player->attach (	1133	cf::player->attach (
868	on_command => sub {	1134	on_command => sub {
869	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
878	cf::override;	1144	cf::override;
879	},	1145	},
880	on_extcmd => sub {	1146	on_extcmd => sub {
881	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
882		1148
883	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884		1150
885	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
886	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
887	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
888	$pl->ext_reply ($msg->{msgid}, %reply);
889	}
890	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
891	} else {	1166	} else {
892	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
893	}	1168	}
894		1169
895	cf::override;	1170	cf::override;
896	},	1171	},
897	);	1172	);
898		1173
899	sub load_extension {
900	my ($path) = @_;
901
902	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
903	my $base = $1;
904	my $pkg = $1;
905	$pkg =~ s/[^[:word:]]/_/g;
906	$pkg = "ext::$pkg";
907
908	warn "... loading '$path' into '$pkg'\n";
909
910	open my $fh, "<:utf8", $path
911	or die "$path: $!";
912
913	my $source =
914	"package $pkg; use strict; use utf8;\n"
915	. "#line 1 \"$path\"\n{\n"
916	. (do { local $/; <$fh> })
917	. "\n};\n1";
918
919	unless (eval $source) {
920	my $msg = $@ ? "$path: $@\n"
921	: "extension disabled.\n";
922	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923	warn $@;
924	warn "mandatory extension failed to load, exiting.\n";
925	exit 1;
926	}
927	die $@;
928	}
929
930	push @EXTS, $pkg;
931	}
932
933	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
934	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
935	next unless -r $ext;	1179	next unless -r $path;
936	eval {	1180
937	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;
938	1	1238	}
939	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
940	}	1244	};
941	}	1245	}
942		1246
943	#############################################################################	1247	#############################################################################
944		1248
		1249	=back
		1250
945	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
946		1252
947	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
948		1254
949	=cut	1255	=cut
…		…
961	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
962		1268
963	=cut	1269	=cut
964		1270
965	sub playerdir($) {	1271	sub playerdir($) {
966	cf::localdir	1272	"$PLAYERDIR/"
967	. "/"
968	. cf::playerdir
969	. "/"
970	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
971	}	1274	}
972		1275
973	sub path($) {	1276	sub path($) {
974	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975		1278
976	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
977	}	1280	}
978		1281
979	sub find_active($) {	1282	sub find_active($) {
980	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
981	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
994	my $login = $_[0];	1297	my $login = $_[0];
995		1298
996	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
997		1300
998	$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
999	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
1000	or return;	1310	or return;
1001	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
1002	}	1312	}
1003	}	1313	}
…		…
1015		1325
1016	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1017	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1018		1328
1019	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1020	Coro::cede;	1330	cf::cede_to_tick;
1021	}	1331	}
1022		1332
1023	sub new($) {	1333	sub new($) {
1024	my ($login) = @_;	1334	my ($login) = @_;
1025		1335
…		…
1031	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1032		1342
1033	$self	1343	$self
1034	}	1344	}
1035		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
1036	=item $pl->quit_character	1356	=item $pl->quit_character
1037		1357
1038	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
1039	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1040		1360
1041	=cut	1361	=cut
1042		1362
1043	sub quit_character {	1363	sub quit_character {
1044	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1045		1367
1046	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1047	$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
1048		1370
1049	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1054	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1055	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1056	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1057	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1058	$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
1059	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;
1060	}	1402	}
1061		1403
1062	=item cf::player::list_logins	1404	=item cf::player::list_logins
1063		1405
1064	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
1065	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1066		1408
1067	=cut	1409	=cut
1068		1410
1069	sub list_logins {	1411	sub list_logins {
1070	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1071	or return [];	1413	or return [];
1072		1414
1073	my @logins;	1415	my @logins;
1074		1416
1075	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1110	}	1452	}
1111		1453
1112	\@paths	1454	\@paths
1113	}	1455	}
1114		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/(?<![BIUGHT])</&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	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1478	# replace G<male|female> tags
		1479	|| s{G<([^>|]*)\|([^>]*)>}{
		1480	$self->gender ? $2 : $1
		1481	}ge
		1482	# replace H<hint text>
		1483	|| s{H<([^\>]*)>}
		1484	{
		1485	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1486	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1487	"")
		1488	[$self->{hintmode}]
		1489	}ge;
		1490
		1491	# create single paragraphs (very hackish)
		1492	s/(?<=\S)\n(?=\w)/ /g;
		1493
		1494	# compress some whitespace
		1495	s/\s+\n/\n/g; # ws line-ends
		1496	s/\n\n+/\n/g; # double lines
		1497	s/^\n+//; # beginning lines
		1498	s/\n+$//; # ending lines
		1499
		1500	$_
		1501	}
		1502
		1503	sub hintmode {
		1504	$_[0]{hintmode} = $_[1] if @_ > 1;
		1505	$_[0]{hintmode}
		1506	}
		1507
1115	=item $player->ext_reply ($msgid, $msgtype, %msg)	1508	=item $player->ext_reply ($msgid, @msg)
1116		1509
1117	Sends an ext reply to the player.	1510	Sends an ext reply to the player.
1118		1511
1119	=cut	1512	=cut
1120		1513
1121	sub ext_reply($$$%) {	1514	sub ext_reply($$@) {
1122	my ($self, $id, %msg) = @_;	1515	my ($self, $id, @msg) = @_;
1123		1516
1124	$msg{msgid} = $id;	1517	$self->ns->ext_reply ($id, @msg)
1125
1126	$self->send ("ext " . cf::to_json \%msg);
1127	}	1518	}
1128		1519
1129	package cf;	1520	=item $player->ext_msg ($type, @msg)
		1521
		1522	Sends an ext event to the client.
		1523
		1524	=cut
		1525
		1526	sub ext_msg($$@) {
		1527	my ($self, $type, @msg) = @_;
		1528
		1529	$self->ns->ext_msg ($type, @msg);
		1530	}
		1531
		1532	=head3 cf::region
		1533
		1534	=over 4
		1535
		1536	=cut
		1537
		1538	package cf::region;
		1539
		1540	=item cf::region::find_by_path $path
		1541
		1542	Tries to decuce the likely region for a map knowing only its path.
		1543
		1544	=cut
		1545
		1546	sub find_by_path($) {
		1547	my ($path) = @_;
		1548
		1549	my ($match, $specificity);
		1550
		1551	for my $region (list) {
		1552	if ($region->{match} && $path =~ $region->{match}) {
		1553	($match, $specificity) = ($region, $region->specificity)
		1554	if $region->specificity > $specificity;
		1555	}
		1556	}
		1557
		1558	$match
		1559	}
1130		1560
1131	=back	1561	=back
1132
1133		1562
1134	=head3 cf::map	1563	=head3 cf::map
1135		1564
1136	=over 4	1565	=over 4
1137		1566
…		…
1192	my ($self, $merge) = @_;	1621	my ($self, $merge) = @_;
1193		1622
1194	# we have to keep some variables in memory intact	1623	# we have to keep some variables in memory intact
1195	local $self->{path};	1624	local $self->{path};
1196	local $self->{load_path};	1625	local $self->{load_path};
1197	local $self->{deny_save};
1198	local $self->{deny_reset};
1199		1626
1200	$self->SUPER::thawer_merge ($merge);	1627	$self->SUPER::thawer_merge ($merge);
1201	}	1628	}
1202		1629
1203	sub normalise {	1630	sub normalise {
…		…
1250	$self->init; # pass $1 etc.	1677	$self->init; # pass $1 etc.
1251	return $self;	1678	return $self;
1252	}	1679	}
1253	}	1680	}
1254		1681
1255	Carp::carp "unable to resolve path '$path' (base '$base').";	1682	Carp::cluck "unable to resolve path '$path' (base '$base').";
1256	()	1683	()
1257	}	1684	}
1258		1685
1259	sub init {	1686	sub init {
1260	my ($self) = @_;	1687	my ($self) = @_;
…		…
1275		1702
1276	# the original (read-only) location	1703	# the original (read-only) location
1277	sub load_path {	1704	sub load_path {
1278	my ($self) = @_;	1705	my ($self) = @_;
1279		1706
1280	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1707	"$MAPDIR/$self->{path}.map"
1281	}	1708	}
1282		1709
1283	# the temporary/swap location	1710	# the temporary/swap location
1284	sub save_path {	1711	sub save_path {
1285	my ($self) = @_;	1712	my ($self) = @_;
1286		1713
1287	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1714	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1715	"$TMPDIR/$path.map"
1289	}	1716	}
1290		1717
1291	# the unique path, undef == no special unique path	1718	# the unique path, undef == no special unique path
1292	sub uniq_path {	1719	sub uniq_path {
1293	my ($self) = @_;	1720	my ($self) = @_;
1294		1721
1295	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1722	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1723	"$UNIQUEDIR/$path"
1297	}	1724	}
1298		1725
1299	# and all this just because we cannot iterate over	1726	# and all this just because we cannot iterate over
1300	# all maps in C++...	1727	# all maps in C++...
1301	sub change_all_map_light {	1728	sub change_all_map_light {
…		…
1303		1730
1304	$_->change_map_light ($change)	1731	$_->change_map_light ($change)
1305	for grep $_->outdoor, values %cf::MAP;	1732	for grep $_->outdoor, values %cf::MAP;
1306	}	1733	}
1307		1734
		1735	sub decay_objects {
		1736	my ($self) = @_;
		1737
		1738	return if $self->{deny_reset};
		1739
		1740	$self->do_decay_objects;
		1741	}
		1742
1308	sub unlink_save {	1743	sub unlink_save {
1309	my ($self) = @_;	1744	my ($self) = @_;
1310		1745
1311	utf8::encode (my $save = $self->save_path);	1746	utf8::encode (my $save = $self->save_path);
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1748	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315	#d#TODO remove .map and also nuke
1316	$save =~ s/\.map// or return;#d#
1317	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319	}	1749	}
1320		1750
1321	sub load_header_from($) {	1751	sub load_header_from($) {
1322	my ($self, $path) = @_;	1752	my ($self, $path) = @_;
1323		1753
…		…
1373	$self->load_header_orig	1803	$self->load_header_orig
1374	or return;	1804	or return;
1375	$self->prepare_orig;	1805	$self->prepare_orig;
1376	}	1806	}
1377		1807
		1808	$self->{deny_reset} = 1
		1809	if $self->no_reset;
		1810
		1811	$self->default_region (cf::region::find_by_path $self->{path})
		1812	unless $self->default_region;
		1813
1378	1	1814	1
1379	}	1815	}
1380		1816
1381	sub find;	1817	sub find;
1382	sub find {	1818	sub find {
…		…
1394	$map->{last_save} = $cf::RUNTIME;	1830	$map->{last_save} = $cf::RUNTIME;
1395		1831
1396	$map->load_header	1832	$map->load_header
1397	or return;	1833	or return;
1398		1834
1399	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1835	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400	# doing this can freeze the server in a sync job, obviously	1836	# doing this can freeze the server in a sync job, obviously
1401	#$cf::WAIT_FOR_TICK->wait;	1837	#$cf::WAIT_FOR_TICK->wait;
1402	$map->reset;	1838	$map->reset;
1403	undef $guard;	1839	undef $guard;
1404	return find $path;	1840	return find $path;
…		…
1415	my ($self) = @_;	1851	my ($self) = @_;
1416		1852
1417	local $self->{deny_reset} = 1; # loading can take a long time	1853	local $self->{deny_reset} = 1; # loading can take a long time
1418		1854
1419	my $path = $self->{path};	1855	my $path = $self->{path};
		1856
		1857	{
		1858	my $guard1 = cf::lock_acquire "map_data:$path";
1420	my $guard = cf::lock_acquire "map_load:$path";	1859	my $guard2 = cf::lock_acquire "map_load:$path";
1421		1860
1422	return if $self->in_memory != cf::MAP_SWAPPED;	1861	return if $self->in_memory != cf::MAP_SWAPPED;
1423		1862
1424	$self->in_memory (cf::MAP_LOADING);	1863	$self->in_memory (cf::MAP_LOADING);
1425		1864
1426	$self->alloc;	1865	$self->alloc;
1427		1866
1428	$self->pre_load;	1867	$self->pre_load;
		1868	cf::cede_to_tick;
1429		1869
1430	$self->_load_objects ($self->{load_path}, 1)	1870	$self->_load_objects ($self->{load_path}, 1)
1431	or return;	1871	or return;
1432		1872
1433	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1873	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434	if delete $self->{load_original};	1874	if delete $self->{load_original};
1435		1875
1436	if (my $uniq = $self->uniq_path) {	1876	if (my $uniq = $self->uniq_path) {
1437	utf8::encode $uniq;	1877	utf8::encode $uniq;
1438	if (aio_open $uniq, O_RDONLY, 0) {	1878	if (aio_open $uniq, O_RDONLY, 0) {
1439	$self->clear_unique_items;	1879	$self->clear_unique_items;
1440	$self->_load_objects ($uniq, 0);	1880	$self->_load_objects ($uniq, 0);
1441	}	1881	}
1442	}	1882	}
1443		1883
1444	Coro::cede;	1884	cf::cede_to_tick;
1445
1446	# now do the right thing for maps	1885	# now do the right thing for maps
1447	$self->link_multipart_objects;	1886	$self->link_multipart_objects;
1448
1449	unless ($self->{deny_activate}) {
1450	$self->decay_objects;
1451	$self->fix_auto_apply;
1452	$self->update_buttons;
1453	Coro::cede;
1454	$self->set_darkness_map;
1455	$self->difficulty ($self->estimate_difficulty)	1887	$self->difficulty ($self->estimate_difficulty)
1456	unless $self->difficulty;	1888	unless $self->difficulty;
1457	Coro::cede;	1889	cf::cede_to_tick;
		1890
		1891	unless ($self->{deny_activate}) {
		1892	$self->decay_objects;
		1893	$self->fix_auto_apply;
		1894	$self->update_buttons;
		1895	cf::cede_to_tick;
		1896	$self->set_darkness_map;
		1897	cf::cede_to_tick;
1458	$self->activate;	1898	$self->activate;
		1899	}
		1900
		1901	$self->{last_save} = $cf::RUNTIME;
		1902	$self->last_access ($cf::RUNTIME);
		1903
		1904	$self->in_memory (cf::MAP_IN_MEMORY);
1459	}	1905	}
1460		1906
1461	$self->post_load;	1907	$self->post_load;
1462
1463	$self->in_memory (cf::MAP_IN_MEMORY);
1464	}	1908	}
1465		1909
1466	sub customise_for {	1910	sub customise_for {
1467	my ($self, $ob) = @_;	1911	my ($self, $ob) = @_;
1468		1912
1469	return find "~" . $ob->name . "/" . $self->{path}	1913	return find "~" . $ob->name . "/" . $self->{path}
1470	if $self->per_player;	1914	if $self->per_player;
1471		1915
		1916	# return find "?party/" . $ob->name . "/" . $self->{path}
		1917	# if $self->per_party;
		1918
1472	$self	1919	$self
1473	}	1920	}
1474		1921
1475	# find and load all maps in the 3x3 area around a map	1922	# find and load all maps in the 3x3 area around a map
1476	sub load_diag {	1923	sub load_neighbours {
1477	my ($map) = @_;	1924	my ($map) = @_;
1478		1925
1479	my @diag; # diagonal neighbours	1926	my @neigh; # diagonal neighbours
1480		1927
1481	for (0 .. 3) {	1928	for (0 .. 3) {
1482	my $neigh = $map->tile_path ($_)	1929	my $neigh = $map->tile_path ($_)
1483	or next;	1930	or next;
1484	$neigh = find $neigh, $map	1931	$neigh = find $neigh, $map
1485	or next;	1932	or next;
1486	$neigh->load;	1933	$neigh->load;
1487		1934
		1935	push @neigh,
1488	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1936	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1489	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1937	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1490	}	1938	}
1491		1939
1492	for (@diag) {	1940	for (grep defined $_->[0], @neigh) {
		1941	my ($path, $origin) = @$_;
1493	my $neigh = find @$_	1942	my $neigh = find $path, $origin
1494	or next;	1943	or next;
1495	$neigh->load;	1944	$neigh->load;
1496	}	1945	}
1497	}	1946	}
1498		1947
…		…
1503	}	1952	}
1504		1953
1505	sub do_load_sync {	1954	sub do_load_sync {
1506	my ($map) = @_;	1955	my ($map) = @_;
1507		1956
		1957	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1958	if $Coro::current == $Coro::main;
		1959
1508	cf::sync_job { $map->load };	1960	cf::sync_job { $map->load };
1509	}	1961	}
1510		1962
1511	our %MAP_PREFETCH;	1963	our %MAP_PREFETCH;
1512	our $MAP_PREFETCHER = undef;	1964	our $MAP_PREFETCHER = undef;
1513		1965
1514	sub find_async {	1966	sub find_async {
1515	my ($path, $origin) = @_;	1967	my ($path, $origin, $load) = @_;
1516		1968
1517	$path = normalise $path, $origin && $origin->{path};	1969	$path = normalise $path, $origin && $origin->{path};
1518		1970
1519	if (my $map = $cf::MAP{$path}) {	1971	if (my $map = $cf::MAP{$path}) {
1520	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1972	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1521	}	1973	}
1522		1974
1523	undef $MAP_PREFETCH{$path};	1975	$MAP_PREFETCH{$path} |= $load;
		1976
1524	$MAP_PREFETCHER ||= cf::async {	1977	$MAP_PREFETCHER ||= cf::async {
1525	while (%MAP_PREFETCH) {	1978	while (%MAP_PREFETCH) {
1526	for my $path (keys %MAP_PREFETCH) {	1979	while (my ($k, $v) = each %MAP_PREFETCH) {
1527	my $map = find $path	1980	if (my $map = find $k) {
1528	or next;
1529	$map->load;	1981	$map->load if $v;
		1982	}
1530		1983
1531	delete $MAP_PREFETCH{$path};	1984	delete $MAP_PREFETCH{$k};
1532	}	1985	}
1533	}	1986	}
1534	undef $MAP_PREFETCHER;	1987	undef $MAP_PREFETCHER;
1535	};	1988	};
1536	$MAP_PREFETCHER->prio (6);	1989	$MAP_PREFETCHER->prio (6);
…		…
1539	}	1992	}
1540		1993
1541	sub save {	1994	sub save {
1542	my ($self) = @_;	1995	my ($self) = @_;
1543		1996
1544	my $lock = cf::lock_acquire "map_data:" . $self->path;	1997	my $lock = cf::lock_acquire "map_data:$self->{path}";
1545		1998
1546	$self->{last_save} = $cf::RUNTIME;	1999	$self->{last_save} = $cf::RUNTIME;
1547		2000
1548	return unless $self->dirty;	2001	return unless $self->dirty;
1549		2002
…		…
1572	my ($self) = @_;	2025	my ($self) = @_;
1573		2026
1574	# save first because save cedes	2027	# save first because save cedes
1575	$self->save;	2028	$self->save;
1576		2029
1577	my $lock = cf::lock_acquire "map_data:" . $self->path;	2030	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2031
1579	return if $self->players;	2032	return if $self->players;
1580	return if $self->in_memory != cf::MAP_IN_MEMORY;	2033	return if $self->in_memory != cf::MAP_IN_MEMORY;
1581	return if $self->{deny_save};	2034	return if $self->{deny_save};
1582		2035
…		…
1586		2039
1587	sub reset_at {	2040	sub reset_at {
1588	my ($self) = @_;	2041	my ($self) = @_;
1589		2042
1590	# TODO: safety, remove and allow resettable per-player maps	2043	# TODO: safety, remove and allow resettable per-player maps
1591	return 1e99 if $self->isa ("ext::map_per_player");#d#
1592	return 1e99 if $self->{deny_reset};	2044	return 1e99 if $self->{deny_reset};
1593		2045
1594	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2046	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2047	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1596		2048
…		…
1607	my ($self) = @_;	2059	my ($self) = @_;
1608		2060
1609	my $lock = cf::lock_acquire "map_data:$self->{path}";	2061	my $lock = cf::lock_acquire "map_data:$self->{path}";
1610		2062
1611	return if $self->players;	2063	return if $self->players;
1612	return if $self->isa ("ext::map_per_player");#d#
1613		2064
1614	warn "resetting map ", $self->path;#d#	2065	warn "resetting map ", $self->path;
1615		2066
1616	$self->in_memory (cf::MAP_SWAPPED);	2067	$self->in_memory (cf::MAP_SWAPPED);
1617		2068
1618	# need to save uniques path	2069	# need to save uniques path
1619	unless ($self->{deny_save}) {	2070	unless ($self->{deny_save}) {
…		…
1636	my $nuke_counter = "aaaa";	2087	my $nuke_counter = "aaaa";
1637		2088
1638	sub nuke {	2089	sub nuke {
1639	my ($self) = @_;	2090	my ($self) = @_;
1640		2091
		2092	{
		2093	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2094
1641	delete $cf::MAP{$self->path};	2095	delete $cf::MAP{$self->path};
1642		2096
1643	$self->unlink_save;	2097	$self->unlink_save;
1644		2098
1645	bless $self, "cf::map";	2099	bless $self, "cf::map";
1646	delete $self->{deny_reset};	2100	delete $self->{deny_reset};
1647	$self->{deny_save} = 1;	2101	$self->{deny_save} = 1;
1648	$self->reset_timeout (1);	2102	$self->reset_timeout (1);
1649	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2103	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1650		2104
1651	$cf::MAP{$self->path} = $self;	2105	$cf::MAP{$self->path} = $self;
		2106	}
1652		2107
1653	$self->reset; # polite request, might not happen	2108	$self->reset; # polite request, might not happen
		2109	}
		2110
		2111	=item $maps = cf::map::tmp_maps
		2112
		2113	Returns an arrayref with all map paths of currently instantiated and saved
		2114	maps. May block.
		2115
		2116	=cut
		2117
		2118	sub tmp_maps() {
		2119	[
		2120	map {
		2121	utf8::decode $_;
		2122	/\.map$/
		2123	? normalise $_
		2124	: ()
		2125	} @{ aio_readdir $TMPDIR or [] }
		2126	]
		2127	}
		2128
		2129	=item $maps = cf::map::random_maps
		2130
		2131	Returns an arrayref with all map paths of currently instantiated and saved
		2132	random maps. May block.
		2133
		2134	=cut
		2135
		2136	sub random_maps() {
		2137	[
		2138	map {
		2139	utf8::decode $_;
		2140	/\.map$/
		2141	? normalise "?random/$_"
		2142	: ()
		2143	} @{ aio_readdir $RANDOMDIR or [] }
		2144	]
1654	}	2145	}
1655		2146
1656	=item cf::map::unique_maps	2147	=item cf::map::unique_maps
1657		2148
1658	Returns an arrayref of paths of all shared maps that have	2149	Returns an arrayref of paths of all shared maps that have
1659	instantiated unique items. May block.	2150	instantiated unique items. May block.
1660		2151
1661	=cut	2152	=cut
1662		2153
1663	sub unique_maps() {	2154	sub unique_maps() {
1664	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2155	[
1665	or return;	2156	map {
1666
1667	my @paths;
1668
1669	for (@$files) {
1670	utf8::decode $_;	2157	utf8::decode $_;
1671	next if /\.pst$/;	2158	/\.map$/
1672	next unless /^$PATH_SEP/o;	2159	? normalise $_
1673		2160	: ()
1674	push @paths, cf::map::normalise $_;	2161	} @{ aio_readdir $UNIQUEDIR or [] }
1675	}	2162	]
1676
1677	\@paths
1678	}	2163	}
1679		2164
1680	package cf;	2165	package cf;
1681		2166
1682	=back	2167	=back
…		…
1728		2213
1729	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2214	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730		2215
1731	if ($self->{record_replies}) {	2216	if ($self->{record_replies}) {
1732	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2217	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2218
1733	} else {	2219	} else {
		2220	my $pl = $self->contr;
		2221
		2222	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2223	my $dialog = $pl->{npc_dialog};
		2224	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2225
		2226	} else {
1734	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1735	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1736	}	2230	}
		2231	}
		2232
		2233	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2234
		2235	=cut
		2236
		2237	sub cf::object::send_msg {
		2238	my $pl = shift->contr
		2239	or return;
		2240	$pl->send_msg (@_);
1737	}	2241	}
1738		2242
1739	=item $player_object->may ("access")	2243	=item $player_object->may ("access")
1740		2244
1741	Returns wether the given player is authorized to access resource "access"	2245	Returns wether the given player is authorized to access resource "access"
…		…
1788	$self->deactivate_recursive;	2292	$self->deactivate_recursive;
1789		2293
1790	return if UNIVERSAL::isa $self->map, "ext::map_link";	2294	return if UNIVERSAL::isa $self->map, "ext::map_link";
1791		2295
1792	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2296	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793	if $self->map;	2297	if $self->map && $self->map->{path} ne "{link}";
1794		2298
1795	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2299	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1796	}	2300	}
1797		2301
1798	sub cf::object::player::leave_link {	2302	sub cf::object::player::leave_link {
1799	my ($self, $map, $x, $y) = @_;	2303	my ($self, $map, $x, $y) = @_;
		2304
		2305	return unless $self->contr->active;
1800		2306
1801	my $link_pos = delete $self->{_link_pos};	2307	my $link_pos = delete $self->{_link_pos};
1802		2308
1803	unless ($map) {	2309	unless ($map) {
1804	# restore original map position	2310	# restore original map position
…		…
1818	# use -1 or undef as default coordinates, not 0, 0	2324	# use -1 or undef as default coordinates, not 0, 0
1819	($x, $y) = ($map->enter_x, $map->enter_y)	2325	($x, $y) = ($map->enter_x, $map->enter_y)
1820	if $x <=0 && $y <= 0;	2326	if $x <=0 && $y <= 0;
1821		2327
1822	$map->load;	2328	$map->load;
1823	$map->load_diag;	2329	$map->load_neighbours;
1824		2330
1825	return unless $self->contr->active;	2331	return unless $self->contr->active;
1826	$self->activate_recursive;	2332	$self->activate_recursive;
		2333
		2334	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827	$self->enter_map ($map, $x, $y);	2335	$self->enter_map ($map, $x, $y);
1828	}	2336	}
1829		2337
1830	cf::player->attach (	2338	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831	on_logout => sub {
1832	my ($pl) = @_;
1833		2339
1834	# abort map switching before logout	2340	Moves the player to the given map-path and coordinates by first freezing
1835	if ($pl->ob->{_link_pos}) {	2341	her, loading and preparing them map, calling the provided $check callback
1836	cf::sync_job {	2342	that has to return the map if sucecssful, and then unfreezes the player on
1837	$pl->ob->leave_link	2343	the new (success) or old (failed) map position. In either case, $done will
1838	};	2344	be called at the end of this process.
1839	}
1840	},
1841	on_login => sub {
1842	my ($pl) = @_;
1843		2345
1844	# try to abort aborted map switching on player login :)
1845	# should happen only on crashes
1846	if ($pl->ob->{_link_pos}) {
1847	$pl->ob->enter_link;
1848	(async {
1849	# we need this sleep as the login has a concurrent enter_exit running
1850	# and this sleep increases chances of the player not ending up in scorn
1851	$pl->ob->reply (undef,
1852	"There was an internal problem at your last logout, "
1853	. "the server will try to bring you to your intended destination in a second.",
1854	cf::NDI_RED);
1855	Coro::Timer::sleep 1;
1856	$pl->ob->leave_link;
1857	})->prio (2);
1858	}
1859	},
1860	);
1861
1862	=item $player_object->goto ($path, $x, $y)
1863
1864	=cut	2346	=cut
		2347
		2348	our $GOTOGEN;
1865		2349
1866	sub cf::object::player::goto {	2350	sub cf::object::player::goto {
1867	my ($self, $path, $x, $y) = @_;	2351	my ($self, $path, $x, $y, $check, $done) = @_;
		2352
		2353	# do generation counting so two concurrent goto's will be executed in-order
		2354	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868		2355
1869	$self->enter_link;	2356	$self->enter_link;
1870		2357
1871	(async {	2358	(async {
1872	my $map = eval {	2359	my $map = eval {
1873	my $map = cf::map::find $path;	2360	my $map = cf::map::find $path;
		2361
		2362	if ($map) {
1874	$map = $map->customise_for ($self) if $map;	2363	$map = $map->customise_for ($self);
		2364	$map = $check->($map) if $check && $map;
		2365	} else {
		2366	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2367	}
		2368
1875	$map	2369	$map
		2370	};
		2371
		2372	if ($@) {
		2373	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2374	LOG llevError | logBacktrace, Carp::longmess $@;
1876	} or	2375	}
1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878		2376
		2377	if ($gen == $self->{_goto_generation}) {
		2378	delete $self->{_goto_generation};
1879	$self->leave_link ($map, $x, $y);	2379	$self->leave_link ($map, $x, $y);
		2380	}
		2381
		2382	$done->() if $done;
1880	})->prio (1);	2383	})->prio (1);
1881	}	2384	}
1882		2385
1883	=item $player_object->enter_exit ($exit_object)	2386	=item $player_object->enter_exit ($exit_object)
1884		2387
…		…
1923		2426
1924	$rmp->{random_seed} ||= $exit->random_seed;	2427	$rmp->{random_seed} ||= $exit->random_seed;
1925		2428
1926	my $data = cf::to_json $rmp;	2429	my $data = cf::to_json $rmp;
1927	my $md5 = Digest::MD5::md5_hex $data;	2430	my $md5 = Digest::MD5::md5_hex $data;
1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2431	my $meta = "$RANDOMDIR/$md5.meta";
1929		2432
1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2433	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931	aio_write $fh, 0, (length $data), $data, 0;	2434	aio_write $fh, 0, (length $data), $data, 0;
1932	undef $fh;	2435	undef $fh;
1933	aio_rename "$meta~", $meta;	2436	aio_rename "$meta~", $meta;
…		…
1942		2445
1943	return unless $self->type == cf::PLAYER;	2446	return unless $self->type == cf::PLAYER;
1944		2447
1945	if ($exit->slaying eq "/!") {	2448	if ($exit->slaying eq "/!") {
1946	#TODO: this should de-fi-ni-te-ly not be a sync-job	2449	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2450	# the problem is that $exit might not survive long enough
		2451	# so it needs to be done right now, right here
1947	cf::sync_job { prepare_random_map $exit };	2452	cf::sync_job { prepare_random_map $exit };
1948	}	2453	}
1949		2454
1950	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2455	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951	my $hp = $exit->stats->hp;	2456	my $hp = $exit->stats->hp;
1952	my $sp = $exit->stats->sp;	2457	my $sp = $exit->stats->sp;
1953		2458
1954	$self->enter_link;	2459	$self->enter_link;
		2460
		2461	# if exit is damned, update players death & WoR home-position
		2462	$self->contr->savebed ($slaying, $hp, $sp)
		2463	if $exit->flag (FLAG_DAMNED);
1955		2464
1956	(async {	2465	(async {
1957	$self->deactivate_recursive; # just to be sure	2466	$self->deactivate_recursive; # just to be sure
1958	unless (eval {	2467	unless (eval {
1959	$self->goto ($slaying, $hp, $sp);	2468	$self->goto ($slaying, $hp, $sp);
1960		2469
1961	1;	2470	1;
1962	}) {	2471	}) {
1963	$self->message ("Something went wrong deep within the crossfire server. "	2472	$self->message ("Something went wrong deep within the crossfire server. "
1964	. "I'll try to bring you back to the map you were before. "	2473	. "I'll try to bring you back to the map you were before. "
1965	. "Please report this to the dungeon master!",	2474	. "Please report this to the dungeon master!",
1966	cf::NDI_UNIQUE | cf::NDI_RED);	2475	cf::NDI_UNIQUE | cf::NDI_RED);
1967		2476
1968	warn "ERROR in enter_exit: $@";	2477	warn "ERROR in enter_exit: $@";
1969	$self->leave_link;	2478	$self->leave_link;
1970	}	2479	}
1971	})->prio (1);	2480	})->prio (1);
…		…
1984		2493
1985	sub cf::client::send_drawinfo {	2494	sub cf::client::send_drawinfo {
1986	my ($self, $text, $flags) = @_;	2495	my ($self, $text, $flags) = @_;
1987		2496
1988	utf8::encode $text;	2497	utf8::encode $text;
1989	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2498	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990	}	2499	}
1991		2500
		2501	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2502
		2503	Send a drawinfo or msg packet to the client, formatting the msg for the
		2504	client if neccessary. C<$type> should be a string identifying the type of
		2505	the message, with C<log> being the default. If C<$color> is negative, suppress
		2506	the message unless the client supports the msg packet.
		2507
		2508	=cut
		2509
		2510	our %CHANNEL = (
		2511	"c/identify" => {
		2512	id => "identify",
		2513	title => "Identify",
		2514	reply => undef,
		2515	tooltip => "Items recently identified",
		2516	},
		2517	"c/examine" => {
		2518	id => "examine",
		2519	title => "Examine",
		2520	reply => undef,
		2521	tooltip => "Signs and other items you examined",
		2522	},
		2523	);
		2524
		2525	sub cf::client::send_msg {
		2526	my ($self, $channel, $msg, $color, @extra) = @_;
		2527
		2528	$msg = $self->pl->expand_cfpod ($msg);
		2529
		2530	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2531
		2532	# check predefined channels, for the benefit of C
		2533	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2534
		2535	if (ref $channel) {
		2536	# send meta info to client, if not yet sent
		2537	unless (exists $self->{channel}{$channel->{id}}) {
		2538	$self->{channel}{$channel->{id}} = $channel;
		2539	$self->ext_msg (channel_info => $channel);
		2540	}
		2541
		2542	$channel = $channel->{id};
		2543	}
		2544
		2545	return unless @extra || length $msg;
		2546
		2547	if ($self->can_msg) {
		2548	# default colour, mask it out
		2549	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2550	if $color & cf::NDI_DEF;
		2551
		2552	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2553	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2554	} else {
		2555	if ($color >= 0) {
		2556	# replace some tags by gcfclient-compatible ones
		2557	for ($msg) {
		2558	1 while
		2559	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2560	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2561	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2562	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2563	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2564	}
		2565
		2566	$color &= cf::NDI_COLOR_MASK;
		2567
		2568	utf8::encode $msg;
		2569
		2570	if (0 && $msg =~ /\[/) {
		2571	# COMMAND/INFO
		2572	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2573	} else {
		2574	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2575	$self->send_packet ("drawinfo $color $msg")
		2576	}
		2577	}
		2578	}
		2579	}
		2580
		2581	=item $client->ext_msg ($type, @msg)
		2582
		2583	Sends an ext event to the client.
		2584
		2585	=cut
		2586
		2587	sub cf::client::ext_msg($$@) {
		2588	my ($self, $type, @msg) = @_;
		2589
		2590	if ($self->extcmd == 2) {
		2591	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2592	} elsif ($self->extcmd == 1) { # TODO: remove
		2593	push @msg, msgtype => "event_$type";
		2594	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2595	}
		2596	}
		2597
		2598	=item $client->ext_reply ($msgid, @msg)
		2599
		2600	Sends an ext reply to the client.
		2601
		2602	=cut
		2603
		2604	sub cf::client::ext_reply($$@) {
		2605	my ($self, $id, @msg) = @_;
		2606
		2607	if ($self->extcmd == 2) {
		2608	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2609	} elsif ($self->extcmd == 1) {
		2610	#TODO: version 1, remove
		2611	unshift @msg, msgtype => "reply", msgid => $id;
		2612	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2613	}
		2614	}
1992		2615
1993	=item $success = $client->query ($flags, "text", \&cb)	2616	=item $success = $client->query ($flags, "text", \&cb)
1994		2617
1995	Queues a query to the client, calling the given callback with	2618	Queues a query to the client, calling the given callback with
1996	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2619	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2620	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998		2621
1999	Queries can fail, so check the return code. Or don't, as queries will become	2622	Queries can fail, so check the return code. Or don't, as queries will
2000	reliable at some point in the future.	2623	become reliable at some point in the future.
2001		2624
2002	=cut	2625	=cut
2003		2626
2004	sub cf::client::query {	2627	sub cf::client::query {
2005	my ($self, $flags, $text, $cb) = @_;	2628	my ($self, $flags, $text, $cb) = @_;
…		…
2013	utf8::encode $text;	2636	utf8::encode $text;
2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2637	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015		2638
2016	$self->send_packet ($self->{query_queue}[0][0])	2639	$self->send_packet ($self->{query_queue}[0][0])
2017	if @{ $self->{query_queue} } == 1;	2640	if @{ $self->{query_queue} } == 1;
		2641
		2642	1
2018	}	2643	}
2019		2644
2020	cf::client->attach (	2645	cf::client->attach (
		2646	on_connect => sub {
		2647	my ($ns) = @_;
		2648
		2649	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2650	},
2021	on_reply => sub {	2651	on_reply => sub {
2022	my ($ns, $msg) = @_;	2652	my ($ns, $msg) = @_;
2023		2653
2024	# this weird shuffling is so that direct followup queries	2654	# this weird shuffling is so that direct followup queries
2025	# get handled first	2655	# get handled first
…		…
2037	} else {	2667	} else {
2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2668	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039	}	2669	}
2040	}	2670	}
2041	},	2671	},
		2672	on_exticmd => sub {
		2673	my ($ns, $buf) = @_;
		2674
		2675	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2676
		2677	if (ref $msg) {
		2678	my ($type, $reply, @payload) =
		2679	"ARRAY" eq ref $msg
		2680	? @$msg
		2681	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2682
		2683	my @reply;
		2684
		2685	if (my $cb = $EXTICMD{$type}) {
		2686	@reply = $cb->($ns, @payload);
		2687	}
		2688
		2689	$ns->ext_reply ($reply, @reply)
		2690	if $reply;
		2691
		2692	} else {
		2693	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2694	}
		2695
		2696	cf::override;
		2697	},
2042	);	2698	);
2043		2699
2044	=item $client->async (\&cb)	2700	=item $client->async (\&cb)
2045		2701
2046	Create a new coroutine, running the specified callback. The coroutine will	2702	Create a new coroutine, running the specified callback. The coroutine will
…		…
2087	our $safe = new Safe "safe";	2743	our $safe = new Safe "safe";
2088	our $safe_hole = new Safe::Hole;	2744	our $safe_hole = new Safe::Hole;
2089		2745
2090	$SIG{FPE} = 'IGNORE';	2746	$SIG{FPE} = 'IGNORE';
2091		2747
2092	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2748	$safe->permit_only (Opcode::opset qw(
		2749	:base_core :base_mem :base_orig :base_math
		2750	grepstart grepwhile mapstart mapwhile
		2751	sort time
		2752	));
2093		2753
2094	# here we export the classes and methods available to script code	2754	# here we export the classes and methods available to script code
2095		2755
2096	=pod	2756	=pod
2097		2757
2098	The following fucntions and emthods are available within a safe environment:	2758	The following functions and methods are available within a safe environment:
2099		2759
2100	cf::object contr pay_amount pay_player map	2760	cf::object
		2761	contr pay_amount pay_player map x y force_find force_add
		2762	insert remove name archname title slaying race decrease_ob_nr
		2763
2101	cf::object::player player	2764	cf::object::player
2102	cf::player peaceful	2765	player
2103	cf::map trigger	2766
		2767	cf::player
		2768	peaceful
		2769
		2770	cf::map
		2771	trigger
2104		2772
2105	=cut	2773	=cut
2106		2774
2107	for (	2775	for (
2108	["cf::object" => qw(contr pay_amount pay_player map)],	2776	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2777	insert remove inv name archname title slaying race
		2778	decrease_ob_nr)],
2109	["cf::object::player" => qw(player)],	2779	["cf::object::player" => qw(player)],
2110	["cf::player" => qw(peaceful)],	2780	["cf::player" => qw(peaceful)],
2111	["cf::map" => qw(trigger)],	2781	["cf::map" => qw(trigger)],
2112	) {	2782	) {
2113	no strict 'refs';	2783	no strict 'refs';
…		…
2184	=back	2854	=back
2185		2855
2186	=cut	2856	=cut
2187		2857
2188	#############################################################################	2858	#############################################################################
2189
2190	=head2 EXTENSION DATABASE SUPPORT
2191
2192	Crossfire maintains a very simple database for extension use. It can
2193	currently store anything that can be serialised using Storable, which
2194	excludes objects.
2195
2196	The parameter C<$family> should best start with the name of the extension
2197	using it, it should be unique.
2198
2199	=over 4
2200
2201	=item $value = cf::db_get $family => $key
2202
2203	Returns a single value from the database.
2204
2205	=item cf::db_put $family => $key => $value
2206
2207	Stores the given C<$value> in the family.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	sub db_init {
2214	unless ($DB) {
2215	$DB = BDB::db_create $DB_ENV;
2216
2217	cf::sync_job {
2218	eval {
2219	$DB->set_flags (BDB::CHKSUM);
2220
2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223	cf::cleanup "db_open(db): $!" if $!;
2224	};
2225	cf::cleanup "db_open(db): $@" if $@;
2226	};
2227
2228	my $path = cf::localdir . "/database.pst";
2229	if (stat $path) {
2230	cf::sync_job {
2231	my $pst = Storable::retrieve $path;
2232
2233	cf::db_put (board => data => $pst->{board});
2234	cf::db_put (guildrules => data => $pst->{guildrules});
2235	cf::db_put (rent => balance => $pst->{rent}{balance});
2236	BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238	unlink $path;
2239	};
2240	}
2241	}
2242	}
2243
2244	sub db_get($$) {
2245	my $key = "$_[0]/$_[1]";
2246
2247	cf::sync_job {
2248	BDB::db_get $DB, undef, $key, my $data;
2249
2250	$! ? ()
2251	: Compress::LZF::sthaw $data
2252	}
2253	}
2254
2255	sub db_put($$$) {
2256	BDB::dbreq_pri 4;
2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258	}
2259
2260	#############################################################################
2261	# the server's init and main functions	2859	# the server's init and main functions
2262		2860
2263	sub load_resources {	2861	sub load_facedata($) {
2264	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2862	my ($path) = @_;
		2863
		2864	# HACK to clear player env face cache, we need some signal framework
		2865	# for this (global event?)
		2866	%ext::player_env::MUSIC_FACE_CACHE = ();
		2867
		2868	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		2869
		2870	warn "loading facedata from $path\n";
		2871
		2872	my $facedata;
		2873	0 < aio_load $path, $facedata
		2874	or die "$path: $!";
		2875
		2876	$facedata = Coro::Storable::thaw $facedata;
		2877
		2878	$facedata->{version} == 2
		2879	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2880
		2881	# patch in the exptable
		2882	$facedata->{resource}{"res/exp_table"} = {
		2883	type => FT_RSRC,
		2884	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2885	};
		2886	cf::cede_to_tick;
		2887
		2888	{
		2889	my $faces = $facedata->{faceinfo};
		2890
		2891	while (my ($face, $info) = each %$faces) {
		2892	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2893	cf::face::set_visibility $idx, $info->{visibility};
		2894	cf::face::set_magicmap $idx, $info->{magicmap};
		2895	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2896	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2897
		2898	cf::cede_to_tick;
		2899	}
		2900
		2901	while (my ($face, $info) = each %$faces) {
		2902	next unless $info->{smooth};
		2903	my $idx = cf::face::find $face
		2904	or next;
		2905	if (my $smooth = cf::face::find $info->{smooth}) {
		2906	cf::face::set_smooth $idx, $smooth;
		2907	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2908	} else {
		2909	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2910	}
		2911
		2912	cf::cede_to_tick;
		2913	}
		2914	}
		2915
		2916	{
		2917	my $anims = $facedata->{animinfo};
		2918
		2919	while (my ($anim, $info) = each %$anims) {
		2920	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2921	cf::cede_to_tick;
		2922	}
		2923
		2924	cf::anim::invalidate_all; # d'oh
		2925	}
		2926
		2927	{
		2928	# TODO: for gcfclient pleasure, we should give resources
		2929	# that gcfclient doesn't grok a >10000 face index.
		2930	my $res = $facedata->{resource};
		2931
		2932	my $soundconf = delete $res->{"res/sound.conf"};
		2933
		2934	while (my ($name, $info) = each %$res) {
		2935	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2936	my $data;
		2937
		2938	if ($info->{type} & 1) {
		2939	# prepend meta info
		2940
		2941	my $meta = $enc->encode ({
		2942	name => $name,
		2943	%{ $info->{meta} || {} },
		2944	});
		2945
		2946	$data = pack "(w/a*)*", $meta, $info->{data};
		2947	} else {
		2948	$data = $info->{data};
		2949	}
		2950
		2951	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2952	cf::face::set_type $idx, $info->{type};
		2953
		2954	cf::cede_to_tick;
		2955	}
		2956
		2957	if ($soundconf) {
		2958	$soundconf = $enc->decode (delete $soundconf->{data});
		2959
		2960	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2961	my $sound = $soundconf->{compat}[$_]
		2962	or next;
		2963
		2964	my $face = cf::face::find "sound/$sound->[1]";
		2965	cf::sound::set $sound->[0] => $face;
		2966	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2967	}
		2968
		2969	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2970	my $face = cf::face::find "sound/$v";
		2971	cf::sound::set $k => $face;
		2972	}
		2973	}
		2974	}
		2975
		2976	1
		2977	}
		2978
		2979	register_exticmd fx_want => sub {
		2980	my ($ns, $want) = @_;
		2981
		2982	while (my ($k, $v) = each %$want) {
		2983	$ns->fx_want ($k, $v);
		2984	}
		2985	};
		2986
		2987	sub reload_regions {
		2988	# HACK to clear player env face cache, we need some signal framework
		2989	# for this (global event?)
		2990	%ext::player_env::MUSIC_FACE_CACHE = ();
		2991
		2992	load_resource_file "$MAPDIR/regions"
2265	or die "unable to load regions file\n";#d#	2993	or die "unable to load regions file\n";
2266	}
2267		2994
2268	sub cfg_load {	2995	for (cf::region::list) {
		2996	$_->{match} = qr/$_->{match}/
		2997	if exists $_->{match};
		2998	}
		2999	}
		3000
		3001	sub reload_facedata {
		3002	load_facedata "$DATADIR/facedata"
		3003	or die "unable to load facedata\n";
		3004	}
		3005
		3006	sub reload_archetypes {
		3007	load_resource_file "$DATADIR/archetypes"
		3008	or die "unable to load archetypes\n";
		3009	#d# NEED to laod twice to resolve forward references
		3010	# this really needs to be done in an extra post-pass
		3011	# (which needs to be synchronous, so solve it differently)
		3012	load_resource_file "$DATADIR/archetypes"
		3013	or die "unable to load archetypes\n";
		3014	}
		3015
		3016	sub reload_treasures {
		3017	load_resource_file "$DATADIR/treasures"
		3018	or die "unable to load treasurelists\n";
		3019	}
		3020
		3021	sub reload_resources {
		3022	warn "reloading resource files...\n";
		3023
		3024	reload_regions;
		3025	reload_facedata;
		3026	#reload_archetypes;#d#
		3027	reload_archetypes;
		3028	reload_treasures;
		3029
		3030	warn "finished reloading resource files\n";
		3031	}
		3032
		3033	sub init {
		3034	reload_resources;
		3035	}
		3036
		3037	sub reload_config {
2269	open my $fh, "<:utf8", cf::confdir . "/config"	3038	open my $fh, "<:utf8", "$CONFDIR/config"
2270	or return;	3039	or return;
2271		3040
2272	local $/;	3041	local $/;
2273	*CFG = YAML::Syck::Load <$fh>;	3042	*CFG = YAML::Syck::Load <$fh>;
2274		3043
…		…
2282	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3051	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2283	and die "WARNING: m(un)lockall failed: $!\n";	3052	and die "WARNING: m(un)lockall failed: $!\n";
2284	};	3053	};
2285	warn $@ if $@;	3054	warn $@ if $@;
2286	}	3055	}
2287	}
2288
2289	sub init {
2290	load_resources;
2291	}	3056	}
2292		3057
2293	sub main {	3058	sub main {
2294	# we must not ever block the main coroutine	3059	# we must not ever block the main coroutine
2295	local $Coro::idle = sub {	3060	local $Coro::idle = sub {
…		…
2297	(async {	3062	(async {
2298	Event::one_event;	3063	Event::one_event;
2299	})->prio (Coro::PRIO_MAX);	3064	})->prio (Coro::PRIO_MAX);
2300	};	3065	};
2301		3066
2302	cfg_load;	3067	reload_config;
2303	db_init;	3068	db_init;
2304	load_extensions;	3069	load_extensions;
2305		3070
2306	$TICK_WATCHER->start;	3071	$TICK_WATCHER->start;
2307	Event::loop;	3072	Event::loop;
…		…
2323	},	3088	},
2324	);	3089	);
2325	}	3090	}
2326	}	3091	}
2327		3092
		3093	sub write_runtime {
		3094	my $runtime = "$LOCALDIR/runtime";
		3095
		3096	# first touch the runtime file to show we are still running:
		3097	# the fsync below can take a very very long time.
		3098
		3099	IO::AIO::aio_utime $runtime, undef, undef;
		3100
		3101	my $guard = cf::lock_acquire "write_runtime";
		3102
		3103	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3104	or return;
		3105
		3106	my $value = $cf::RUNTIME + 90 + 10;
		3107	# 10 is the runtime save interval, for a monotonic clock
		3108	# 60 allows for the watchdog to kill the server.
		3109
		3110	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3111	and return;
		3112
		3113	# always fsync - this file is important
		3114	aio_fsync $fh
		3115	and return;
		3116
		3117	# touch it again to show we are up-to-date
		3118	aio_utime $fh, undef, undef;
		3119
		3120	close $fh
		3121	or return;
		3122
		3123	aio_rename "$runtime~", $runtime
		3124	and return;
		3125
		3126	warn "runtime file written.\n";
		3127
		3128	1
		3129	}
		3130
2328	sub emergency_save() {	3131	sub emergency_save() {
2329	my $freeze_guard = cf::freeze_mainloop;	3132	my $freeze_guard = cf::freeze_mainloop;
2330		3133
2331	warn "enter emergency perl save\n";	3134	warn "enter emergency perl save\n";
2332		3135
…		…
2363		3166
2364	warn Carp::longmess "post_cleanup backtrace"	3167	warn Carp::longmess "post_cleanup backtrace"
2365	if $make_core;	3168	if $make_core;
2366	}	3169	}
2367		3170
2368	sub reload() {	3171	sub do_reload_perl() {
2369	# can/must only be called in main	3172	# can/must only be called in main
2370	if ($Coro::current != $Coro::main) {	3173	if ($Coro::current != $Coro::main) {
2371	warn "can only reload from main coroutine";	3174	warn "can only reload from main coroutine";
2372	return;	3175	return;
2373	}	3176	}
2374		3177
2375	warn "reloading...";	3178	warn "reloading...";
2376		3179
2377	warn "cancelling server ticker";	3180	warn "entering sync_job";
2378	$TICK_WATCHER->cancel;
2379		3181
		3182	cf::sync_job {
		3183	cf::write_runtime; # external watchdog should not bark
2380	cf::emergency_save;	3184	cf::emergency_save;
		3185	cf::write_runtime; # external watchdog should not bark
2381		3186
2382	eval {	3187	warn "syncing database to disk";
		3188	BDB::db_env_txn_checkpoint $DB_ENV;
		3189
2383	# if anything goes wrong in here, we should simply crash as we already saved	3190	# if anything goes wrong in here, we should simply crash as we already saved
2384		3191
2385	warn "cancelling all WF_AUTOCANCEL watchers";	3192	warn "cancelling all WF_AUTOCANCEL watchers";
2386	for (Event::all_watchers) {	3193	for (Event::all_watchers) {
2387	$_->cancel if $_->data & WF_AUTOCANCEL;	3194	$_->cancel if $_->data & WF_AUTOCANCEL;
2388	}	3195	}
2389
2390	warn "syncing database to disk";
2391	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392		3196
2393	warn "flushing outstanding aio requests";	3197	warn "flushing outstanding aio requests";
2394	for (;;) {	3198	for (;;) {
2395	BDB::flush;	3199	BDB::flush;
2396	IO::AIO::flush;	3200	IO::AIO::flush;
2397	Coro::cede;	3201	Coro::cede;
2398	last unless IO::AIO::nreqs || BDB::nreqs;	3202	last unless IO::AIO::nreqs || BDB::nreqs;
2399	warn "iterate...";	3203	warn "iterate...";
2400	}	3204	}
2401		3205
		3206	++$RELOAD;
		3207
2402	warn "cancelling all extension coros";	3208	warn "cancelling all extension coros";
2403	$_->cancel for values %EXT_CORO;	3209	$_->cancel for values %EXT_CORO;
2404	%EXT_CORO = ();	3210	%EXT_CORO = ();
2405		3211
2406	warn "removing commands";	3212	warn "removing commands";
2407	%COMMAND = ();	3213	%COMMAND = ();
2408		3214
2409	warn "removing ext commands";	3215	warn "removing ext/exti commands";
2410	%EXTCMD = ();	3216	%EXTCMD = ();
		3217	%EXTICMD = ();
2411		3218
2412	warn "unloading/nuking all extensions";	3219	warn "unloading/nuking all extensions";
2413	for my $pkg (@EXTS) {	3220	for my $pkg (@EXTS) {
2414	warn "... unloading $pkg";	3221	warn "... unloading $pkg";
2415		3222
…		…
2445	Symbol::delete_package "safe::$_"	3252	Symbol::delete_package "safe::$_"
2446	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3253	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447		3254
2448	warn "unloading cf.pm \"a bit\"";	3255	warn "unloading cf.pm \"a bit\"";
2449	delete $INC{"cf.pm"};	3256	delete $INC{"cf.pm"};
		3257	delete $INC{"cf/pod.pm"};
2450		3258
2451	# don't, removes xs symbols, too,	3259	# don't, removes xs symbols, too,
2452	# and global variables created in xs	3260	# and global variables created in xs
2453	#Symbol::delete_package __PACKAGE__;	3261	#Symbol::delete_package __PACKAGE__;
2454		3262
…		…
2457	warn "reloading cf.pm";	3265	warn "reloading cf.pm";
2458	require cf;	3266	require cf;
2459	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3267	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2460		3268
2461	warn "loading config and database again";	3269	warn "loading config and database again";
2462	cf::cfg_load;	3270	cf::reload_config;
2463		3271
2464	warn "loading extensions";	3272	warn "loading extensions";
2465	cf::load_extensions;	3273	cf::load_extensions;
2466		3274
2467	warn "reattaching attachments to objects/players";	3275	warn "reattaching attachments to objects/players";
2468	_global_reattach;	3276	_global_reattach; # objects, sockets
2469	warn "reattaching attachments to maps";	3277	warn "reattaching attachments to maps";
2470	reattach $_ for values %MAP;	3278	reattach $_ for values %MAP;
		3279	warn "reattaching attachments to players";
		3280	reattach $_ for values %PLAYER;
2471		3281
2472	warn "loading reloadable resources";	3282	warn "leaving sync_job";
2473	load_resources;
2474		3283
2475	warn "restarting server ticker";	3284	1
2476		3285	} or do {
2477	$TICK_WATCHER->start;
2478	};
2479
2480	if ($@) {
2481	warn $@;	3286	warn $@;
2482	warn "error while reloading, exiting.";	3287	warn "error while reloading, exiting.";
2483	exit 1;	3288	exit 1;
2484	}	3289	};
2485		3290
2486	warn "reloaded";	3291	warn "reloaded";
2487	};	3292	};
2488		3293
2489	our $RELOAD_WATCHER; # used only during reload	3294	our $RELOAD_WATCHER; # used only during reload
2490		3295
		3296	sub reload_perl() {
		3297	# doing reload synchronously and two reloads happen back-to-back,
		3298	# coro crashes during coro_state_free->destroy here.
		3299
		3300	$RELOAD_WATCHER ||= Event->timer (
		3301	reentrant => 0,
		3302	after => 0,
		3303	data => WF_AUTOCANCEL,
		3304	cb => sub {
		3305	do_reload_perl;
		3306	undef $RELOAD_WATCHER;
		3307	},
		3308	);
		3309	}
		3310
2491	register_command "reload" => sub {	3311	register_command "reload" => sub {
2492	my ($who, $arg) = @_;	3312	my ($who, $arg) = @_;
2493		3313
2494	if ($who->flag (FLAG_WIZ)) {	3314	if ($who->flag (FLAG_WIZ)) {
2495	$who->message ("reloading server.");	3315	$who->message ("reloading server.");
2496		3316	async { reload_perl };
2497	# doing reload synchronously and two reloads happen back-to-back,
2498	# coro crashes during coro_state_free->destroy here.
2499
2500	$RELOAD_WATCHER ||= Event->timer (
2501	reentrant => 0,
2502	after => 0,
2503	data => WF_AUTOCANCEL,
2504	cb => sub {
2505	reload;
2506	undef $RELOAD_WATCHER;
2507	},
2508	);
2509	}	3317	}
2510	};	3318	};
2511		3319
2512	unshift @INC, $LIBDIR;	3320	unshift @INC, $LIBDIR;
2513		3321
2514	my $bug_warning = 0;	3322	my $bug_warning = 0;
2515		3323
		3324	our @WAIT_FOR_TICK;
		3325	our @WAIT_FOR_TICK_BEGIN;
		3326
		3327	sub wait_for_tick {
		3328	return unless $TICK_WATCHER->is_active;
		3329	return if $Coro::current == $Coro::main;
		3330
		3331	my $signal = new Coro::Signal;
		3332	push @WAIT_FOR_TICK, $signal;
		3333	$signal->wait;
		3334	}
		3335
		3336	sub wait_for_tick_begin {
		3337	return unless $TICK_WATCHER->is_active;
		3338	return if $Coro::current == $Coro::main;
		3339
		3340	my $signal = new Coro::Signal;
		3341	push @WAIT_FOR_TICK_BEGIN, $signal;
		3342	$signal->wait;
		3343	}
		3344
		3345	my $min = 1e6;#d#
		3346	my $avg = 10;
2516	$TICK_WATCHER = Event->timer (	3347	$TICK_WATCHER = Event->timer (
2517	reentrant => 0,	3348	reentrant => 0,
2518	parked => 1,	3349	parked => 1,
2519	prio => 0,	3350	prio => 0,
2520	at => $NEXT_TICK || $TICK,	3351	at => $NEXT_TICK || $TICK,
…		…
2524	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3355	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525	unless ++$bug_warning > 10;	3356	unless ++$bug_warning > 10;
2526	return;	3357	return;
2527	}	3358	}
2528		3359
2529	$NOW = Event::time;	3360	$NOW = $tick_start = Event::time;
2530		3361
2531	cf::server_tick; # one server iteration	3362	cf::server_tick; # one server iteration
		3363
		3364	0 && sync_job {#d#
		3365	for(1..10) {
		3366	my $t = Event::time;
		3367	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3368	or die;
		3369
		3370	$map->width (50);
		3371	$map->height (50);
		3372	$map->alloc;
		3373	$map->_load_objects ("/tmp/x.map", 1);
		3374	my $t = Event::time - $t;
		3375
		3376	#next unless $t < 0.0013;#d#
		3377	if ($t < $min) {
		3378	$min = $t;
		3379	}
		3380	$avg = $avg * 0.99 + $t * 0.01;
		3381	}
		3382	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3383	exit 0;
		3384	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3385	};
		3386
2532	$RUNTIME += $TICK;	3387	$RUNTIME += $TICK;
2533	$NEXT_TICK += $TICK;	3388	$NEXT_TICK += $TICK;
2534		3389
2535	$WAIT_FOR_TICK->broadcast;	3390	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3391	$NEXT_RUNTIME_WRITE = $NOW + 10;
2537		3392	Coro::async_pool {
2538	Event::sweep;	3393	write_runtime
2539	Coro::cede_notself;	3394	or warn "ERROR: unable to write runtime file: $!";
		3395	};
2540		3396	}
		3397
2541	# my $AFTER = Event::time;	3398	# my $AFTER = Event::time;
2542	# warn $AFTER - $NOW;#d#	3399	# warn $AFTER - $NOW;#d#
2543		3400
		3401	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3402	$sig->send;
		3403	}
		3404	while (my $sig = shift @WAIT_FOR_TICK) {
		3405	$sig->send;
		3406	}
		3407
		3408	$NOW = Event::time;
		3409
2544	# if we are delayed by four ticks or more, skip them all	3410	# if we are delayed by four ticks or more, skip them all
2545	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3411	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2546		3412
2547	$TICK_WATCHER->at ($NEXT_TICK);	3413	$TICK_WATCHER->at ($NEXT_TICK);
2548	$TICK_WATCHER->start;	3414	$TICK_WATCHER->start;
		3415
		3416	$LOAD = ($NOW - $tick_start) / $TICK;
		3417	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3418
		3419	_post_tick;
		3420
		3421
2549	},	3422	},
2550	);	3423	);
2551		3424
2552	{	3425	{
2553	BDB::max_poll_time $TICK * 0.1;	3426	BDB::max_poll_time $TICK * 0.1;
…		…
2581		3454
2582	cf::sync_job {	3455	cf::sync_job {
2583	eval {	3456	eval {
2584	BDB::db_env_open	3457	BDB::db_env_open
2585	$DB_ENV,	3458	$DB_ENV,
2586	$BDB_ENV_DIR,	3459	$BDBDIR,
2587	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3460	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3461	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589	0666;	3462	0666;
2590		3463
2591	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3464	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592		3465
2593	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3466	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594	$DB_ENV->set_lk_detect;	3467	$DB_ENV->set_lk_detect;
2595	};	3468	};
2596		3469
…		…
2604		3477
2605	undef $Coro::AIO::WATCHER;	3478	undef $Coro::AIO::WATCHER;
2606	IO::AIO::max_poll_time $TICK * 0.1;	3479	IO::AIO::max_poll_time $TICK * 0.1;
2607	$AIO_POLL_WATCHER = Event->io (	3480	$AIO_POLL_WATCHER = Event->io (
2608	reentrant => 0,	3481	reentrant => 0,
		3482	data => WF_AUTOCANCEL,
2609	fd => IO::AIO::poll_fileno,	3483	fd => IO::AIO::poll_fileno,
2610	poll => 'r',	3484	poll => 'r',
2611	prio => 6,	3485	prio => 6,
2612	data => WF_AUTOCANCEL,
2613	cb => \&IO::AIO::poll_cb,	3486	cb => \&IO::AIO::poll_cb,
2614	);	3487	);
2615	}	3488	}
2616		3489
2617	$WRITE_RUNTIME_WATCHER = Event->timer (	3490	my $_log_backtrace;
2618	reentrant => 0,	3491
2619	data => WF_AUTOCANCEL,	3492	sub _log_backtrace {
2620	after => 1,	3493	my ($msg, @addr) = @_;
2621	interval => 10,	3494
2622	prio => 6, # keep it lowest so it acts like a watchdog	3495	$msg =~ s/\n//;
2623	cb => Coro::unblock_sub {	3496
2624	write_runtime	3497	# limit the # of concurrent backtraces
2625	or warn "ERROR: unable to write runtime file: $!";	3498	if ($_log_backtrace < 2) {
		3499	++$_log_backtrace;
		3500	async {
		3501	my @bt = fork_call {
		3502	@addr = map { sprintf "%x", $_ } @addr;
		3503	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3504	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3505	or die "addr2line: $!";
		3506
		3507	my @funcs;
		3508	my @res = <$fh>;
		3509	chomp for @res;
		3510	while (@res) {
		3511	my ($func, $line) = splice @res, 0, 2, ();
		3512	push @funcs, "[$func] $line";
		3513	}
		3514
		3515	@funcs
		3516	};
		3517
		3518	LOG llevInfo, "[ABT] $msg\n";
		3519	LOG llevInfo, "[ABT] $_\n" for @bt;
		3520	--$_log_backtrace;
		3521	};
		3522	} else {
		3523	LOG llevInfo, "[ABT] $msg\n";
		3524	LOG llevInfo, "[ABT] [suppressed]\n";
2626	},	3525	}
2627	);	3526	}
		3527
		3528	# load additional modules
		3529	use cf::pod;
2628		3530
2629	END { cf::emergency_save }	3531	END { cf::emergency_save }
2630		3532
2631	1	3533	1
2632		3534

Diff Legend

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