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

Diff Legend

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