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.157 by root, Wed Jan 10 01:16:54 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3 ();	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 ();
		27	use BDB ();
20	use Data::Dumper;	28	use Data::Dumper;
21	use Digest::MD5;	29	use Digest::MD5;
22	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
23	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
26		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		44
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
33		47
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
36	our %COMMAND = ();	52	our %COMMAND = ();
37	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
38	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
39		60
		61	our $RELOAD; # number of reloads so far
40	our @EVENT;	62	our @EVENT;
41	our $LIBDIR = datadir . "/ext";
42		63
43	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(!)
44	our $TICK_WATCHER;	77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
45	our $NEXT_TICK;	80	our $NEXT_TICK;
46	our $NOW;	81	our $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_WATCHER;
		85	our $DB_ENV;
47		86
48	our %CFG;	87	our %CFG;
49		88
50	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
51	our $RUNTIME;	90	our $RUNTIME;
52		91
53	our %PLAYER; # all users	92	our %PLAYER; # all users
54	our %MAP; # all maps	93	our %MAP; # all maps
55	our $LINK_MAP; # the special {link} map	94	our $LINK_MAP; # the special {link} map, which is always available
56	our $RANDOM_MAPS = cf::localdir . "/random";
57	our %EXT_CORO; # coroutines bound to extensions
58		95
59	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	96	# used to convert map paths into valid unix filenames by replacing / by ∕
60	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		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
61		102
62	binmode STDOUT;	103	binmode STDOUT;
63	binmode STDERR;	104	binmode STDERR;
64		105
65	# read virtual server time, if available	106	# read virtual server time, if available
66	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
67	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
68	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
69	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
70	}	111	}
71		112
72	mkdir cf::localdir;	113	mkdir $_
73	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
74	mkdir cf::localdir . "/" . cf::tmpdir;
75	mkdir cf::localdir . "/" . cf::uniquedir;
76	mkdir $RANDOM_MAPS;
77		115
78	# a special map that is always available
79	our $LINK_MAP;
80	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
		117
		118	sub cf::map::normalise;
81		119
82	#############################################################################	120	#############################################################################
83		121
84	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
85		123
…		…
92	=item $cf::RUNTIME	130	=item $cf::RUNTIME
93		131
94	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
95	every server tick.	133	every server tick.
96		134
97	=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
98		138
99	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
100	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.
101		143
102	=item $cf::NOW	144	=item $cf::NOW
103		145
104	The time of the last (current) server tick.	146	The time of the last (current) server tick.
105		147
106	=item $cf::TICK	148	=item $cf::TICK
107		149
108	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.
109		161
110	=item %cf::CFG	162	=item %cf::CFG
111		163
112	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
113	from wherever your confdir points to.	165	from wherever your confdir points to.
114		166
115	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
116		168
117	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
118	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
119	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.
120	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.
121		178
122	=back	179	=back
123		180
124	=cut	181	=cut
125		182
126	BEGIN {	183	BEGIN {
127	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
128	my $msg = join "", @_;	185	my $msg = join "", @_;
129	utf8::encode $msg;
130		186
131	$msg .= "\n"	187	$msg .= "\n"
132	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
133		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
134	LOG llevError, $msg;	193	LOG llevError, $msg;
135	};	194	};
136	}	195	}
137		196
138	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
139	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
141	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
142	@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';
143	@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)
144		204
145	# 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
146	# within the Safe compartment.	206	# within the Safe compartment.
147	for my $pkg (qw(	207	for my $pkg (qw(
148	cf::global cf::attachable	208	cf::global cf::attachable
…		…
157		217
158	$Event::DIED = sub {	218	$Event::DIED = sub {
159	warn "error in event callback: @_";	219	warn "error in event callback: @_";
160	};	220	};
161		221
162	my %ext_pkg;	222	#############################################################################
163	my @exts;
164	my @hook;
165		223
166	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
167		225
168	=over 4	226	=over 4
169		227
…		…
188	$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;
189	$d	247	$d
190	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
191	}	249	}
192		250
193	use JSON::Syck (); # TODO# replace by JSON::PC once working
194
195	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
196		252
197	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
198		254
199	=cut
200
201	sub from_json($) {
202	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203	JSON::Syck::Load $_[0]
204	}
205
206	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
207		256
208	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
209		258
210	=cut	259	=cut
211		260
212	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
214	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
215	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
216		265
217	=item cf::lock_wait $string	266	=item cf::lock_wait $string
218		267
219	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
220		269
…		…
223	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
224	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,
225	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
226	returned.	275	returned.
227		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
228	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
229	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.
230		286
231	=cut	287	=cut
232		288
233	our %LOCK;	289	our %LOCK;
234		290
…		…
254	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
255	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
256	}	312	}
257	}	313	}
258		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
259	sub freeze_mainloop {	321	sub freeze_mainloop {
260	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
261		323
262	my $guard = Coro::guard { $TICK_WATCHER->start };	324	my $guard = Coro::guard {
		325	$TICK_WATCHER->start;
		326	};
263	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
264	$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;
265	}	385	}
266		386
267	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
268		388
269	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
…		…
274		394
275	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
276		396
277	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
278		398
279	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)
280	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
281	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.
282		403
283	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
284	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
285	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
286	fast or be very important.	407	fast or be very important.
…		…
289		410
290	sub sync_job(&) {	411	sub sync_job(&) {
291	my ($job) = @_;	412	my ($job) = @_;
292		413
293	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
294	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
295	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
296		419
297	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
298	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
309		432
310	while ($busy) {	433	while ($busy) {
311	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
312	}	435	}
313		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
314	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
315	} else {	445	} else {
316	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
317		447
318	$job->()	448	$job->()
319	}	449	}
320	}	450	}
321		451
322	=item $coro = cf::async_ext { BLOCK }	452	=item $coro = cf::async_ext { BLOCK }
323		453
324	Like async, but this coro is automcatially being canceled when the	454	Like async, but this coro is automatically being canceled when the
325	extension calling this is being unloaded.	455	extension calling this is being unloaded.
326		456
327	=cut	457	=cut
328		458
329	sub async_ext(&) {	459	sub async_ext(&) {
…		…
337	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
338		468
339	$coro	469	$coro
340	}	470	}
341		471
342	sub write_runtime {	472	=item fork_call { }, $args
343	my $runtime = cf::localdir . "/runtime";
344		473
345	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
346	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.
347		478
348	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	479	=cut
349	(aio_write $fh, 0, (length $value), $value, 0) <= 0
350	and return;
351		480
352	aio_fsync $fh	481	sub fork_call(&@) {
353	and return;	482	my ($cb, @args) = @_;
354		483
355	close $fh	484	# we seemingly have to make a local copy of the whole thing,
356	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
357		487
358	aio_rename "$runtime~", $runtime	488	my @res = Coro::Util::fork_eval {
359	and return;	489	reset_signals;
		490	&$cb
		491	}, @args;
360		492
		493	wantarray ? @res : $res[-1]
		494	}
		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	};
361	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 });
362	}	621	}
363		622
364	=back	623	=back
365		624
366	=cut	625	=cut
367
368	#############################################################################
369
370	package cf::path;
371
372	# used to convert map paths into valid unix filenames by repalcing / by ∕
373	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
374
375	sub new {
376	my ($class, $path, $base) = @_;
377
378	$path = $path->as_string if ref $path;
379
380	my $self = bless { }, $class;
381
382	# {... are special paths that are not touched
383	# ?xxx/... are special absolute paths
384	# ?random/... random maps
385	# /! non-realised random map exit
386	# /... normal maps
387	# ~/... per-player maps without a specific player (DO NOT USE)
388	# ~user/... per-player map of a specific user
389
390	if ($path =~ /^{/) {
391	# fine as it is
392	} elsif ($path =~ s{^\?random/}{}) {
393	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
394	$self->{random} = cf::from_json $data;
395	} else {
396	if ($path =~ s{^~([^/]+)?}{}) {
397	$self->{user_rel} = 1;
398
399	if (defined $1) {
400	$self->{user} = $1;
401	} elsif ($base =~ m{^~([^/]+)/}) {
402	$self->{user} = $1;
403	} else {
404	warn "cannot resolve user-relative path without user <$path,$base>\n";
405	}
406	} elsif ($path =~ /^\//) {
407	# already absolute
408	} else {
409	$base =~ s{[^/]+/?$}{};
410	return $class->new ("$base/$path");
411	}
412
413	for ($path) {
414	redo if s{/\.?/}{/};
415	redo if s{/[^/]+/\.\./}{/};
416	}
417	}
418
419	$self->{path} = $path;
420
421	$self
422	}
423
424	# the name / primary key / in-game path
425	sub as_string {
426	my ($self) = @_;
427
428	$self->{user_rel} ? "~$self->{user}$self->{path}"
429	: $self->{random} ? "?random/$self->{path}"
430	: $self->{path}
431	}
432
433	# the displayed name, this is a one way mapping
434	sub visible_name {
435	my ($self) = @_;
436
437	# if (my $rmp = $self->{random}) {
438	# # todo: be more intelligent about this
439	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
440	# } else {
441	$self->as_string
442	# }
443	}
444
445	# escape the /'s in the path
446	sub _escaped_path {
447	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
448	$path
449	}
450
451	# the original (read-only) location
452	sub load_path {
453	my ($self) = @_;
454
455	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
456	}
457
458	# the temporary/swap location
459	sub save_path {
460	my ($self) = @_;
461
462	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
463	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
464	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
465	}
466
467	# the unique path, might be eq to save_path
468	sub uniq_path {
469	my ($self) = @_;
470
471	$self->{user_rel} || $self->{random}
472	? undef
473	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
474	}
475
476	# return random map parameters, or undef
477	sub random_map_params {
478	my ($self) = @_;
479
480	$self->{random}
481	}
482
483	# this is somewhat ugly, but style maps do need special treatment
484	sub is_style_map {
485	$_[0]{path} =~ m{^/styles/}
486	}
487
488	package cf;
489		626
490	#############################################################################	627	#############################################################################
491		628
492	=head2 ATTACHABLE OBJECTS	629	=head2 ATTACHABLE OBJECTS
493		630
…		…
495	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")
496	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
497		634
498	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>
499	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
500	crossfire+).	637	Crossfire TRT).
501		638
502	=over 4	639	=over 4
503		640
504	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
505		642
…		…
619	our @CB_TYPE = (); # registry for type (cf-object class) based events	756	our @CB_TYPE = (); # registry for type (cf-object class) based events
620	our @CB_MAP = ();	757	our @CB_MAP = ();
621		758
622	my %attachment;	759	my %attachment;
623		760
		761	sub cf::attachable::thawer_merge {
		762	# simply override everything except _meta
		763	local $_[0]{_meta};
		764	%{$_[0]} = %{$_[1]};
		765	}
		766
624	sub _attach_cb($$$$) {	767	sub _attach_cb($$$$) {
625	my ($registry, $event, $prio, $cb) = @_;	768	my ($registry, $event, $prio, $cb) = @_;
626		769
627	use sort 'stable';	770	use sort 'stable';
628		771
…		…
662	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
663		806
664	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
665	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
666	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
667	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
668		811
669	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
670	my $pkg = shift @arg;	813	my $pkg = shift @arg;
671		814
672	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
701	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
702	}	845	}
703		846
704	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
705	} else {	848	} else {
706	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
707	}	850	}
708		851
709	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
710	}	853	}
711		854
…		…
713	if (ref $_[0]) {	856	if (ref $_[0]) {
714	_object_attach @_;	857	_object_attach @_;
715	} else {	858	} else {
716	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
717	}	860	}
		861	_recalc_want;
