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

Diff Legend

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