ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.353 by root, Sun Sep 2 08:43:46 2007 UTC

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

Diff Legend

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