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

Diff Legend

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