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.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.370 by root, Thu Sep 13 10:59:41 2007 UTC

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

Diff Legend

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