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

Diff Legend

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