718	};	862	};
719		863
720	# all those should be optimised	864	# all those should be optimised
721	sub cf::attachable::detach {	865	sub cf::attachable::detach {
722	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
725	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
726	reattach ($obj);	870	reattach ($obj);
727	} else {	871	} else {
728	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
729	}	873	}
		874	_recalc_want;
730	};	875	};
731		876
732	sub cf::attachable::attached {	877	sub cf::attachable::attached {
733	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
734		879
…		…
749	";	894	";
750	die if $@;	895	die if $@;
751	}	896	}
752		897
753	our $override;	898	our $override;
754	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?
755		900
756	sub override {	901	sub override {
757	$override = 1;	902	$override = 1;
758	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
759	}	904	}
760		905
761	sub do_invoke {	906	sub do_invoke {
762	my $event = shift;	907	my $event = shift;
763	my $callbacks = shift;	908	my $callbacks = shift;
764		909
765	@invoke_results = ();	910	@INVOKE_RESULTS = ();
766		911
767	local $override;	912	local $override;
768		913
769	for (@$callbacks) {	914	for (@$callbacks) {
770	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
787		932
788	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
789		934
790	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
791	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
792	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
793		938
794	=back	939	=back
795		940
796	=cut	941	=cut
797		942
798	#############################################################################	943	#############################################################################
799	# 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	}
800		956
801	sub reattach {	957	sub reattach {
802	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
803	my ($obj) = @_;	959	my ($obj) = @_;
		960
		961	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
804		962
805	my $registry = $obj->registry;	963	my $registry = $obj->registry;
806		964
807	@$registry = ();	965	@$registry = ();
808		966
…		…
855	$filename, length $$rdata, scalar @$objs;	1013	$filename, length $$rdata, scalar @$objs;
856		1014
857	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1015	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
858	chmod SAVE_MODE, $fh;	1016	chmod SAVE_MODE, $fh;
859	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1017	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
860	aio_fsync $fh;	1018	aio_fsync $fh if $cf::USE_FSYNC;
861	close $fh;	1019	close $fh;
862		1020
863	if (@$objs) {	1021	if (@$objs) {
864	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1022	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
865	chmod SAVE_MODE, $fh;	1023	chmod SAVE_MODE, $fh;
866	my $data = Storable::nfreeze { version => 1, objs => $objs };	1024	my $data = Storable::nfreeze { version => 1, objs => $objs };
867	aio_write $fh, 0, (length $data), $data, 0;	1025	aio_write $fh, 0, (length $data), $data, 0;
868	aio_fsync $fh;	1026	aio_fsync $fh if $cf::USE_FSYNC;
869	close $fh;	1027	close $fh;
870	aio_rename "$filename.pst~", "$filename.pst";	1028	aio_rename "$filename.pst~", "$filename.pst";
871	}	1029	}
872	} else {	1030	} else {
873	aio_unlink "$filename.pst";	1031	aio_unlink "$filename.pst";
…		…
905	or return;	1063	or return;
906	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
907	}	1065	}
908		1066
909	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
910	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
911	return ($data, $av);	1069	return ($data, $av);
912	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
913		1077
914	#############################################################################	1078	#############################################################################
915	# command handling &c	1079	# command handling &c
916		1080
917	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
930	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
931	}	1095	}
932		1096
933	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
934		1098
935	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.
936		1104
937	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
938	called.	1106	called.
939		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
940	=cut	1119	=cut
941		1120
942	sub register_extcmd {	1121	sub register_extcmd {
943	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
944		1123
945	my $caller = caller;
946	#warn "registering extcmd '$name' to '$caller'";
947
948	$EXTCMD{$name} = [$cb, $caller];	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
949	}	1131	}
950		1132
951	cf::player->attach (	1133	cf::player->attach (
952	on_command => sub {	1134	on_command => sub {
953	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
962	cf::override;	1144	cf::override;
963	},	1145	},
964	on_extcmd => sub {	1146	on_extcmd => sub {
965	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
966		1148
967	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
968		1150
969	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
970	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
971	if (my %reply = $cb->[0]->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
972	$pl->ext_reply ($msg->{msgid}, %reply);
973	}
974	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
975	} else {	1166	} else {
976	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
977	}	1168	}
978		1169
979	cf::override;	1170	cf::override;
980	},	1171	},
981	);	1172	);
982		1173
983	sub register {
984	my ($base, $pkg) = @_;
985
986	#TODO
987	}
988
989	sub load_extension {
990	my ($path) = @_;
991
992	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
993	my $base = $1;
994	my $pkg = $1;
995	$pkg =~ s/[^[:word:]]/_/g;
996	$pkg = "ext::$pkg";
997
998	warn "loading '$path' into '$pkg'\n";
999
1000	open my $fh, "<:utf8", $path
1001	or die "$path: $!";
1002
1003	my $source =
1004	"package $pkg; use strict; use utf8;\n"
1005	. "#line 1 \"$path\"\n{\n"
1006	. (do { local $/; <$fh> })
1007	. "\n};\n1";
1008
1009	eval $source
1010	or die $@ ? "$path: $@\n"
1011	: "extension disabled.\n";
1012
1013	push @exts, $pkg;
1014	$ext_pkg{$base} = $pkg;
1015
1016	# no strict 'refs';
1017	# @{"$pkg\::ISA"} = ext::;
1018
1019	register $base, $pkg;
1020	}
1021
1022	sub unload_extension {
1023	my ($pkg) = @_;
1024
1025	warn "removing extension $pkg\n";
1026
1027	# remove hooks
1028	#TODO
1029	# for my $idx (0 .. $#PLUGIN_EVENT) {
1030	# delete $hook[$idx]{$pkg};
1031	# }
1032
1033	# remove commands
1034	for my $name (keys %COMMAND) {
1035	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1036
1037	if (@cb) {
1038	$COMMAND{$name} = \@cb;
1039	} else {
1040	delete $COMMAND{$name};
1041	}
1042	}
1043
1044	# remove extcmds
1045	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1046	delete $EXTCMD{$name};
1047	}
1048
1049	if (my $cb = $pkg->can ("unload")) {
1050	eval {
1051	$cb->($pkg);
1052	1
1053	} or warn "$pkg unloaded, but with errors: $@";
1054	}
1055
1056	Symbol::delete_package $pkg;
1057	}
1058
1059	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
1060	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
1061	next unless -r $ext;	1179	next unless -r $path;
1062	eval {	1180
1063	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;
1064	1	1238	}
1065	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
1066	}	1244	};
1067	}	1245	}
1068		1246
1069	#############################################################################	1247	#############################################################################
1070	# load/save/clean perl data associated with a map
1071		1248
1072	*cf::mapsupport::on_clean = sub {	1249	=back
1073	my ($map) = @_;
1074
1075	my $path = $map->tmpname;
1076	defined $path or return;
1077
1078	unlink "$path.pst";
1079	};
1080
1081	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1082
1083	#############################################################################
1084		1250
1085	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
1086		1252
1087	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
1088		1254
…		…
1101	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
1102		1268
1103	=cut	1269	=cut
1104		1270
1105	sub playerdir($) {	1271	sub playerdir($) {
1106	cf::localdir	1272	"$PLAYERDIR/"
1107	. "/"
1108	. cf::playerdir
1109	. "/"
1110	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1111	}	1274	}
1112		1275
1113	sub path($) {	1276	sub path($) {
1114	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1115		1278
1116	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
1117	}	1280	}
1118		1281
1119	sub find_active($) {	1282	sub find_active($) {
1120	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
1121	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
1124		1287
1125	sub exists($) {	1288	sub exists($) {
1126	my ($login) = @_;	1289	my ($login) = @_;
1127		1290
1128	$cf::PLAYER{$login}	1291	$cf::PLAYER{$login}
1129	or cf::sync_job { !aio_stat $login }	1292	or cf::sync_job { !aio_stat path $login }
1130	}	1293	}
1131		1294
1132	sub find($) {	1295	sub find($) {
1133	return $cf::PLAYER{$_[0]} || do {	1296	return $cf::PLAYER{$_[0]} || do {
1134	my $login = $_[0];	1297	my $login = $_[0];
1135		1298
1136	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
1137		1300
1138	$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
1139	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
1140	or return;	1310	or return;
1141	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
1142	}	1312	}
1143	}	1313	}
…		…
1155		1325
1156	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1157	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1158		1328
1159	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1160	Coro::cede;	1330	cf::cede_to_tick;
1161	}	1331	}
1162		1332
1163	sub new($) {	1333	sub new($) {
1164	my ($login) = @_;	1334	my ($login) = @_;
1165		1335
…		…
1171	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1172		1342
1173	$self	1343	$self
1174	}	1344	}
1175		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
1176	=item $pl->quit_character	1356	=item $pl->quit_character
1177		1357
1178	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
1179	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1180		1360
1181	=cut	1361	=cut
1182		1362
1183	sub quit_character {	1363	sub quit_character {
1184	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1185		1367
1186	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1187	$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
1188		1370
1189	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1194	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1195	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1196	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1197	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1198	$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
1199	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;
1200	}	1402	}
1201		1403
1202	=item cf::player::list_logins	1404	=item cf::player::list_logins
1203		1405
1204	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
1205	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1206		1408
1207	=cut	1409	=cut
1208		1410
1209	sub list_logins {	1411	sub list_logins {
1210	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1211	or return [];	1413	or return [];
1212		1414
1213	my @logins;	1415	my @logins;
1214		1416
1215	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1224	\@logins	1426	\@logins
1225	}	1427	}
1226		1428
1227	=item $player->maps	1429	=item $player->maps
1228		1430
1229	Returns an arrayref of cf::path's of all maps that are private for this	1431	Returns an arrayref of map paths that are private for this
1230	player. May block.	1432	player. May block.
1231		1433
1232	=cut	1434	=cut
1233		1435
1234	sub maps($) {	1436	sub maps($) {
1235	my ($pl) = @_;	1437	my ($pl) = @_;
		1438
		1439	$pl = ref $pl ? $pl->ob->name : $pl;
1236		1440
1237	my $files = aio_readdir playerdir $pl	1441	my $files = aio_readdir playerdir $pl
1238	or return;	1442	or return;
1239		1443
1240	my @paths;	1444	my @paths;
1241		1445
1242	for (@$files) {	1446	for (@$files) {
1243	utf8::decode $_;	1447	utf8::decode $_;
1244	next if /\.(?:pl|pst)$/;	1448	next if /\.(?:pl|pst)$/;
1245	next unless /^$PATH_SEP/;	1449	next unless /^$PATH_SEP/o;
1246		1450
1247	s/$PATH_SEP/\//g;	1451	push @paths, cf::map::normalise "~$pl/$_";
1248	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1249	}	1452	}
1250		1453
1251	\@paths	1454	\@paths
1252	}	1455	}
1253		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1254	=item $player->ext_reply ($msgid, $msgtype, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1255		1508
1256	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1257		1510
1258	=cut	1511	=cut
1259		1512
1260	sub ext_reply($$$%) {	1513	sub ext_reply($$@) {
1261	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1262		1515
1263	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1264
1265	$self->send ("ext " . cf::to_json \%msg);
1266	}	1517	}
1267		1518
1268	package cf;	1519	=item $player->ext_msg ($type, @msg)
		1520
		1521	Sends an ext event to the client.
		1522
		1523	=cut
		1524
		1525	sub ext_msg($$@) {
		1526	my ($self, $type, @msg) = @_;
		1527
		1528	$self->ns->ext_msg ($type, @msg);
		1529	}
		1530
		1531	=head3 cf::region
		1532
		1533	=over 4
		1534
		1535	=cut
		1536
		1537	package cf::region;
		1538
		1539	=item cf::region::find_by_path $path
		1540
		1541	Tries to decuce the likely region for a map knowing only its path.
		1542
		1543	=cut
		1544
		1545	sub find_by_path($) {
		1546	my ($path) = @_;
		1547
		1548	my ($match, $specificity);
		1549
		1550	for my $region (list) {
		1551	if ($region->{match} && $path =~ $region->{match}) {
		1552	($match, $specificity) = ($region, $region->specificity)
		1553	if $region->specificity > $specificity;
		1554	}
		1555	}
		1556
		1557	$match
		1558	}
1269		1559
1270	=back	1560	=back
1271
1272		1561
1273	=head3 cf::map	1562	=head3 cf::map
1274		1563
1275	=over 4	1564	=over 4
1276		1565
…		…
1279	package cf::map;	1568	package cf::map;
1280		1569
1281	use Fcntl;	1570	use Fcntl;
1282	use Coro::AIO;	1571	use Coro::AIO;
1283		1572
		1573	use overload
		1574	'""' => \&as_string,
		1575	fallback => 1;
		1576
1284	our $MAX_RESET = 3600;	1577	our $MAX_RESET = 3600;
1285	our $DEFAULT_RESET = 3000;	1578	our $DEFAULT_RESET = 3000;
1286		1579
1287	sub generate_random_map {	1580	sub generate_random_map {
1288	my ($path, $rmp) = @_;	1581	my ($self, $rmp) = @_;
1289
1290	# mit "rum" bekleckern, nicht	1582	# mit "rum" bekleckern, nicht
1291	cf::map::_create_random_map	1583	$self->_create_random_map (
1292	$path,
1293	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1584	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1294	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1585	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1295	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1586	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1296	$rmp->{exit_on_final_map},	1587	$rmp->{exit_on_final_map},
1297	$rmp->{xsize}, $rmp->{ysize},	1588	$rmp->{xsize}, $rmp->{ysize},
1298	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1589	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1299	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1590	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1300	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1591	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1301	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1592	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1302	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1593	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1303	(cf::region::find $rmp->{region})	1594	(cf::region::find $rmp->{region}), $rmp->{custom}
		1595	)
		1596	}
		1597
		1598	=item cf::map->register ($regex, $prio)
		1599
		1600	Register a handler for the map path matching the given regex at the
		1601	givne priority (higher is better, built-in handlers have priority 0, the
		1602	default).
		1603
		1604	=cut
		1605
		1606	sub register {
		1607	my (undef, $regex, $prio) = @_;
		1608	my $pkg = caller;
		1609
		1610	no strict;
		1611	push @{"$pkg\::ISA"}, __PACKAGE__;
		1612
		1613	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1614	}
		1615
		1616	# also paths starting with '/'
		1617	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1618
		1619	sub thawer_merge {
		1620	my ($self, $merge) = @_;
		1621
		1622	# we have to keep some variables in memory intact
		1623	local $self->{path};
		1624	local $self->{load_path};
		1625
		1626	$self->SUPER::thawer_merge ($merge);
		1627	}
		1628
		1629	sub normalise {
		1630	my ($path, $base) = @_;
		1631
		1632	$path = "$path"; # make sure its a string
		1633
		1634	$path =~ s/\.map$//;
		1635
		1636	# map plan:
		1637	#
		1638	# /! non-realised random map exit (special hack!)
		1639	# {... are special paths that are not being touched
		1640	# ?xxx/... are special absolute paths
		1641	# ?random/... random maps
		1642	# /... normal maps
		1643	# ~user/... per-player map of a specific user
		1644
		1645	$path =~ s/$PATH_SEP/\//go;
		1646
		1647	# treat it as relative path if it starts with
		1648	# something that looks reasonable
		1649	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1650	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1651
		1652	$base =~ s{[^/]+/?$}{};
		1653	$path = "$base/$path";
		1654	}
		1655
		1656	for ($path) {
		1657	redo if s{//}{/};
		1658	redo if s{/\.?/}{/};
		1659	redo if s{/[^/]+/\.\./}{/};
		1660	}
		1661
		1662	$path
		1663	}
		1664
		1665	sub new_from_path {
		1666	my (undef, $path, $base) = @_;
		1667
		1668	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1669
		1670	$path = normalise $path, $base;
		1671
		1672	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1673	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1674	my $self = bless cf::map::new, $pkg;
		1675	$self->{path} = $path; $self->path ($path);
		1676	$self->init; # pass $1 etc.
		1677	return $self;
		1678	}
		1679	}
		1680
		1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1682	()
		1683	}
		1684
		1685	sub init {
		1686	my ($self) = @_;
		1687
		1688	$self
		1689	}
		1690
		1691	sub as_string {
		1692	my ($self) = @_;
		1693
		1694	"$self->{path}"
		1695	}
		1696
		1697	# the displayed name, this is a one way mapping
		1698	sub visible_name {
		1699	&as_string
		1700	}
		1701
		1702	# the original (read-only) location
		1703	sub load_path {
		1704	my ($self) = @_;
		1705
		1706	"$MAPDIR/$self->{path}.map"
		1707	}
		1708
		1709	# the temporary/swap location
		1710	sub save_path {
		1711	my ($self) = @_;
		1712
		1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1714	"$TMPDIR/$path.map"
		1715	}
		1716
		1717	# the unique path, undef == no special unique path
		1718	sub uniq_path {
		1719	my ($self) = @_;
		1720
		1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1722	"$UNIQUEDIR/$path"
1304	}	1723	}
1305		1724
1306	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1307	# all maps in C++...	1726	# all maps in C++...
1308	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1310		1729
1311	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1312	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1313	}	1732	}
1314		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
		1742	sub unlink_save {
		1743	my ($self) = @_;
		1744
		1745	utf8::encode (my $save = $self->save_path);
		1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1748	}
		1749
