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

Diff Legend

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