ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.138 by root, Fri Jan 5 17:07:17 2007 UTC vs.
Revision 1.332 by root, Sat Aug 18 17:33:53 2007 UTC

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

Diff Legend

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