1315	sub try_load_header($) {	1750	sub load_header_from($) {
1316	my ($path) = @_;	1751	my ($self, $path) = @_;
1317		1752
1318	utf8::encode $path;	1753	utf8::encode $path;
1319	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
		1755	# or return;
		1756
		1757	$self->_load_header ($path)
1320	or return;	1758	or return;
1321		1759
1322	my $map = cf::map::new	1760	$self->{load_path} = $path;
		1761
		1762	1
		1763	}
		1764
		1765	sub load_header_orig {
		1766	my ($self) = @_;
		1767
		1768	$self->load_header_from ($self->load_path)
		1769	}
		1770
		1771	sub load_header_temp {
		1772	my ($self) = @_;
		1773
		1774	$self->load_header_from ($self->save_path)
		1775	}
		1776
		1777	sub prepare_temp {
		1778	my ($self) = @_;
		1779
		1780	$self->last_access ((delete $self->{last_access})
		1781	|| $cf::RUNTIME); #d#
		1782	# safety
		1783	$self->{instantiate_time} = $cf::RUNTIME
		1784	if $self->{instantiate_time} > $cf::RUNTIME;
		1785	}
		1786
		1787	sub prepare_orig {
		1788	my ($self) = @_;
		1789
		1790	$self->{load_original} = 1;
		1791	$self->{instantiate_time} = $cf::RUNTIME;
		1792	$self->last_access ($cf::RUNTIME);
		1793	$self->instantiate;
		1794	}
		1795
		1796	sub load_header {
		1797	my ($self) = @_;
		1798
		1799	if ($self->load_header_temp) {
		1800	$self->prepare_temp;
		1801	} else {
		1802	$self->load_header_orig
1323	or return;	1803	or return;
		1804	$self->prepare_orig;
		1805	}
1324		1806
1325	# for better error messages only, will be overwritten	1807	$self->{deny_reset} = 1
1326	$map->path ($path);	1808	if $self->no_reset;
1327		1809
1328	$map->load_header ($path)	1810	$self->default_region (cf::region::find_by_path $self->{path})
1329	or return;	1811	unless $self->default_region;
1330		1812
1331	$map->{load_path} = $path;	1813	1
1332
1333	$map
1334	}	1814	}
1335		1815
1336	sub find;	1816	sub find;
1337	sub find {	1817	sub find {
1338	my ($path, $origin) = @_;	1818	my ($path, $origin) = @_;
1339		1819
1340	#warn "find<$path,$origin>\n";#d#
1341
1342	$path = new cf::path $path, $origin && $origin->path;	1820	$path = normalise $path, $origin && $origin->path;
1343	my $key = $path->as_string;
1344		1821
1345	cf::lock_wait "map_find:$key";	1822	cf::lock_wait "map_find:$path";
1346		1823
1347	$cf::MAP{$key} || do {	1824	$cf::MAP{$path} || do {
1348	my $guard = cf::lock_acquire "map_find:$key";	1825	my $guard = cf::lock_acquire "map_find:$path";
1349		1826	my $map = new_from_path cf::map $path
1350	# do it the slow way
1351	my $map = try_load_header $path->save_path;
1352
1353	Coro::cede;
1354
1355	if ($map) {
1356	$map->last_access ((delete $map->{last_access})
1357	|| $cf::RUNTIME); #d#
1358	# safety
1359	$map->{instantiate_time} = $cf::RUNTIME
1360	if $map->{instantiate_time} > $cf::RUNTIME;
1361	} else {
1362	if (my $rmp = $path->random_map_params) {
1363	$map = generate_random_map $key, $rmp;
1364	} else {
1365	$map = try_load_header $path->load_path;
1366	}
1367
1368	$map or return;	1827	or return;
1369		1828
1370	$map->{load_original} = 1;
1371	$map->{instantiate_time} = $cf::RUNTIME;
1372	$map->last_access ($cf::RUNTIME);
1373	$map->instantiate;
1374
1375	# per-player maps become, after loading, normal maps
1376	$map->per_player (0) if $path->{user_rel};
1377	}
1378
1379	$map->path ($key);
1380	$map->{path} = $path;
1381	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1382		1830
1383	Coro::cede;	1831	$map->load_header
		1832	or return;
1384		1833
1385	if ($map->should_reset) {	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1835	# doing this can freeze the server in a sync job, obviously
		1836	#$cf::WAIT_FOR_TICK->wait;
1386	$map->reset;	1837	$map->reset;
1387	undef $guard;	1838	undef $guard;
1388	$map = find $path	1839	return find $path;
1389	or return;
1390	}	1840	}
1391		1841
1392	$cf::MAP{$key} = $map	1842	$cf::MAP{$path} = $map
1393	}	1843	}
1394	}	1844	}
		1845
		1846	sub pre_load { }
		1847	sub post_load { }
