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

Diff Legend

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