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.209 by root, Mon Feb 12 01:25:55 2007 UTC vs.
Revision 1.355 by root, Sun Sep 2 12:45:44 2007 UTC

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

Diff Legend

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