1395		1848
1396	sub load {	1849	sub load {
1397	my ($self) = @_;	1850	my ($self) = @_;
1398		1851
		1852	local $self->{deny_reset} = 1; # loading can take a long time
		1853
1399	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1400	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1401		1859
1402	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1403		1861
1404	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1405		1863
1406	$self->alloc;	1864	$self->alloc;
		1865
		1866	$self->pre_load;
		1867	cf::cede_to_tick;
		1868
1407	$self->load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1408	or return;	1870	or return;
1409		1871
1410	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1411	if delete $self->{load_original};	1873	if delete $self->{load_original};
1412		1874
1413	if (my $uniq = $path->uniq_path) {	1875	if (my $uniq = $self->uniq_path) {
1414	utf8::encode $uniq;	1876	utf8::encode $uniq;
1415	if (aio_open $uniq, O_RDONLY, 0) {	1877	if (aio_open $uniq, O_RDONLY, 0) {
1416	$self->clear_unique_items;	1878	$self->clear_unique_items;
1417	$self->load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1418	}	1880	}
1419	}	1881	}
1420		1882
1421	Coro::cede;	1883	cf::cede_to_tick;
1422
1423	# now do the right thing for maps	1884	# now do the right thing for maps
1424	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1425
1426	if ($self->{path}->is_style_map) {
1427	$self->{deny_save} = 1;
1428	$self->{deny_reset} = 1;
1429	} else {
1430	$self->fix_auto_apply;
1431	$self->decay_objects;
1432	$self->update_buttons;
1433	$self->set_darkness_map;
1434	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1435	unless $self->difficulty;	1887	unless $self->difficulty;
		1888	cf::cede_to_tick;
		1889
		1890	unless ($self->{deny_activate}) {
		1891	$self->decay_objects;
		1892	$self->fix_auto_apply;
		1893	$self->update_buttons;
		1894	cf::cede_to_tick;
		1895	$self->set_darkness_map;
		1896	cf::cede_to_tick;
1436	$self->activate;	1897	$self->activate;
1437	}	1898	}
1438		1899
1439	Coro::cede;	1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
1440		1902
1441	$self->in_memory (cf::MAP_IN_MEMORY);	1903	$self->in_memory (cf::MAP_IN_MEMORY);
		1904	}
		1905
		1906	$self->post_load;
		1907	}
		1908
		1909	sub customise_for {
		1910	my ($self, $ob) = @_;
		1911
		1912	return find "~" . $ob->name . "/" . $self->{path}
		1913	if $self->per_player;
		1914
		1915	# return find "?party/" . $ob->name . "/" . $self->{path}
		1916	# if $self->per_party;
		1917
		1918	$self
1442	}	1919	}
1443		1920
1444	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1445	sub load_diag {	1922	sub load_neighbours {
1446	my ($map) = @_;	1923	my ($map) = @_;
1447		1924
1448	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1449		1926
1450	for (0 .. 3) {	1927	for (0 .. 3) {
1451	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1452	or next;	1929	or next;
1453	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1454	or next;	1931	or next;
1455	$neigh->load;	1932	$neigh->load;
1456		1933
		1934	push @neigh,
1457	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1458	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1459	}	1937	}
1460		1938
1461	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1462	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1463	or next;	1942	or next;
1464	$neigh->load;	1943	$neigh->load;
1465	}	1944	}
1466	}	1945	}
1467		1946
…		…
1472	}	1951	}
1473		1952
1474	sub do_load_sync {	1953	sub do_load_sync {
1475	my ($map) = @_;	1954	my ($map) = @_;
1476		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1477	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1478	}	1960	}
1479		1961
1480	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
		1963	our $MAP_PREFETCHER = undef;
		1964
		1965	sub find_async {
		1966	my ($path, $origin, $load) = @_;
		1967
		1968	$path = normalise $path, $origin && $origin->{path};
		1969
		1970	if (my $map = $cf::MAP{$path}) {
		1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		1972	}
		1973
		1974	$MAP_PREFETCH{$path} |= $load;
		1975
1481	our $MAP_PREFETCHER = Coro::async {	1976	$MAP_PREFETCHER ||= cf::async {
1482	while () {
1483	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1484	my $key = each %MAP_PREFETCH	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1485	or next;	1979	if (my $map = find $k) {
		1980	$map->load if $v;
		1981	}
		1982
1486	my $path = delete $MAP_PREFETCH{$key};	1983	delete $MAP_PREFETCH{$k};
1487
1488	my $map = find $path
1489	or next;
1490	$map->load;
1491	}	1984	}
1492	Coro::schedule;	1985	}
		1986	undef $MAP_PREFETCHER;
1493	}	1987	};
1494	};
1495
1496	sub find_async {
1497	my ($path, $origin) = @_;
1498
1499	$path = new cf::path $path, $origin && $origin->path;
1500	my $key = $path->as_string;
1501
1502	if (my $map = $cf::MAP{$key}) {
1503	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1504	}
1505
1506	$MAP_PREFETCH{$key} = $path;
1507	$MAP_PREFETCHER->ready;	1988	$MAP_PREFETCHER->prio (6);
1508		1989
1509	()	1990	()
1510	}	1991	}
1511		1992
1512	sub save {	1993	sub save {
1513	my ($self) = @_;	1994	my ($self) = @_;
1514		1995
1515	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1516		1997
1517	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1518		1999
1519	return unless $self->dirty;	2000	return unless $self->dirty;
1520		2001
1521	my $save = $self->{path}->save_path; utf8::encode $save;	2002	my $save = $self->save_path; utf8::encode $save;
1522	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2003	my $uniq = $self->uniq_path; utf8::encode $uniq;
1523		2004
1524	$self->{load_path} = $save;	2005	$self->{load_path} = $save;
1525		2006
1526	return if $self->{deny_save};	2007	return if $self->{deny_save};
1527		2008
…		…
1530	cf::async {	2011	cf::async {
1531	$_->contr->save for $self->players;	2012	$_->contr->save for $self->players;
1532	};	2013	};
1533		2014
1534	if ($uniq) {	2015	if ($uniq) {
1535	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2016	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1536	$self->save_objects ($uniq, cf::IO_UNIQUES);	2017	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1537	} else {	2018	} else {
1538	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2019	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1539	}	2020	}
1540	}	2021	}
1541		2022
1542	sub swap_out {	2023	sub swap_out {
1543	my ($self) = @_;	2024	my ($self) = @_;
1544		2025
1545	# save first because save cedes	2026	# save first because save cedes
1546	$self->save;	2027	$self->save;
1547		2028
1548	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1549		2030
1550	return if $self->players;	2031	return if $self->players;
1551	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1552	return if $self->{deny_save};	2033	return if $self->{deny_save};
1553		2034
…		…
1557		2038
1558	sub reset_at {	2039	sub reset_at {
1559	my ($self) = @_;	2040	my ($self) = @_;
1560		2041
1561	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1562	return 1e99 if $self->{path}{user_rel};
1563	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1564		2044
1565	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1566	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1567		2047
…		…
1572	my ($self) = @_;	2052	my ($self) = @_;
1573		2053
1574	$self->reset_at <= $cf::RUNTIME	2054	$self->reset_at <= $cf::RUNTIME
1575	}	2055	}
1576		2056
1577	sub unlink_save {
1578	my ($self) = @_;
1579
1580	utf8::encode (my $save = $self->{path}->save_path);
1581	aioreq_pri 3; IO::AIO::aio_unlink $save;
1582	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1583	}
1584
1585	sub rename {
1586	my ($self, $new_path) = @_;
1587
1588	$self->unlink_save;
1589
1590	delete $cf::MAP{$self->path};
1591	$self->{path} = new cf::path $new_path;
1592	$self->path ($self->{path}->as_string);
1593	$cf::MAP{$self->path} = $self;
1594
1595	$self->save;
1596	}
1597
1598	sub reset {	2057	sub reset {
1599	my ($self) = @_;	2058	my ($self) = @_;
1600		2059
1601	my $lock = cf::lock_acquire "map_data:" . $self->path;	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1602		2061
1603	return if $self->players;	2062	return if $self->players;
1604	return if $self->{path}{user_rel};#d#
1605		2063
1606	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1607		2075
1608	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
		2077
		2078	$self->clear;
1609		2079
1610	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1611		2081
1612	$self->unlink_save;	2082	$self->unlink_save;
1613	$self->destroy;	2083	$self->destroy;
…		…
1616	my $nuke_counter = "aaaa";	2086	my $nuke_counter = "aaaa";
1617		2087
1618	sub nuke {	2088	sub nuke {
1619	my ($self) = @_;	2089	my ($self) = @_;
1620		2090
		2091	delete $cf::MAP{$self->path};
		2092
		2093	$self->unlink_save;
		2094
		2095	bless $self, "cf::map";
		2096	delete $self->{deny_reset};
1621	$self->{deny_save} = 1;	2097	$self->{deny_save} = 1;
1622	$self->reset_timeout (1);	2098	$self->reset_timeout (1);
1623	$self->rename ("{nuke}/" . ($nuke_counter++));	2099	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2100
		2101	$cf::MAP{$self->path} = $self;
		2102
1624	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1625	}	2104	}
1626		2105
1627	sub customise_for {	2106	=item $maps = cf::map::tmp_maps
1628	my ($map, $ob) = @_;
1629		2107
1630	if ($map->per_player) {	2108	Returns an arrayref with all map paths of currently instantiated and saved
1631	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
1632	}	2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
1633		2123
1634	$map	2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
		2142	=item cf::map::unique_maps
		2143
		2144	Returns an arrayref of paths of all shared maps that have
		2145	instantiated unique items. May block.
		2146
		2147	=cut
		2148
		2149	sub unique_maps() {
		2150	[
		2151	map {
		2152	utf8::decode $_;
		2153	/\.map$/
		2154	? normalise $_
		2155	: ()
		2156	} @{ aio_readdir $UNIQUEDIR or [] }
		2157	]
1635	}	2158	}
1636		2159
1637	package cf;	2160	package cf;
1638		2161
1639	=back	2162	=back
…		…
1685		2208
1686	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1687		2210
1688	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1689	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1690	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $dialog = $pl->{npc_dialog};
		2219	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2220
		2221	} else {
1691	$msg = $npc->name . " says: $msg" if $npc;	2222	$msg = $npc->name . " says: $msg" if $npc;
1692	$self->message ($msg, $flags);	2223	$self->message ($msg, $flags);
		2224	}
1693	}	2225	}
		2226	}
		2227
		2228	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2229
		2230	=cut
		2231
		2232	sub cf::object::send_msg {
		2233	my $pl = shift->contr
		2234	or return;
		2235	$pl->send_msg (@_);
1694	}	2236	}
1695		2237
1696	=item $player_object->may ("access")	2238	=item $player_object->may ("access")
1697		2239
1698	Returns wether the given player is authorized to access resource "access"	2240	Returns wether the given player is authorized to access resource "access"
…		…
1711		2253
1712	=item $player_object->enter_link	2254	=item $player_object->enter_link
1713		2255
1714	Freezes the player and moves him/her to a special map (C<{link}>).	2256	Freezes the player and moves him/her to a special map (C<{link}>).
1715		2257
1716	The player should be reaosnably safe there for short amounts of time. You	2258	The player should be reasonably safe there for short amounts of time. You
1717	I<MUST> call C<leave_link> as soon as possible, though.	2259	I<MUST> call C<leave_link> as soon as possible, though.
1718		2260
		2261	Will never block.
		2262
1719	=item $player_object->leave_link ($map, $x, $y)	2263	=item $player_object->leave_link ($map, $x, $y)
1720		2264
1721	Moves the player out of the specila link map onto the given map. If the	2265	Moves the player out of the special C<{link}> map onto the specified
1722	map is not valid (or omitted), the player will be moved back to the	2266	map. If the map is not valid (or omitted), the player will be moved back
1723	location he/she was before the call to C<enter_link>, or, if that fails,	2267	to the location he/she was before the call to C<enter_link>, or, if that
1724	to the emergency map position.	2268	fails, to the emergency map position.
1725		2269
1726	Might block.	2270	Might block.
1727		2271
1728	=cut	2272	=cut
		2273
		2274	sub link_map {
		2275	unless ($LINK_MAP) {
		2276	$LINK_MAP = cf::map::find "{link}"
		2277	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2278	$LINK_MAP->load;
		2279	}
		2280
		2281	$LINK_MAP
		2282	}
1729		2283
1730	sub cf::object::player::enter_link {	2284	sub cf::object::player::enter_link {
1731	my ($self) = @_;	2285	my ($self) = @_;
1732		2286
1733	$self->deactivate_recursive;	2287	$self->deactivate_recursive;
1734		2288
1735	return if $self->map == $LINK_MAP;	2289	return if UNIVERSAL::isa $self->map, "ext::map_link";
1736		2290
1737	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2291	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1738	if $self->map;	2292	if $self->map && $self->map->{path} ne "{link}";
1739		2293
1740	$self->enter_map ($LINK_MAP, 20, 20);	2294	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1741	}	2295	}
1742		2296
1743	sub cf::object::player::leave_link {	2297	sub cf::object::player::leave_link {
1744	my ($self, $map, $x, $y) = @_;	2298	my ($self, $map, $x, $y) = @_;
		2299
		2300	return unless $self->contr->active;
1745		2301
1746	my $link_pos = delete $self->{_link_pos};	2302	my $link_pos = delete $self->{_link_pos};
1747		2303
1748	unless ($map) {	2304	unless ($map) {
1749	# restore original map position	2305	# restore original map position
…		…
1763	# use -1 or undef as default coordinates, not 0, 0	2319	# use -1 or undef as default coordinates, not 0, 0
1764	($x, $y) = ($map->enter_x, $map->enter_y)	2320	($x, $y) = ($map->enter_x, $map->enter_y)
1765	if $x <=0 && $y <= 0;	2321	if $x <=0 && $y <= 0;
1766		2322
1767	$map->load;	2323	$map->load;
1768	$map->load_diag;	2324	$map->load_neighbours;
1769		2325
1770	return unless $self->contr->active;	2326	return unless $self->contr->active;
1771	$self->activate_recursive;	2327	$self->activate_recursive;
		2328
		2329	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1772	$self->enter_map ($map, $x, $y);	2330	$self->enter_map ($map, $x, $y);
1773	}	2331	}
1774		2332
1775	cf::player->attach (	2333	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1776	on_logout => sub {
1777	my ($pl) = @_;
1778		2334
1779	# abort map switching before logout	2335	Moves the player to the given map-path and coordinates by first freezing
1780	if ($pl->ob->{_link_pos}) {	2336	her, loading and preparing them map, calling the provided $check callback
1781	cf::sync_job {	2337	that has to return the map if sucecssful, and then unfreezes the player on
1782	$pl->ob->leave_link	2338	the new (success) or old (failed) map position. In either case, $done will
1783	};	2339	be called at the end of this process.
1784	}
1785	},
1786	on_login => sub {
1787	my ($pl) = @_;
1788		2340
1789	# try to abort aborted map switching on player login :)
1790	# should happen only on crashes
1791	if ($pl->ob->{_link_pos}) {
1792	$pl->ob->enter_link;
1793	(async {
1794	# we need this sleep as the login has a concurrent enter_exit running
1795	# and this sleep increases chances of the player not ending up in scorn
1796	$pl->ob->reply (undef,
1797	"There was an internal problem at your last logout, "
1798	. "the server will try to bring you to your intended destination in a second.",
1799	cf::NDI_RED);
1800	Coro::Timer::sleep 1;
1801	$pl->ob->leave_link;
1802	})->prio (2);
1803	}
1804	},
1805	);
1806
1807	=item $player_object->goto ($path, $x, $y)
1808
1809	=cut	2341	=cut
		2342
		2343	our $GOTOGEN;
1810		2344
1811	sub cf::object::player::goto {	2345	sub cf::object::player::goto {
1812	my ($self, $path, $x, $y) = @_;	2346	my ($self, $path, $x, $y, $check, $done) = @_;
1813		2347
1814	$path = new cf::path $path;	2348	# do generation counting so two concurrent goto's will be executed in-order
1815	$path ne "/" or Carp::cluck ("oy");#d#	2349	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1816		2350
1817	$self->enter_link;	2351	$self->enter_link;
1818		2352
1819	(async {	2353	(async {
		2354	my $map = eval {
1820	my $map = cf::map::find $path->as_string;	2355	my $map = cf::map::find $path;
		2356
		2357	if ($map) {
1821	$map = $map->customise_for ($self) if $map;	2358	$map = $map->customise_for ($self);
1822		2359	$map = $check->($map) if $check && $map;
1823	# warn "entering ", $map->path, " at ($x, $y)\n"	2360	} else {
1824	# if $map;
1825
1826	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2361	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2362	}
1827		2363
		2364	$map
		2365	};
		2366
		2367	if ($@) {
		2368	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	LOG llevError | logBacktrace, Carp::longmess $@;
		2370	}
		2371
		2372	if ($gen == $self->{_goto_generation}) {
		2373	delete $self->{_goto_generation};
1828	$self->leave_link ($map, $x, $y);	2374	$self->leave_link ($map, $x, $y);
		2375	}
		2376
		2377	$done->() if $done;
1829	})->prio (1);	2378	})->prio (1);
1830	}	2379	}
1831		2380
1832	=item $player_object->enter_exit ($exit_object)	2381	=item $player_object->enter_exit ($exit_object)
1833		2382
…		…
1835		2384
1836	sub parse_random_map_params {	2385	sub parse_random_map_params {
1837	my ($spec) = @_;	2386	my ($spec) = @_;
1838		2387
1839	my $rmp = { # defaults	2388	my $rmp = { # defaults
1840	xsize => 10,	2389	xsize => (cf::rndm 15, 40),
1841	ysize => 10,	2390	ysize => (cf::rndm 15, 40),
		2391	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2392	#layout => string,
1842	};	2393	};
1843		2394
1844	for (split /\n/, $spec) {	2395	for (split /\n/, $spec) {
1845	my ($k, $v) = split /\s+/, $_, 2;	2396	my ($k, $v) = split /\s+/, $_, 2;
1846		2397
…		…
1850	$rmp	2401	$rmp
1851	}	2402	}
1852		2403
1853	sub prepare_random_map {	2404	sub prepare_random_map {
1854	my ($exit) = @_;	2405	my ($exit) = @_;
		2406
		2407	my $guard = cf::lock_acquire "exit_prepare:$exit";
1855		2408
1856	# all this does is basically replace the /! path by	2409	# all this does is basically replace the /! path by
1857	# a new random map path (?random/...) with a seed	2410	# a new random map path (?random/...) with a seed
1858	# that depends on the exit object	2411	# that depends on the exit object
1859		2412
1860	my $rmp = parse_random_map_params $exit->msg;	2413	my $rmp = parse_random_map_params $exit->msg;
1861		2414
1862	if ($exit->map) {	2415	if ($exit->map) {
1863	$rmp->{region} = $exit->map->region_name;	2416	$rmp->{region} = $exit->region->name;
1864	$rmp->{origin_map} = $exit->map->path;	2417	$rmp->{origin_map} = $exit->map->path;
1865	$rmp->{origin_x} = $exit->x;	2418	$rmp->{origin_x} = $exit->x;
1866	$rmp->{origin_y} = $exit->y;	2419	$rmp->{origin_y} = $exit->y;
1867	}	2420	}
1868		2421
1869	$rmp->{random_seed} ||= $exit->random_seed;	2422	$rmp->{random_seed} ||= $exit->random_seed;
1870		2423
1871	my $data = cf::to_json $rmp;	2424	my $data = cf::to_json $rmp;
1872	my $md5 = Digest::MD5::md5_hex $data;	2425	my $md5 = Digest::MD5::md5_hex $data;
		2426	my $meta = "$RANDOMDIR/$md5.meta";
1873		2427
1874	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2428	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1875	aio_write $fh, 0, (length $data), $data, 0;	2429	aio_write $fh, 0, (length $data), $data, 0;
		2430	undef $fh;
		2431	aio_rename "$meta~", $meta;
1876		2432
1877	$exit->slaying ("?random/$md5");	2433	$exit->slaying ("?random/$md5");
1878	$exit->msg (undef);	2434	$exit->msg (undef);
1879	}	2435	}
1880	}	2436	}
…		…
1882	sub cf::object::player::enter_exit {	2438	sub cf::object::player::enter_exit {
1883	my ($self, $exit) = @_;	2439	my ($self, $exit) = @_;
1884		2440
1885	return unless $self->type == cf::PLAYER;	2441	return unless $self->type == cf::PLAYER;
1886		2442
		2443	if ($exit->slaying eq "/!") {
		2444	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2445	# the problem is that $exit might not survive long enough
		2446	# so it needs to be done right now, right here
		2447	cf::sync_job { prepare_random_map $exit };
		2448	}
		2449
		2450	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2451	my $hp = $exit->stats->hp;
		2452	my $sp = $exit->stats->sp;
		2453
1887	$self->enter_link;	2454	$self->enter_link;
		2455
		2456	# if exit is damned, update players death & WoR home-position
		2457	$self->contr->savebed ($slaying, $hp, $sp)
		2458	if $exit->flag (FLAG_DAMNED);
1888		2459
1889	(async {	2460	(async {
1890	$self->deactivate_recursive; # just to be sure	2461	$self->deactivate_recursive; # just to be sure
1891	unless (eval {	2462	unless (eval {
1892	prepare_random_map $exit	2463	$self->goto ($slaying, $hp, $sp);
1893	if $exit->slaying eq "/!";
1894
1895	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1896	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1897		2464
1898	1;	2465	1;
1899	}) {	2466	}) {
1900	$self->message ("Something went wrong deep within the crossfire server. "	2467	$self->message ("Something went wrong deep within the crossfire server. "
1901	. "I'll try to bring you back to the map you were before. "	2468	. "I'll try to bring you back to the map you were before. "
1902	. "Please report this to the dungeon master",	2469	. "Please report this to the dungeon master!",
1903	cf::NDI_UNIQUE | cf::NDI_RED);	2470	cf::NDI_UNIQUE | cf::NDI_RED);
1904		2471
1905	warn "ERROR in enter_exit: $@";	2472	warn "ERROR in enter_exit: $@";
1906	$self->leave_link;	2473	$self->leave_link;
1907	}	2474	}
1908	})->prio (1);	2475	})->prio (1);
…		…
1921		2488
1922	sub cf::client::send_drawinfo {	2489	sub cf::client::send_drawinfo {
1923	my ($self, $text, $flags) = @_;	2490	my ($self, $text, $flags) = @_;
1924		2491
1925	utf8::encode $text;	2492	utf8::encode $text;
1926	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2493	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1927	}	2494	}
1928		2495
		2496	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2497
		2498	Send a drawinfo or msg packet to the client, formatting the msg for the
		2499	client if neccessary. C<$type> should be a string identifying the type of
		2500	the message, with C<log> being the default. If C<$color> is negative, suppress
		2501	the message unless the client supports the msg packet.
		2502
		2503	=cut
		2504
		2505	sub cf::client::send_msg {
		2506	my ($self, $channel, $msg, $color, @extra) = @_;
		2507
		2508	$msg = $self->pl->expand_cfpod ($msg);
		2509
		2510	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2511
		2512	if (ref $channel) {
		2513	# send meta info to client, if not yet sent
		2514	unless (exists $self->{channel}{$channel->{id}}) {
		2515	$self->{channel}{$channel->{id}} = $channel;
		2516	$self->ext_msg (channel_info => $channel);
		2517	}
		2518
		2519	$channel = $channel->{id};
		2520	}
		2521
		2522	return unless @extra || length $msg;
		2523
		2524	if ($self->can_msg) {
		2525	# default colour, mask it out
		2526	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2527	if $color & cf::NDI_DEF;
		2528
		2529	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2530	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2531	} else {
		2532	if ($color >= 0) {
		2533	# replace some tags by gcfclient-compatible ones
		2534	for ($msg) {
		2535	1 while
		2536	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2537	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2538	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2539	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2540	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2541	}
		2542
		2543	$color &= cf::NDI_COLOR_MASK;
		2544
		2545	utf8::encode $msg;
		2546
		2547	if (0 && $msg =~ /\[/) {
		2548	# COMMAND/INFO
		2549	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2550	} else {
		2551	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2552	$self->send_packet ("drawinfo $color $msg")
		2553	}
		2554	}
		2555	}
		2556	}
		2557
		2558	=item $client->ext_msg ($type, @msg)
		2559
		2560	Sends an ext event to the client.
		2561
		2562	=cut
		2563
		2564	sub cf::client::ext_msg($$@) {
		2565	my ($self, $type, @msg) = @_;
		2566
		2567	if ($self->extcmd == 2) {
		2568	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2569	} elsif ($self->extcmd == 1) { # TODO: remove
		2570	push @msg, msgtype => "event_$type";
		2571	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2572	}
		2573	}
		2574
		2575	=item $client->ext_reply ($msgid, @msg)
		2576
		2577	Sends an ext reply to the client.
		2578
		2579	=cut
		2580
		2581	sub cf::client::ext_reply($$@) {
		2582	my ($self, $id, @msg) = @_;
		2583
		2584	if ($self->extcmd == 2) {
		2585	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2586	} elsif ($self->extcmd == 1) {
		2587	#TODO: version 1, remove
		2588	unshift @msg, msgtype => "reply", msgid => $id;
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2590	}
		2591	}
1929		2592
1930	=item $success = $client->query ($flags, "text", \&cb)	2593	=item $success = $client->query ($flags, "text", \&cb)
1931		2594
1932	Queues a query to the client, calling the given callback with	2595	Queues a query to the client, calling the given callback with
1933	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2596	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1934	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2597	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1935		2598
1936	Queries can fail, so check the return code. Or don't, as queries will become	2599	Queries can fail, so check the return code. Or don't, as queries will
1937	reliable at some point in the future.	2600	become reliable at some point in the future.
1938		2601
1939	=cut	2602	=cut
1940		2603
1941	sub cf::client::query {	2604	sub cf::client::query {
1942	my ($self, $flags, $text, $cb) = @_;	2605	my ($self, $flags, $text, $cb) = @_;
…		…
1950	utf8::encode $text;	2613	utf8::encode $text;
1951	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2614	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1952		2615
1953	$self->send_packet ($self->{query_queue}[0][0])	2616	$self->send_packet ($self->{query_queue}[0][0])
1954	if @{ $self->{query_queue} } == 1;	2617	if @{ $self->{query_queue} } == 1;
		2618
		2619	1
1955	}	2620	}
1956		2621
1957	cf::client->attach (	2622	cf::client->attach (
		2623	on_connect => sub {
		2624	my ($ns) = @_;
		2625
		2626	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2627	},
1958	on_reply => sub {	2628	on_reply => sub {
1959	my ($ns, $msg) = @_;	2629	my ($ns, $msg) = @_;
1960		2630
1961	# this weird shuffling is so that direct followup queries	2631	# this weird shuffling is so that direct followup queries
1962	# get handled first	2632	# get handled first
1963	my $queue = delete $ns->{query_queue}	2633	my $queue = delete $ns->{query_queue}
1964	or return; # be conservative, not sure how that can happen, but we saw a crash here	2634	or return; # be conservative, not sure how that can happen, but we saw a crash here
1965		2635
1966	(shift @$queue)->[1]->($msg);	2636	(shift @$queue)->[1]->($msg);
		2637	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1967		2638
1968	push @{ $ns->{query_queue} }, @$queue;	2639	push @{ $ns->{query_queue} }, @$queue;
1969		2640
1970	if (@{ $ns->{query_queue} } == @$queue) {	2641	if (@{ $ns->{query_queue} } == @$queue) {
1971	if (@$queue) {	2642	if (@$queue) {
…		…
1973	} else {	2644	} else {
1974	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2645	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1975	}	2646	}
1976	}	2647	}
1977	},	2648	},
		2649	on_exticmd => sub {
		2650	my ($ns, $buf) = @_;
		2651
		2652	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2653
		2654	if (ref $msg) {
		2655	my ($type, $reply, @payload) =
		2656	"ARRAY" eq ref $msg
		2657	? @$msg
		2658	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2659
		2660	my @reply;
		2661
		2662	if (my $cb = $EXTICMD{$type}) {
		2663	@reply = $cb->($ns, @payload);
		2664	}
		2665
		2666	$ns->ext_reply ($reply, @reply)
		2667	if $reply;
		2668
		2669	} else {
		2670	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2671	}
		2672
		2673	cf::override;
		2674	},
1978	);	2675	);
1979		2676
1980	=item $client->async (\&cb)	2677	=item $client->async (\&cb)
1981		2678
1982	Create a new coroutine, running the specified callback. The coroutine will	2679	Create a new coroutine, running the specified callback. The coroutine will
…		…
2023	our $safe = new Safe "safe";	2720	our $safe = new Safe "safe";
2024	our $safe_hole = new Safe::Hole;	2721	our $safe_hole = new Safe::Hole;
2025		2722
2026	$SIG{FPE} = 'IGNORE';	2723	$SIG{FPE} = 'IGNORE';
2027		2724
2028	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2725	$safe->permit_only (Opcode::opset qw(
		2726	:base_core :base_mem :base_orig :base_math
		2727	grepstart grepwhile mapstart mapwhile
		2728	sort time
		2729	));
2029		2730
2030	# here we export the classes and methods available to script code	2731	# here we export the classes and methods available to script code
2031		2732
2032	=pod	2733	=pod
2033		2734
2034	The following fucntions and emthods are available within a safe environment:	2735	The following functions and methods are available within a safe environment:
2035		2736
2036	cf::object contr pay_amount pay_player map	2737	cf::object
		2738	contr pay_amount pay_player map x y force_find force_add
		2739	insert remove name archname title slaying race decrease_ob_nr
		2740
2037	cf::object::player player	2741	cf::object::player
2038	cf::player peaceful	2742	player
2039	cf::map trigger	2743
		2744	cf::player
		2745	peaceful
		2746
		2747	cf::map
		2748	trigger
2040		2749
2041	=cut	2750	=cut
2042		2751
2043	for (	2752	for (
2044	["cf::object" => qw(contr pay_amount pay_player map)],	2753	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2754	insert remove inv name archname title slaying race
		2755	decrease_ob_nr)],
2045	["cf::object::player" => qw(player)],	2756	["cf::object::player" => qw(player)],
2046	["cf::player" => qw(peaceful)],	2757	["cf::player" => qw(peaceful)],
2047	["cf::map" => qw(trigger)],	2758	["cf::map" => qw(trigger)],
2048	) {	2759	) {
2049	no strict 'refs';	2760	no strict 'refs';
…		…
2120	=back	2831	=back
2121		2832
2122	=cut	2833	=cut
2123		2834
2124	#############################################################################	2835	#############################################################################
		2836	# the server's init and main functions
2125		2837
2126	=head2 EXTENSION DATABASE SUPPORT	2838	sub load_facedata($) {
		2839	my ($path) = @_;
2127		2840
2128	Crossfire maintains a very simple database for extension use. It can	2841	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2129	currently store anything that can be serialised using Storable, which
2130	excludes objects.
2131		2842
2132	The parameter C<$family> should best start with the name of the extension	2843	warn "loading facedata from $path\n";
2133	using it, it should be unique.
2134		2844
2135	=over 4	2845	my $facedata;
		2846	0 < aio_load $path, $facedata
		2847	or die "$path: $!";
2136		2848
2137	=item $hashref = cf::db_get $family	2849	$facedata = Coro::Storable::thaw $facedata;
2138		2850
2139	Return a hashref for use by the extension C<$family>, which can be	2851	$facedata->{version} == 2
2140	modified. After modifications, you have to call C<cf::db_dirty> or	2852	or cf::cleanup "$path: version mismatch, cannot proceed.";
2141	C<cf::db_sync>.
2142		2853
2143	=item $value = cf::db_get $family => $key	2854	# patch in the exptable
2144		2855	$facedata->{resource}{"res/exp_table"} = {
2145	Returns a single value from the database	2856	type => FT_RSRC,
2146		2857	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2147	=item cf::db_put $family => $hashref
2148
2149	Stores the given family hashref into the database. Updates are delayed, if
2150	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2151
2152	=item cf::db_put $family => $key => $value
2153
2154	Stores the given C<$value> in the family hash. Updates are delayed, if you
2155	want the data to be synced to disk immediately, use C<cf::db_sync>.
2156
2157	=item cf::db_dirty
2158
2159	Marks the database as dirty, to be updated at a later time.
2160
2161	=item cf::db_sync
2162
2163	Immediately write the database to disk I<if it is dirty>.
2164
2165	=cut
2166
2167	our $DB;
2168
2169	{
2170	my $path = cf::localdir . "/database.pst";
2171
2172	sub db_load() {
2173	$DB = stat $path ? Storable::retrieve $path : { };
2174	}
2175
2176	my $pid;
2177
2178	sub db_save() {
2179	waitpid $pid, 0 if $pid;
2180	if (0 == ($pid = fork)) {
2181	$DB->{_meta}{version} = 1;
2182	Storable::nstore $DB, "$path~";
2183	rename "$path~", $path;
2184	cf::_exit 0 if defined $pid;
2185	}
2186	}
2187
2188	my $dirty;
2189
2190	sub db_sync() {
2191	db_save if $dirty;
2192	undef $dirty;
2193	}
2194
2195	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2196	db_sync;
2197	});	2858	};
		2859	cf::cede_to_tick;
2198		2860
2199	sub db_dirty() {
2200	$dirty = 1;
2201	$idle->start;
2202	}	2861	{
		2862	my $faces = $facedata->{faceinfo};
2203		2863
2204	sub db_get($;$) {	2864	while (my ($face, $info) = each %$faces) {
2205	@_ >= 2	2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2206	? $DB->{$_[0]}{$_[1]}	2866	cf::face::set_visibility $idx, $info->{visibility};
2207	: ($DB->{$_[0]} ||= { })	2867	cf::face::set_magicmap $idx, $info->{magicmap};
2208	}	2868	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2869	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2209		2870
2210	sub db_put($$;$) {	2871	cf::cede_to_tick;
2211	if (@_ >= 3) {
2212	$DB->{$_[0]}{$_[1]} = $_[2];
2213	} else {
2214	$DB->{$_[0]} = $_[1];
2215	}
2216	db_dirty;
2217	}
2218
2219	cf::global->attach (
2220	prio => 10000,
2221	on_cleanup => sub {
2222	db_sync;
2223	},	2872	}
2224	);
2225	}
2226		2873
2227	#############################################################################	2874	while (my ($face, $info) = each %$faces) {
2228	# the server's main()	2875	next unless $info->{smooth};
		2876	my $idx = cf::face::find $face
		2877	or next;
		2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
		2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2881	} else {
		2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2883	}
2229		2884
2230	sub cfg_load {	2885	cf::cede_to_tick;
		2886	}
		2887	}
		2888
		2889	{
		2890	my $anims = $facedata->{animinfo};
		2891
		2892	while (my ($anim, $info) = each %$anims) {
		2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2894	cf::cede_to_tick;
		2895	}
		2896
		2897	cf::anim::invalidate_all; # d'oh
		2898	}
		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904
		2905	my $soundconf = delete $res->{"res/sound.conf"};
		2906
		2907	while (my ($name, $info) = each %$res) {
		2908	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2909	my $data;
		2910
		2911	if ($info->{type} & 1) {
		2912	# prepend meta info
		2913
		2914	my $meta = $enc->encode ({
		2915	name => $name,
		2916	%{ $info->{meta} || {} },
		2917	});
		2918
		2919	$data = pack "(w/a*)*", $meta, $info->{data};
		2920	} else {
		2921	$data = $info->{data};
		2922	}
		2923
		2924	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2925	cf::face::set_type $idx, $info->{type};
		2926
		2927	cf::cede_to_tick;
		2928	}
		2929
		2930	if ($soundconf) {
		2931	$soundconf = $enc->decode (delete $soundconf->{data});
		2932
		2933	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2934	my $sound = $soundconf->{compat}[$_]
		2935	or next;
		2936
		2937	my $face = cf::face::find "sound/$sound->[1]";
		2938	cf::sound::set $sound->[0] => $face;
		2939	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2940	}
		2941
		2942	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2943	my $face = cf::face::find "sound/$v";
		2944	cf::sound::set $k => $face;
		2945	}
		2946	}
		2947	}
		2948
		2949	1
		2950	}
		2951
		2952	register_exticmd fx_want => sub {
		2953	my ($ns, $want) = @_;
		2954
		2955	while (my ($k, $v) = each %$want) {
		2956	$ns->fx_want ($k, $v);
		2957	}
		2958	};
		2959
		2960	sub reload_regions {
		2961	load_resource_file "$MAPDIR/regions"
		2962	or die "unable to load regions file\n";
		2963
		2964	for (cf::region::list) {
		2965	$_->{match} = qr/$_->{match}/
		2966	if exists $_->{match};
		2967	}
		2968	}
		2969
		2970	sub reload_facedata {
		2971	load_facedata "$DATADIR/facedata"
		2972	or die "unable to load facedata\n";
		2973	}
		2974
		2975	sub reload_archetypes {
		2976	load_resource_file "$DATADIR/archetypes"
		2977	or die "unable to load archetypes\n";
		2978	#d# NEED to laod twice to resolve forward references
		2979	# this really needs to be done in an extra post-pass
		2980	# (which needs to be synchronous, so solve it differently)
		2981	load_resource_file "$DATADIR/archetypes"
		2982	or die "unable to load archetypes\n";
		2983	}
		2984
		2985	sub reload_treasures {
		2986	load_resource_file "$DATADIR/treasures"
		2987	or die "unable to load treasurelists\n";
		2988	}
		2989
		2990	sub reload_resources {
		2991	warn "reloading resource files...\n";
		2992
		2993	reload_regions;
		2994	reload_facedata;
		2995	#reload_archetypes;#d#
		2996	reload_archetypes;
		2997	reload_treasures;
		2998
		2999	warn "finished reloading resource files\n";
		3000	}
		3001
		3002	sub init {
		3003	reload_resources;
		3004	}
		3005
		3006	sub reload_config {
2231	open my $fh, "<:utf8", cf::confdir . "/config"	3007	open my $fh, "<:utf8", "$CONFDIR/config"
2232	or return;	3008	or return;
2233		3009
2234	local $/;	3010	local $/;
2235	*CFG = YAML::Syck::Load <$fh>;	3011	*CFG = YAML::Syck::Load <$fh>;
2236		3012
…		…
2250		3026
2251	sub main {	3027	sub main {
2252	# we must not ever block the main coroutine	3028	# we must not ever block the main coroutine
2253	local $Coro::idle = sub {	3029	local $Coro::idle = sub {
2254	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3030	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3031	(async {
2255	async { Event::one_event };	3032	Event::one_event;
		3033	})->prio (Coro::PRIO_MAX);
2256	};	3034	};
2257		3035
2258	cfg_load;	3036	reload_config;
2259	db_load;	3037	db_init;
2260	load_extensions;	3038	load_extensions;
		3039
		3040	$TICK_WATCHER->start;
2261	Event::loop;	3041	Event::loop;
2262	}	3042	}
2263		3043
2264	#############################################################################	3044	#############################################################################
2265	# initialisation and cleanup	3045	# initialisation and cleanup
2266		3046
2267	# install some emergency cleanup handlers	3047	# install some emergency cleanup handlers
2268	BEGIN {	3048	BEGIN {
2269	for my $signal (qw(INT HUP TERM)) {	3049	for my $signal (qw(INT HUP TERM)) {
2270	Event->signal (	3050	Event->signal (
		3051	reentrant => 0,
2271	data => WF_AUTOCANCEL,	3052	data => WF_AUTOCANCEL,
2272	signal => $signal,	3053	signal => $signal,
		3054	prio => 0,
2273	cb => sub {	3055	cb => sub {
2274	cf::cleanup "SIG$signal";	3056	cf::cleanup "SIG$signal";
2275	},	3057	},
2276	);	3058	);
2277	}	3059	}
2278	}	3060	}
2279		3061
		3062	sub write_runtime {
		3063	my $runtime = "$LOCALDIR/runtime";
		3064
		3065	# first touch the runtime file to show we are still running:
		3066	# the fsync below can take a very very long time.
		3067
		3068	IO::AIO::aio_utime $runtime, undef, undef;
		3069
		3070	my $guard = cf::lock_acquire "write_runtime";
		3071
		3072	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3073	or return;
		3074
		3075	my $value = $cf::RUNTIME + 90 + 10;
		3076	# 10 is the runtime save interval, for a monotonic clock
		3077	# 60 allows for the watchdog to kill the server.
		3078
		3079	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3080	and return;
		3081
		3082	# always fsync - this file is important
		3083	aio_fsync $fh
		3084	and return;
		3085
		3086	# touch it again to show we are up-to-date
		3087	aio_utime $fh, undef, undef;
		3088
		3089	close $fh
		3090	or return;
		3091
		3092	aio_rename "$runtime~", $runtime
		3093	and return;
		3094
		3095	warn "runtime file written.\n";
		3096
		3097	1
		3098	}
		3099
2280	sub emergency_save() {	3100	sub emergency_save() {
2281	my $freeze_guard = cf::freeze_mainloop;	3101	my $freeze_guard = cf::freeze_mainloop;
2282		3102
2283	warn "enter emergency perl save\n";	3103	warn "enter emergency perl save\n";
2284		3104
2285	cf::sync_job {	3105	cf::sync_job {
2286	# use a peculiar iteration method to avoid tripping on perl	3106	# use a peculiar iteration method to avoid tripping on perl
2287	# refcount bugs in for. also avoids problems with players	3107	# refcount bugs in for. also avoids problems with players
2288	# and maps saved/Destroyed asynchronously.	3108	# and maps saved/destroyed asynchronously.
2289	warn "begin emergency player save\n";	3109	warn "begin emergency player save\n";
2290	for my $login (keys %cf::PLAYER) {	3110	for my $login (keys %cf::PLAYER) {
2291	my $pl = $cf::PLAYER{$login} or next;	3111	my $pl = $cf::PLAYER{$login} or next;
2292	$pl->valid or next;	3112	$pl->valid or next;
2293	$pl->save;	3113	$pl->save;
…		…
2299	my $map = $cf::MAP{$path} or next;	3119	my $map = $cf::MAP{$path} or next;
2300	$map->valid or next;	3120	$map->valid or next;
2301	$map->save;	3121	$map->save;
2302	}	3122	}
2303	warn "end emergency map save\n";	3123	warn "end emergency map save\n";
		3124
		3125	warn "begin emergency database checkpoint\n";
		3126	BDB::db_env_txn_checkpoint $DB_ENV;
		3127	warn "end emergency database checkpoint\n";
2304	};	3128	};
2305		3129
2306	warn "leave emergency perl save\n";	3130	warn "leave emergency perl save\n";
2307	}	3131	}
2308		3132
		3133	sub post_cleanup {
		3134	my ($make_core) = @_;
		3135
		3136	warn Carp::longmess "post_cleanup backtrace"
		3137	if $make_core;
		3138	}
		3139
2309	sub reload() {	3140	sub do_reload_perl() {
2310	# can/must only be called in main	3141	# can/must only be called in main
2311	if ($Coro::current != $Coro::main) {	3142	if ($Coro::current != $Coro::main) {
2312	warn "can only reload from main coroutine\n";	3143	warn "can only reload from main coroutine";
2313	return;	3144	return;
2314	}	3145	}
2315		3146
2316	warn "reloading...";	3147	warn "reloading...";
2317		3148
2318	my $guard = freeze_mainloop;	3149	warn "entering sync_job";
		3150
		3151	cf::sync_job {
		3152	cf::write_runtime; # external watchdog should not bark
2319	cf::emergency_save;	3153	cf::emergency_save;
		3154	cf::write_runtime; # external watchdog should not bark
2320		3155
2321	eval {	3156	warn "syncing database to disk";
		3157	BDB::db_env_txn_checkpoint $DB_ENV;
		3158
2322	# if anything goes wrong in here, we should simply crash as we already saved	3159	# if anything goes wrong in here, we should simply crash as we already saved
2323		3160
2324	# cancel all watchers	3161	warn "cancelling all WF_AUTOCANCEL watchers";
2325	for (Event::all_watchers) {	3162	for (Event::all_watchers) {
2326	$_->cancel if $_->data & WF_AUTOCANCEL;	3163	$_->cancel if $_->data & WF_AUTOCANCEL;
2327	}	3164	}
2328		3165
		3166	warn "flushing outstanding aio requests";
		3167	for (;;) {
		3168	BDB::flush;
		3169	IO::AIO::flush;
		3170	Coro::cede;
		3171	last unless IO::AIO::nreqs || BDB::nreqs;
		3172	warn "iterate...";
		3173	}
		3174
		3175	++$RELOAD;
		3176
2329	# cancel all extension coros	3177	warn "cancelling all extension coros";
2330	$_->cancel for values %EXT_CORO;	3178	$_->cancel for values %EXT_CORO;
2331	%EXT_CORO = ();	3179	%EXT_CORO = ();
2332		3180
2333	# unload all extensions	3181	warn "removing commands";
2334	for (@exts) {	3182	%COMMAND = ();
		3183
		3184	warn "removing ext/exti commands";
		3185	%EXTCMD = ();
		3186	%EXTICMD = ();
		3187
		3188	warn "unloading/nuking all extensions";
		3189	for my $pkg (@EXTS) {
2335	warn "unloading <$_>";	3190	warn "... unloading $pkg";
2336	unload_extension $_;	3191
		3192	if (my $cb = $pkg->can ("unload")) {
		3193	eval {
		3194	$cb->($pkg);
		3195	1
		3196	} or warn "$pkg unloaded, but with errors: $@";
2337	}	3197	}
2338		3198
		3199	warn "... nuking $pkg";
		3200	Symbol::delete_package $pkg;
		3201	}
		3202
2339	# unload all modules loaded from $LIBDIR	3203	warn "unloading all perl modules loaded from $LIBDIR";
2340	while (my ($k, $v) = each %INC) {	3204	while (my ($k, $v) = each %INC) {
2341	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3205	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2342		3206
2343	warn "removing <$k>";	3207	warn "... unloading $k";
2344	delete $INC{$k};	3208	delete $INC{$k};
2345		3209
2346	$k =~ s/\.pm$//;	3210	$k =~ s/\.pm$//;
2347	$k =~ s/\//::/g;	3211	$k =~ s/\//::/g;
2348		3212
…		…
2351	}	3215	}
2352		3216
2353	Symbol::delete_package $k;	3217	Symbol::delete_package $k;
2354	}	3218	}
2355		3219
2356	# sync database to disk
2357	cf::db_sync;
2358	IO::AIO::flush;
2359
2360	# get rid of safe::, as good as possible	3220	warn "getting rid of safe::, as good as possible";
2361	Symbol::delete_package "safe::$_"	3221	Symbol::delete_package "safe::$_"
2362	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3222	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2363		3223
2364	# remove register_script_function callbacks
2365	# TODO
2366
2367	# unload cf.pm "a bit"	3224	warn "unloading cf.pm \"a bit\"";
2368	delete $INC{"cf.pm"};	3225	delete $INC{"cf.pm"};
		3226	delete $INC{"cf/pod.pm"};
2369		3227
2370	# don't, removes xs symbols, too,	3228	# don't, removes xs symbols, too,
2371	# and global variables created in xs	3229	# and global variables created in xs
2372	#Symbol::delete_package __PACKAGE__;	3230	#Symbol::delete_package __PACKAGE__;
2373		3231
2374	# reload cf.pm	3232	warn "unload completed, starting to reload now";
		3233
2375	warn "reloading cf.pm";	3234	warn "reloading cf.pm";
2376	require cf;	3235	require cf;
2377	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3236	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2378		3237
2379	# load config and database again	3238	warn "loading config and database again";
2380	cf::cfg_load;	3239	cf::reload_config;
2381	cf::db_load;
2382		3240
2383	# load extensions
2384	warn "load extensions";	3241	warn "loading extensions";
2385	cf::load_extensions;	3242	cf::load_extensions;
2386		3243
2387	# reattach attachments to objects	3244	warn "reattaching attachments to objects/players";
2388	warn "reattach";	3245	_global_reattach; # objects, sockets
2389	_global_reattach;	3246	warn "reattaching attachments to maps";
2390	reattach $_ for values %MAP;	3247	reattach $_ for values %MAP;
2391	};	3248	warn "reattaching attachments to players";
		3249	reattach $_ for values %PLAYER;
2392		3250
2393	if ($@) {	3251	warn "leaving sync_job";
		3252
		3253	1
		3254	} or do {
2394	warn $@;	3255	warn $@;
2395	warn "error while reloading, exiting.";	3256	warn "error while reloading, exiting.";
2396	exit 1;	3257	exit 1;
2397	}	3258	};
2398		3259
2399	warn "reloaded successfully";	3260	warn "reloaded";
2400	};	3261	};
2401		3262
2402	#############################################################################	3263	our $RELOAD_WATCHER; # used only during reload
2403		3264
2404	unless ($LINK_MAP) {	3265	sub reload_perl() {
2405	$LINK_MAP = cf::map::new;	3266	# doing reload synchronously and two reloads happen back-to-back,
		3267	# coro crashes during coro_state_free->destroy here.
2406		3268
2407	$LINK_MAP->width (41);	3269	$RELOAD_WATCHER ||= Event->timer (
2408	$LINK_MAP->height (41);	3270	reentrant => 0,
2409	$LINK_MAP->alloc;
2410	$LINK_MAP->path ("{link}");
2411	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2412	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2413
2414	# dirty hack because... archetypes are not yet loaded
2415	Event->timer (
2416	after => 10,	3271	after => 0,
		3272	data => WF_AUTOCANCEL,
2417	cb => sub {	3273	cb => sub {
2418	$_[0]->w->cancel;	3274	do_reload_perl;
2419		3275	undef $RELOAD_WATCHER;
2420	# provide some exits "home"
2421	my $exit = cf::object::new "exit";
2422
2423	$exit->slaying ($EMERGENCY_POSITION->[0]);
2424	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2425	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2426
2427	$LINK_MAP->insert ($exit->clone, 19, 19);
2428	$LINK_MAP->insert ($exit->clone, 19, 20);
2429	$LINK_MAP->insert ($exit->clone, 19, 21);
2430	$LINK_MAP->insert ($exit->clone, 20, 19);
2431	$LINK_MAP->insert ($exit->clone, 20, 21);
2432	$LINK_MAP->insert ($exit->clone, 21, 19);
2433	$LINK_MAP->insert ($exit->clone, 21, 20);
2434	$LINK_MAP->insert ($exit->clone, 21, 21);
2435
2436	$exit->destroy;
2437	});	3276	},
2438		3277	);
2439	$LINK_MAP->{deny_save} = 1;
2440	$LINK_MAP->{deny_reset} = 1;
2441
2442	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2443	}	3278	}
2444
2445	register "<global>", __PACKAGE__;
2446		3279
2447	register_command "reload" => sub {	3280	register_command "reload" => sub {
2448	my ($who, $arg) = @_;	3281	my ($who, $arg) = @_;
2449		3282
2450	if ($who->flag (FLAG_WIZ)) {	3283	if ($who->flag (FLAG_WIZ)) {
2451	$who->message ("start of reload.");
2452	reload;
2453	$who->message ("end of reload.");	3284	$who->message ("reloading server.");
		3285	async { reload_perl };
2454	}	3286	}
2455	};	3287	};
2456		3288
2457	unshift @INC, $LIBDIR;	3289	unshift @INC, $LIBDIR;
2458		3290
		3291	my $bug_warning = 0;
		3292
		3293	our @WAIT_FOR_TICK;
		3294	our @WAIT_FOR_TICK_BEGIN;
		3295
		3296	sub wait_for_tick {
		3297	return unless $TICK_WATCHER->is_active;
		3298	return if $Coro::current == $Coro::main;
		3299
		3300	my $signal = new Coro::Signal;
		3301	push @WAIT_FOR_TICK, $signal;
		3302	$signal->wait;
		3303	}
		3304
		3305	sub wait_for_tick_begin {
		3306	return unless $TICK_WATCHER->is_active;
		3307	return if $Coro::current == $Coro::main;
		3308
		3309	my $signal = new Coro::Signal;
		3310	push @WAIT_FOR_TICK_BEGIN, $signal;
		3311	$signal->wait;
		3312	}
		3313
		3314	my $min = 1e6;#d#
		3315	my $avg = 10;
2459	$TICK_WATCHER = Event->timer (	3316	$TICK_WATCHER = Event->timer (
2460	reentrant => 0,	3317	reentrant => 0,
		3318	parked => 1,
2461	prio => 0,	3319	prio => 0,
2462	at => $NEXT_TICK || $TICK,	3320	at => $NEXT_TICK || $TICK,
2463	data => WF_AUTOCANCEL,	3321	data => WF_AUTOCANCEL,
2464	cb => sub {	3322	cb => sub {
		3323	if ($Coro::current != $Coro::main) {
		3324	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3325	unless ++$bug_warning > 10;
		3326	return;
		3327	}
		3328
		3329	$NOW = $tick_start = Event::time;
		3330
2465	cf::server_tick; # one server iteration	3331	cf::server_tick; # one server iteration
		3332
		3333	0 && sync_job {#d#
		3334	for(1..10) {
		3335	my $t = Event::time;
		3336	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3337	or die;
		3338
		3339	$map->width (50);
		3340	$map->height (50);
		3341	$map->alloc;
		3342	$map->_load_objects ("/tmp/x.map", 1);
		3343	my $t = Event::time - $t;
		3344
		3345	#next unless $t < 0.0013;#d#
		3346	if ($t < $min) {
		3347	$min = $t;
		3348	}
		3349	$avg = $avg * 0.99 + $t * 0.01;
		3350	}
		3351	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3352	exit 0;
		3353	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3354	};
		3355
2466	$RUNTIME += $TICK;	3356	$RUNTIME += $TICK;
2467	$NEXT_TICK += $TICK;	3357	$NEXT_TICK += $TICK;
2468		3358
2469	$WAIT_FOR_TICK->broadcast;	3359	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2470	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3360	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3361	Coro::async_pool {
		3362	write_runtime
		3363	or warn "ERROR: unable to write runtime file: $!";
		3364	};
		3365	}
		3366
		3367	# my $AFTER = Event::time;
		3368	# warn $AFTER - $NOW;#d#
		3369
		3370	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3371	$sig->send;
		3372	}
		3373	while (my $sig = shift @WAIT_FOR_TICK) {
		3374	$sig->send;
		3375	}
		3376
		3377	$NOW = Event::time;
2471		3378
2472	# if we are delayed by four ticks or more, skip them all	3379	# if we are delayed by four ticks or more, skip them all
2473	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3380	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2474		3381
2475	$TICK_WATCHER->at ($NEXT_TICK);	3382	$TICK_WATCHER->at ($NEXT_TICK);
2476	$TICK_WATCHER->start;	3383	$TICK_WATCHER->start;
		3384
		3385	$LOAD = ($NOW - $tick_start) / $TICK;
		3386	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3387
		3388	_post_tick;
		3389
		3390
2477	},	3391	},
2478	);	3392	);
2479		3393
		3394	{
2480	IO::AIO::max_poll_time $TICK * 0.2;	3395	BDB::max_poll_time $TICK * 0.1;
2481		3396	$BDB_POLL_WATCHER = Event->io (
2482	Event->io (	3397	reentrant => 0,
2483	fd => IO::AIO::poll_fileno,	3398	fd => BDB::poll_fileno,
2484	poll => 'r',	3399	poll => 'r',
2485	prio => 5,	3400	prio => 0,
2486	data => WF_AUTOCANCEL,
2487	cb => \&IO::AIO::poll_cb,
2488	);
2489
2490	Event->timer (
2491	data => WF_AUTOCANCEL,	3401	data => WF_AUTOCANCEL,
2492	after => 0,	3402	cb => \&BDB::poll_cb,
2493	interval => 10,	3403	);
2494	cb => sub {	3404	BDB::min_parallel 8;
2495	(Coro::unblock_sub {	3405
2496	write_runtime	3406	BDB::set_sync_prepare {
2497	or warn "ERROR: unable to write runtime file: $!";	3407	my $status;
		3408	my $current = $Coro::current;
		3409	(
		3410	sub {
		3411	$status = $!;
		3412	$current->ready; undef $current;
		3413	},
		3414	sub {
		3415	Coro::schedule while defined $current;
		3416	$! = $status;
		3417	},
		3418	)
		3419	};
		3420
		3421	unless ($DB_ENV) {
		3422	$DB_ENV = BDB::db_env_create;
		3423
		3424	cf::sync_job {
		3425	eval {
		3426	BDB::db_env_open
		3427	$DB_ENV,
		3428	$BDBDIR,
		3429	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3430	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3431	0666;
		3432
		3433	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3434
		3435	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3436	$DB_ENV->set_lk_detect;
		3437	};
		3438
		3439	cf::cleanup "db_env_open(db): $@" if $@;
2498	})->();	3440	};
2499	},	3441	}
2500	);	3442	}
		3443
		3444	{
		3445	IO::AIO::min_parallel 8;
		3446
		3447	undef $Coro::AIO::WATCHER;
		3448	IO::AIO::max_poll_time $TICK * 0.1;
		3449	$AIO_POLL_WATCHER = Event->io (
		3450	reentrant => 0,
		3451	data => WF_AUTOCANCEL,
		3452	fd => IO::AIO::poll_fileno,
		3453	poll => 'r',
		3454	prio => 6,
		3455	cb => \&IO::AIO::poll_cb,
		3456	);
		3457	}
		3458
		3459	my $_log_backtrace;
		3460
		3461	sub _log_backtrace {
		3462	my ($msg, @addr) = @_;
		3463
		3464	$msg =~ s/\n//;
		3465
		3466	# limit the # of concurrent backtraces
		3467	if ($_log_backtrace < 2) {
		3468	++$_log_backtrace;
		3469	async {
		3470	my @bt = fork_call {
		3471	@addr = map { sprintf "%x", $_ } @addr;
		3472	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3473	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3474	or die "addr2line: $!";
		3475
		3476	my @funcs;
		3477	my @res = <$fh>;
		3478	chomp for @res;
		3479	while (@res) {
		3480	my ($func, $line) = splice @res, 0, 2, ();
		3481	push @funcs, "[$func] $line";
		3482	}
		3483
		3484	@funcs
		3485	};
		3486
		3487	LOG llevInfo, "[ABT] $msg\n";
		3488	LOG llevInfo, "[ABT] $_\n" for @bt;
		3489	--$_log_backtrace;
		3490	};
		3491	} else {
		3492	LOG llevInfo, "[ABT] $msg\n";
		3493	LOG llevInfo, "[ABT] [suppressed]\n";
		3494	}
		3495	}
		3496
		3497	# load additional modules
		3498	use cf::pod;
2501		3499
2502	END { cf::emergency_save }	3500	END { cf::emergency_save }
2503		3501
2504	1	3502	1
2505		3503

Diff Legend

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