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.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.367 by root, Wed Sep 12 11:10:11 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;
		29	use Digest::MD5;
20	use Fcntl;	30	use Fcntl;
21	use IO::AIO 2.31 ();
22	use YAML::Syck ();	31	use YAML::Syck ();
		32	use IO::AIO 2.32 ();
23	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
24		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
25	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
26		44
27	# 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?
28	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
29		47
30	$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
31		49
32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33		51
34	our %COMMAND = ();	52	our %COMMAND = ();
35	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
36	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
37		60
		61	our $RELOAD; # number of reloads so far
38	our @EVENT;	62	our @EVENT;
39	our $LIBDIR = datadir . "/ext";
40		63
41	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(!)
42	our $TICK_WATCHER;	77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43	our $NEXT_TICK;	80	our $NEXT_TICK;
44	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;
45		88
46	our %CFG;	89	our %CFG;
47		90
48	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
49	our $RUNTIME;	92	our $RUNTIME;
50		93
51	our %MAP; # all maps	94	our (%PLAYER, %PLAYER_LOADING); # all users
52	our $LINK_MAP; # the special {link} map	95	our (%MAP, %MAP_LOADING ); # all maps
53	our $FREEZE;	96	our $LINK_MAP; # the special {link} map, which is always available
		97
		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
54		104
55	binmode STDOUT;	105	binmode STDOUT;
56	binmode STDERR;	106	binmode STDERR;
57		107
58	# read virtual server time, if available	108	# read virtual server time, if available
59	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	109	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
60	open my $fh, "<", cf::localdir . "/runtime"	110	open my $fh, "<", "$LOCALDIR/runtime"
61	or die "unable to read runtime file: $!";	111	or die "unable to read runtime file: $!";
62	$RUNTIME = <$fh> + 0.;	112	$RUNTIME = <$fh> + 0.;
63	}	113	}
64		114
65	mkdir cf::localdir;	115	mkdir $_
66	mkdir cf::localdir . "/" . cf::playerdir;	116	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
67	mkdir cf::localdir . "/" . cf::tmpdir;
68	mkdir cf::localdir . "/" . cf::uniquedir;
69		117
70	our %EXT_CORO;	118	our $EMERGENCY_POSITION;
		119
		120	sub cf::map::normalise;
71		121
72	#############################################################################	122	#############################################################################
73		123
74	=head2 GLOBAL VARIABLES	124	=head2 GLOBAL VARIABLES
75		125
…		…
82	=item $cf::RUNTIME	132	=item $cf::RUNTIME
83		133
84	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
85	every server tick.	135	every server tick.
86		136
87	=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
88		140
89	The perl library directory, where extensions and cf-specific modules can	141	Various directories - "/etc", read-only install directory, perl-library
90	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.
91		145
92	=item $cf::NOW	146	=item $cf::NOW
93		147
94	The time of the last (current) server tick.	148	The time of the last (current) server tick.
95		149
96	=item $cf::TICK	150	=item $cf::TICK
97		151
98	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.
99		163
100	=item %cf::CFG	164	=item %cf::CFG
101		165
102	Configuration for the server, loaded from C</etc/crossfire/config>, or	166	Configuration for the server, loaded from C</etc/crossfire/config>, or
103	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.
104		180
105	=back	181	=back
106		182
107	=cut	183	=cut
108		184
109	BEGIN {	185	BEGIN {
110	*CORE::GLOBAL::warn = sub {	186	*CORE::GLOBAL::warn = sub {
111	my $msg = join "", @_;	187	my $msg = join "", @_;
112	utf8::encode $msg;
113		188
114	$msg .= "\n"	189	$msg .= "\n"
115	unless $msg =~ /\n$/;	190	unless $msg =~ /\n$/;
116		191
		192	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		193
117	LOG llevError, "cfperl: $msg";	194	LOG llevError, $msg;
118	};	195	};
119	}	196	}
120		197
121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	198	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	199	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
123	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	200	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
124	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	201	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
125	@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';
126	@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)
127		205
128	# 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
129	# within the Safe compartment.	207	# within the Safe compartment.
130	for my $pkg (qw(	208	for my $pkg (qw(
131	cf::global cf::attachable	209	cf::global cf::attachable
…		…
140		218
141	$Event::DIED = sub {	219	$Event::DIED = sub {
142	warn "error in event callback: @_";	220	warn "error in event callback: @_";
143	};	221	};
144		222
145	my %ext_pkg;	223	#############################################################################
146	my @exts;
147	my @hook;
148		224
149	=head2 UTILITY FUNCTIONS	225	=head2 UTILITY FUNCTIONS
150		226
151	=over 4	227	=over 4
152		228
153	=cut	229	=item dumpval $ref
154		230
155	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	}
156		251
157	=item $ref = cf::from_json $json	252	=item $ref = cf::from_json $json
158		253
159	Converts a JSON string into the corresponding perl data structure.	254	Converts a JSON string into the corresponding perl data structure.
160		255
161	=cut
162
163	sub from_json($) {
164	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165	JSON::Syck::Load $_[0]
166	}
167
168	=item $json = cf::to_json $ref	256	=item $json = cf::to_json $ref
169		257
170	Converts a perl data structure into its JSON representation.	258	Converts a perl data structure into its JSON representation.
171		259
172	=cut	260	=cut
173		261
174	sub to_json($) {	262	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	263
176	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	}
177	}	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 }
178		405
179	=item cf::sync_job { BLOCK }	406	=item cf::sync_job { BLOCK }
180		407
181	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)
182	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
183	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.
184		412
185	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
186	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
187	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
188	fast or be very important.	416	fast or be very important.
…		…
190	=cut	418	=cut
191		419
192	sub sync_job(&) {	420	sub sync_job(&) {
193	my ($job) = @_;	421	my ($job) = @_;
194		422
195	my $busy = 1;
196	my @res;
197
198	# TODO: use suspend/resume instead
199	local $FREEZE = 1;
200
201	my $coro = Coro::async {
202	@res = eval { $job->() };
203	warn $@ if $@;
204	undef $busy;
205	};
206
207	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;
208	$coro->prio (Coro::PRIO_MAX);	440	})->prio (Coro::PRIO_MAX);
		441
209	while ($busy) {	442	while ($busy) {
210	Coro::cede_notself;	443	Coro::cede or Event::one_event;
211	Event::one_event unless Coro::nready;
212	}	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]
213	} else {	454	} else {
214	$coro->join;	455	# we are in another coroutine, how wonderful, everything just works
		456
		457	$job->()
215	}	458	}
216
217	wantarray ? @res : $res[0]
218	}	459	}
219		460
220	=item $coro = cf::coro { BLOCK }	461	=item $coro = cf::async_ext { BLOCK }
221		462
222	Creates and returns a new coro. This coro is automcatially being canceled	463	Like async, but this coro is automatically being canceled when the
223	when the extension calling this is being unloaded.	464	extension calling this is being unloaded.
224		465
225	=cut	466	=cut
226		467
227	sub coro(&) {	468	sub async_ext(&) {
228	my $cb = shift;	469	my $cb = shift;
229		470
230	my $coro; $coro = async {	471	my $coro = &Coro::async ($cb);
231	eval {
232	$cb->();
233	};
234	warn $@ if $@;
235	};
236		472
237	$coro->on_destroy (sub {	473	$coro->on_destroy (sub {
238	delete $EXT_CORO{$coro+0};	474	delete $EXT_CORO{$coro+0};
239	});	475	});
240	$EXT_CORO{$coro+0} = $coro;	476	$EXT_CORO{$coro+0} = $coro;
241		477
242	$coro	478	$coro
243	}	479	}
244		480
		481	=item fork_call { }, $args
		482
		483	Executes the given code block with the given arguments in a seperate
		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.
		487
		488	=cut
		489
		490	sub fork_call(&@) {
		491	my ($cb, @args) = @_;
		492
		493	# we seemingly have to make a local copy of the whole thing,
		494	# otherwise perl prematurely frees the stuff :/
		495	# TODO: investigate and fix (likely this will be rather laborious)
		496
		497	my @res = Coro::Util::fork_eval {
		498	reset_signals;
		499	&$cb
		500	}, @args;
		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
		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 });
		641	}
		642
245	=back	643	=back
246		644
247	=cut	645	=cut
248		646
249	#############################################################################	647	#############################################################################
…		…
254	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")
255	to it. All such attachable objects support the following methods.	653	to it. All such attachable objects support the following methods.
256		654
257	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>
258	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
259	crossfire+).	657	Crossfire TRT).
260		658
261	=over 4	659	=over 4
262		660
263	=item $attachable->attach ($attachment, key => $value...)	661	=item $attachable->attach ($attachment, key => $value...)
264		662
…		…
378	our @CB_TYPE = (); # registry for type (cf-object class) based events	776	our @CB_TYPE = (); # registry for type (cf-object class) based events
379	our @CB_MAP = ();	777	our @CB_MAP = ();
380		778
381	my %attachment;	779	my %attachment;
382		780
		781	sub cf::attachable::thawer_merge {
		782	# simply override everything except _meta
		783	local $_[0]{_meta};
		784	%{$_[0]} = %{$_[1]};
		785	}
		786
383	sub _attach_cb($$$$) {	787	sub _attach_cb($$$$) {
384	my ($registry, $event, $prio, $cb) = @_;	788	my ($registry, $event, $prio, $cb) = @_;
385		789
386	use sort 'stable';	790	use sort 'stable';
387		791
…		…
421	$registry = $CB_TYPE[$object_type] ||= [];	825	$registry = $CB_TYPE[$object_type] ||= [];
422		826
423	} elsif ($type eq "subtype") {	827	} elsif ($type eq "subtype") {
424	defined $object_type or Carp::croak "subtype specified without type";	828	defined $object_type or Carp::croak "subtype specified without type";
425	my $object_subtype = shift @arg;	829	my $object_subtype = shift @arg;
426	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	830	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
427		831
428	} elsif ($type eq "package") {	832	} elsif ($type eq "package") {
429	my $pkg = shift @arg;	833	my $pkg = shift @arg;
430		834
431	while (my ($name, $id) = each %cb_id) {	835	while (my ($name, $id) = each %cb_id) {
…		…
460	_attach $registry, $klass, @attach;	864	_attach $registry, $klass, @attach;
461	}	865	}
462		866
463	$obj->{$name} = \%arg;	867	$obj->{$name} = \%arg;
464	} else {	868	} else {
465	warn "object uses attachment '$name' that is not available, postponing.\n";	869	warn "object uses attachment '$name' which is not available, postponing.\n";
466	}	870	}
467		871
468	$obj->{_attachment}{$name} = undef;	872	$obj->{_attachment}{$name} = undef;
469	}	873	}
470		874
…		…
472	if (ref $_[0]) {	876	if (ref $_[0]) {
473	_object_attach @_;	877	_object_attach @_;
474	} else {	878	} else {
475	_attach shift->_attach_registry, @_;	879	_attach shift->_attach_registry, @_;
476	}	880	}
		881	_recalc_want;
477	};	882	};
478		883
479	# all those should be optimised	884	# all those should be optimised
480	sub cf::attachable::detach {	885	sub cf::attachable::detach {
481	my ($obj, $name) = @_;	886	my ($obj, $name) = @_;
…		…
484	delete $obj->{_attachment}{$name};	889	delete $obj->{_attachment}{$name};
485	reattach ($obj);	890	reattach ($obj);
486	} else {	891	} else {
487	Carp::croak "cannot, currently, detach class attachments";	892	Carp::croak "cannot, currently, detach class attachments";
488	}	893	}
		894	_recalc_want;
489	};	895	};
490		896
491	sub cf::attachable::attached {	897	sub cf::attachable::attached {
492	my ($obj, $name) = @_;	898	my ($obj, $name) = @_;
493		899
…		…
508	";	914	";
509	die if $@;	915	die if $@;
510	}	916	}
511		917
512	our $override;	918	our $override;
513	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?
514		920
515	sub override {	921	sub override {
516	$override = 1;	922	$override = 1;
517	@invoke_results = ();	923	@INVOKE_RESULTS = (@_);
518	}	924	}
519		925
520	sub do_invoke {	926	sub do_invoke {
521	my $event = shift;	927	my $event = shift;
522	my $callbacks = shift;	928	my $callbacks = shift;
523		929
524	@invoke_results = ();	930	@INVOKE_RESULTS = ();
525		931
526	local $override;	932	local $override;
527		933
528	for (@$callbacks) {	934	for (@$callbacks) {
529	eval { &{$_->[1]} };	935	eval { &{$_->[1]} };
…		…
546		952
547	Generate an object-specific event with the given arguments.	953	Generate an object-specific event with the given arguments.
548		954
549	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
550	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
551	results (if you must, access C<@cf::invoke_results> directly).	957	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
552		958
553	=back	959	=back
554		960
555	=cut	961	=cut
556		962
557	#############################################################################	963	#############################################################################
558	# 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	}
559		976
560	sub reattach {	977	sub reattach {
561	# basically do the same as instantiate, without calling instantiate	978	# basically do the same as instantiate, without calling instantiate
562	my ($obj) = @_;	979	my ($obj) = @_;
		980
		981	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
563		982
564	my $registry = $obj->registry;	983	my $registry = $obj->registry;
565		984
566	@$registry = ();	985	@$registry = ();
567		986
…		…
606	);	1025	);
607		1026
608	sub object_freezer_save {	1027	sub object_freezer_save {
609	my ($filename, $rdata, $objs) = @_;	1028	my ($filename, $rdata, $objs) = @_;
610		1029
		1030	my $guard = cf::lock_acquire "io";
		1031
611	sync_job {	1032	sync_job {
612	if (length $$rdata) {	1033	if (length $$rdata) {
		1034	utf8::decode (my $decname = $filename);
613	warn sprintf "saving %s (%d,%d)\n",	1035	warn sprintf "saving %s (%d,%d)\n",
614	$filename, length $$rdata, scalar @$objs;	1036	$decname, length $$rdata, scalar @$objs;
615		1037
616	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1038	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
617	chmod SAVE_MODE, $fh;	1039	chmod SAVE_MODE, $fh;
618	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1040	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
619	aio_fsync $fh;	1041	aio_fsync $fh if $cf::USE_FSYNC;
620	close $fh;	1042	close $fh;
621		1043
622	if (@$objs) {	1044	if (@$objs) {
623	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) {
624	chmod SAVE_MODE, $fh;	1046	chmod SAVE_MODE, $fh;
625	my $data = Storable::nfreeze { version => 1, objs => $objs };	1047	my $data = Storable::nfreeze { version => 1, objs => $objs };
626	aio_write $fh, 0, (length $data), $data, 0;	1048	aio_write $fh, 0, (length $data), $data, 0;
627	aio_fsync $fh;	1049	aio_fsync $fh if $cf::USE_FSYNC;
628	close $fh;	1050	close $fh;
629	aio_rename "$filename.pst~", "$filename.pst";	1051	aio_rename "$filename.pst~", "$filename.pst";
630	}	1052	}
631	} else {	1053	} else {
632	aio_unlink "$filename.pst";	1054	aio_unlink "$filename.pst";
…		…
638	}	1060	}
639	} else {	1061	} else {
640	aio_unlink $filename;	1062	aio_unlink $filename;
641	aio_unlink "$filename.pst";	1063	aio_unlink "$filename.pst";
642	}	1064	}
643	}	1065	};
		1066
		1067	undef $guard;
644	}	1068	}
645		1069
646	sub object_freezer_as_string {	1070	sub object_freezer_as_string {
647	my ($rdata, $objs) = @_;	1071	my ($rdata, $objs) = @_;
648		1072
…		…
653		1077
654	sub object_thawer_load {	1078	sub object_thawer_load {
655	my ($filename) = @_;	1079	my ($filename) = @_;
656		1080
657	my ($data, $av);	1081	my ($data, $av);
		1082
		1083	my $guard = cf::lock_acquire "io";
658		1084
659	(aio_load $filename, $data) >= 0	1085	(aio_load $filename, $data) >= 0
660	or return;	1086	or return;
661		1087
662	unless (aio_stat "$filename.pst") {	1088	unless (aio_stat "$filename.pst") {
663	(aio_load "$filename.pst", $av) >= 0	1089	(aio_load "$filename.pst", $av) >= 0
664	or return;	1090	or return;
		1091
		1092	undef $guard;
665	$av = eval { (Storable::thaw <$av>)->{objs} };	1093	$av = eval { (Storable::thaw $av)->{objs} };
666	}	1094	}
667		1095
		1096	utf8::decode (my $decname = $filename);
		1097	warn sprintf "loading %s (%d,%d)\n",
		1098	$decname, length $data, scalar @{$av || []};
		1099
668	return ($data, $av);	1100	($data, $av)
669	}	1101	}
		1102
		1103	=head2 COMMAND CALLBACKS
		1104
		1105	=over 4
		1106
		1107	=cut
670		1108
671	#############################################################################	1109	#############################################################################
672	# command handling &c	1110	# command handling &c
673		1111
674	=item cf::register_command $name => \&callback($ob,$args);	1112	=item cf::register_command $name => \&callback($ob,$args);
…		…
687	push @{ $COMMAND{$name} }, [$caller, $cb];	1125	push @{ $COMMAND{$name} }, [$caller, $cb];
688	}	1126	}
689		1127
690	=item cf::register_extcmd $name => \&callback($pl,$packet);	1128	=item cf::register_extcmd $name => \&callback($pl,$packet);
691		1129
692	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.
693		1135
694	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
695	called.	1137	called.
696		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
697	=cut	1150	=cut
698		1151
699	sub register_extcmd {	1152	sub register_extcmd {
700	my ($name, $cb) = @_;	1153	my ($name, $cb) = @_;
701		1154
702	my $caller = caller;
703	#warn "registering extcmd '$name' to '$caller'";
704
705	$EXTCMD{$name} = [$cb, $caller];	1155	$EXTCMD{$name} = $cb;
		1156	}
		1157
		1158	sub register_exticmd {
		1159	my ($name, $cb) = @_;
		1160
		1161	$EXTICMD{$name} = $cb;
706	}	1162	}
707		1163
708	cf::player->attach (	1164	cf::player->attach (
709	on_command => sub {	1165	on_command => sub {
710	my ($pl, $name, $params) = @_;	1166	my ($pl, $name, $params) = @_;
…		…
719	cf::override;	1175	cf::override;
720	},	1176	},
721	on_extcmd => sub {	1177	on_extcmd => sub {
722	my ($pl, $buf) = @_;	1178	my ($pl, $buf) = @_;
723		1179
724	my $msg = eval { from_json $buf };	1180	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
725		1181
726	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
727	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1190	if (my $cb = $EXTCMD{$type}) {
728	if (my %reply = $cb->[0]->($pl, $msg)) {	1191	@reply = $cb->($pl, @payload);
729	$pl->ext_reply ($msg->{msgid}, %reply);
730	}
731	}	1192	}
		1193
		1194	$pl->ext_reply ($reply, @reply)
		1195	if $reply;
		1196
732	} else {	1197	} else {
733	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
734	}	1199	}
735		1200
736	cf::override;	1201	cf::override;
737	},	1202	},
738	);	1203	);
739		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
740	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 {
741	my ($base, $pkg) = @_;	1677	my ($self, $merge) = @_;
742		1678
743	#TODO	1679	# we have to keep some variables in memory intact
744	}	1680	local $self->{path};
		1681	local $self->{load_path};
745		1682
746	sub load_extension {	1683	$self->SUPER::thawer_merge ($merge);
		1684	}
		1685
		1686	sub normalise {
747	my ($path) = @_;	1687	my ($path, $base) = @_;
748		1688
749	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1689	$path = "$path"; # make sure its a string
750	my $base = $1;
751	my $pkg = $1;
752	$pkg =~ s/[^[:word:]]/_/g;
753	$pkg = "ext::$pkg";
754		1690
755	warn "loading '$path' into '$pkg'\n";	1691	$path =~ s/\.map$//;
756		1692
757	open my $fh, "<:utf8", $path	1693	# map plan:
758	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
759		1701
760	my $source =	1702	$path =~ s/$PATH_SEP/\//go;
761	"package $pkg; use strict; use utf8;\n"
762	. "#line 1 \"$path\"\n{\n"
763	. (do { local $/; <$fh> })
764	. "\n};\n1";
765		1703
766	eval $source	1704	# treat it as relative path if it starts with
767	or die $@ ? "$path: $@\n"	1705	# something that looks reasonable
768	: "extension disabled.\n";	1706	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1707	$base or Carp::carp "normalise called with relative path and no base: '$path'";
769		1708
770	push @exts, $pkg;	1709	$base =~ s{[^/]+/?$}{};
771	$ext_pkg{$base} = $pkg;	1710	$path = "$base/$path";
772
773	# no strict 'refs';
774	# @{"$pkg\::ISA"} = ext::;
775
776	register $base, $pkg;
777	}
778
779	sub unload_extension {
780	my ($pkg) = @_;
781
782	warn "removing extension $pkg\n";
783
784	# remove hooks
785	#TODO
786	# for my $idx (0 .. $#PLUGIN_EVENT) {
787	# delete $hook[$idx]{$pkg};
788	# }	1711	}
789		1712
790	# remove commands	1713	for ($path) {
791	for my $name (keys %COMMAND) {	1714	redo if s{//}{/};
792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1715	redo if s{/\.?/}{/};
		1716	redo if s{/[^/]+/\.\./}{/};
		1717	}
793		1718
794	if (@cb) {	1719	$path
795	$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;
796	} else {	1861	} else {
797	delete $COMMAND{$name};	1862	$self->load_header_orig
798	}	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
799	}	1873	1
		1874	}
800		1875
801	# remove extcmds	1876	sub find;
802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1877	sub find {
803	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
804	}	1920	{
		1921	my $guard = cf::lock_acquire "map_data:$path";
805		1922
806	if (my $cb = $pkg->can ("unload")) {	1923	return unless $self->valid;
807	eval {	1924	return unless $self->in_memory == cf::MAP_SWAPPED;
808	$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	}
809	1	1949	}
810	} or warn "$pkg unloaded, but with errors: $@";	1950	}
811	}
812		1951
813	Symbol::delete_package $pkg;	1952	$f->resolve_delayed_derefs;
814	}
815		1953
816	sub load_extensions {	1954	cf::cede_to_tick;
817	for my $ext (<$LIBDIR/*.ext>) {	1955	# now do the right thing for maps
818	next unless -r $ext;	1956	$self->link_multipart_objects;
819	eval {	1957	$self->difficulty ($self->estimate_difficulty)
820	load_extension $ext;	1958	unless $self->difficulty;
821	1	1959	cf::cede_to_tick;
822	} or warn "$ext not loaded: $@";
823	}
824	}
825		1960
826	#############################################################################	1961	unless ($self->{deny_activate}) {
827	# 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	}
828		1970
829	*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 {
830	my ($map) = @_;	1994	my ($map) = @_;
831		1995
832	my $path = $map->tmpname;	1996	my @neigh; # diagonal neighbours
833	defined $path or return;
834		1997
835	unlink "$path.pst";	1998	for (0 .. 3) {
836	};	1999	my $neigh = $map->tile_path ($_)
		2000	or next;
		2001	$neigh = find $neigh, $map
		2002	or next;
		2003	$neigh->load;
837		2004
838	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	}
839		2009
840	#############################################################################	2010	for (grep defined $_->[0], @neigh) {
841	# load/save perl data associated with player->ob objects	2011	my ($path, $origin) = @$_;
842		2012	my $neigh = find $path, $origin
843	sub all_objects(@) {	2013	or next;
844	@_, map all_objects ($_->inv), @_	2014	$neigh->load;
		2015	}
845	}	2016	}
846		2017
847	# TODO: compatibility cruft, remove when no longer needed	2018	sub find_sync {
848	cf::player->attach (	2019	my ($path, $origin) = @_;
849	on_load => sub {
850	my ($pl, $path) = @_;
851		2020
852	for my $o (all_objects $pl->ob) {	2021	cf::sync_job { find $path, $origin }
853	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2022	}
854	$o->set_ob_key_value ("_perl_data");
855		2023
856	%$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};
857	}	2055	}
858	}	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);
859	},	2091	}
860	);	2092	}
861		2093
862	#############################################################################	2094	sub swap_out {
		2095	my ($self) = @_;
863		2096
864	=head2 CORE EXTENSIONS	2097	# save first because save cedes
		2098	$self->save;
865		2099
866	Functions and methods that extend core crossfire objects.	2100	my $lock = cf::lock_acquire "map_data:$self->{path}";
867		2101
868	=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;
869		2247
870	=over 4	2248	=over 4
871		2249
872	=item cf::player::exists $login	2250	=item $ob->inv_recursive
873		2251
874	Returns true when the given account exists.	2252	Returns the inventory of the object _and_ their inventories, recursively.
875		2253
876	=cut	2254	=cut
877		2255
878	sub cf::player::exists($) {	2256	sub inv_recursive_;
879	cf::player::find $_[0]	2257	sub inv_recursive_ {
880	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2258	map { $_, inv_recursive_ $_->inv } @_
881	}	2259	}
882		2260
883	=item $player->ext_reply ($msgid, $msgtype, %msg)	2261	sub inv_recursive {
884		2262	inv_recursive_ inv $_[0]
885	Sends an ext reply to the player.
886
887	=cut
888
889	sub cf::player::ext_reply($$$%) {
890	my ($self, $id, %msg) = @_;
891
892	$msg{msgid} = $id;
893
894	$self->send ("ext " . to_json \%msg);
895	}	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;
896		2297
897	=back	2298	=back
898		2299
899	=head3 cf::object::player	2300	=head3 cf::object::player
900		2301
…		…
916		2317
917	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2318	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
918		2319
919	if ($self->{record_replies}) {	2320	if ($self->{record_replies}) {
920	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2321	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2322
921	} 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 {
922	$msg = $npc->name . " says: $msg" if $npc;	2331	$msg = $npc->name . " says: $msg" if $npc;
923	$self->message ($msg, $flags);	2332	$self->message ($msg, $flags);
		2333	}
924	}	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 (@_);
925	}	2345	}
926		2346
927	=item $player_object->may ("access")	2347	=item $player_object->may ("access")
928		2348
929	Returns wether the given player is authorized to access resource "access"	2349	Returns wether the given player is authorized to access resource "access"
…		…
938	(ref $cf::CFG{"may_$access"}	2358	(ref $cf::CFG{"may_$access"}
939	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2359	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940	: $cf::CFG{"may_$access"})	2360	: $cf::CFG{"may_$access"})
941	}	2361	}
942		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	# todo: use ob_blocked to check all tiles of the destination "object"
		2470	# for suitability.
		2471
		2472	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2473	}
		2474	}
		2475
		2476	my $map = eval {
		2477	my $map = cf::map::find $path;
		2478
		2479	if ($map) {
		2480	$map = $map->customise_for ($self);
		2481	$map = $check->($map) if $check && $map;
		2482	} else {
		2483	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2484	}
		2485
		2486	$map
		2487	};
		2488
		2489	if ($@) {
		2490	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2491	LOG llevError | logBacktrace, Carp::longmess $@;
		2492	}
		2493
		2494	if ($gen == $self->{_goto_generation}) {
		2495	delete $self->{_goto_generation};
		2496	$self->leave_link ($map, $x, $y);
		2497	}
		2498
		2499	$done->() if $done;
		2500	})->prio (1);
		2501	}
		2502
		2503	=item $player_object->enter_exit ($exit_object)
		2504
		2505	=cut
		2506
		2507	sub parse_random_map_params {
		2508	my ($spec) = @_;
		2509
		2510	my $rmp = { # defaults
		2511	xsize => (cf::rndm 15, 40),
		2512	ysize => (cf::rndm 15, 40),
		2513	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2514	#layout => string,
		2515	};
		2516
		2517	for (split /\n/, $spec) {
		2518	my ($k, $v) = split /\s+/, $_, 2;
		2519
		2520	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2521	}
		2522
		2523	$rmp
		2524	}
		2525
		2526	sub prepare_random_map {
		2527	my ($exit) = @_;
		2528
		2529	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2530
		2531	# all this does is basically replace the /! path by
		2532	# a new random map path (?random/...) with a seed
		2533	# that depends on the exit object
		2534
		2535	my $rmp = parse_random_map_params $exit->msg;
		2536
		2537	if ($exit->map) {
		2538	$rmp->{region} = $exit->region->name;
		2539	$rmp->{origin_map} = $exit->map->path;
		2540	$rmp->{origin_x} = $exit->x;
		2541	$rmp->{origin_y} = $exit->y;
		2542	}
		2543
		2544	$rmp->{random_seed} ||= $exit->random_seed;
		2545
		2546	my $data = cf::to_json $rmp;
		2547	my $md5 = Digest::MD5::md5_hex $data;
		2548	my $meta = "$RANDOMDIR/$md5.meta";
		2549
		2550	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2551	aio_write $fh, 0, (length $data), $data, 0;
		2552	undef $fh;
		2553	aio_rename "$meta~", $meta;
		2554
		2555	$exit->slaying ("?random/$md5");
		2556	$exit->msg (undef);
		2557	}
		2558	}
		2559
		2560	sub cf::object::player::enter_exit {
		2561	my ($self, $exit) = @_;
		2562
		2563	return unless $self->type == cf::PLAYER;
		2564
		2565	if ($exit->slaying eq "/!") {
		2566	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2567	# the problem is that $exit might not survive long enough
		2568	# so it needs to be done right now, right here
		2569	cf::sync_job { prepare_random_map $exit };
		2570	}
		2571
		2572	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2573	my $hp = $exit->stats->hp;
		2574	my $sp = $exit->stats->sp;
		2575
		2576	$self->enter_link;
		2577
		2578	# if exit is damned, update players death & WoR home-position
		2579	$self->contr->savebed ($slaying, $hp, $sp)
		2580	if $exit->flag (FLAG_DAMNED);
		2581
		2582	(async {
		2583	$self->deactivate_recursive; # just to be sure
		2584	unless (eval {
		2585	$self->goto ($slaying, $hp, $sp);
		2586
		2587	1;
		2588	}) {
		2589	$self->message ("Something went wrong deep within the crossfire server. "
		2590	. "I'll try to bring you back to the map you were before. "
		2591	. "Please report this to the dungeon master!",
		2592	cf::NDI_UNIQUE | cf::NDI_RED);
		2593
		2594	warn "ERROR in enter_exit: $@";
		2595	$self->leave_link;
		2596	}
		2597	})->prio (1);
		2598	}
		2599
943	=head3 cf::client	2600	=head3 cf::client
944		2601
945	=over 4	2602	=over 4
946		2603
947	=item $client->send_drawinfo ($text, $flags)	2604	=item $client->send_drawinfo ($text, $flags)
…		…
953		2610
954	sub cf::client::send_drawinfo {	2611	sub cf::client::send_drawinfo {
955	my ($self, $text, $flags) = @_;	2612	my ($self, $text, $flags) = @_;
956		2613
957	utf8::encode $text;	2614	utf8::encode $text;
958	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2615	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
959	}	2616	}
960		2617
		2618	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2619
		2620	Send a drawinfo or msg packet to the client, formatting the msg for the
		2621	client if neccessary. C<$type> should be a string identifying the type of
		2622	the message, with C<log> being the default. If C<$color> is negative, suppress
		2623	the message unless the client supports the msg packet.
		2624
		2625	=cut
		2626
		2627	our %CHANNEL = (
		2628	"c/identify" => {
		2629	id => "identify",
		2630	title => "Identify",
		2631	reply => undef,
		2632	tooltip => "Items recently identified",
		2633	},
		2634	"c/examine" => {
		2635	id => "examine",
		2636	title => "Examine",
		2637	reply => undef,
		2638	tooltip => "Signs and other items you examined",
		2639	},
		2640	);
		2641
		2642	sub cf::client::send_msg {
		2643	my ($self, $channel, $msg, $color, @extra) = @_;
		2644
		2645	$msg = $self->pl->expand_cfpod ($msg);
		2646
		2647	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2648
		2649	# check predefined channels, for the benefit of C
		2650	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2651
		2652	if (ref $channel) {
		2653	# send meta info to client, if not yet sent
		2654	unless (exists $self->{channel}{$channel->{id}}) {
		2655	$self->{channel}{$channel->{id}} = $channel;
		2656	$self->ext_msg (channel_info => $channel)
		2657	if $self->can_msg;
		2658	}
		2659
		2660	$channel = $channel->{id};
		2661	}
		2662
		2663	return unless @extra || length $msg;
		2664
		2665	if ($self->can_msg) {
		2666	# default colour, mask it out
		2667	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2668	if $color & cf::NDI_DEF;
		2669
		2670	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2671	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2672	} else {
		2673	if ($color >= 0) {
		2674	# replace some tags by gcfclient-compatible ones
		2675	for ($msg) {
		2676	1 while
		2677	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2678	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2679	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2680	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2681	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2682	}
		2683
		2684	$color &= cf::NDI_COLOR_MASK;
		2685
		2686	utf8::encode $msg;
		2687
		2688	if (0 && $msg =~ /\[/) {
		2689	# COMMAND/INFO
		2690	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2691	} else {
		2692	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2693	$self->send_packet ("drawinfo $color $msg")
		2694	}
		2695	}
		2696	}
		2697	}
		2698
		2699	=item $client->ext_msg ($type, @msg)
		2700
		2701	Sends an ext event to the client.
		2702
		2703	=cut
		2704
		2705	sub cf::client::ext_msg($$@) {
		2706	my ($self, $type, @msg) = @_;
		2707
		2708	if ($self->extcmd == 2) {
		2709	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2710	} elsif ($self->extcmd == 1) { # TODO: remove
		2711	push @msg, msgtype => "event_$type";
		2712	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2713	}
		2714	}
		2715
		2716	=item $client->ext_reply ($msgid, @msg)
		2717
		2718	Sends an ext reply to the client.
		2719
		2720	=cut
		2721
		2722	sub cf::client::ext_reply($$@) {
		2723	my ($self, $id, @msg) = @_;
		2724
		2725	if ($self->extcmd == 2) {
		2726	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2727	} elsif ($self->extcmd == 1) {
		2728	#TODO: version 1, remove
		2729	unshift @msg, msgtype => "reply", msgid => $id;
		2730	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2731	}
		2732	}
961		2733
962	=item $success = $client->query ($flags, "text", \&cb)	2734	=item $success = $client->query ($flags, "text", \&cb)
963		2735
964	Queues a query to the client, calling the given callback with	2736	Queues a query to the client, calling the given callback with
965	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2737	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
966	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2738	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
967		2739
968	Queries can fail, so check the return code. Or don't, as queries will become	2740	Queries can fail, so check the return code. Or don't, as queries will
969	reliable at some point in the future.	2741	become reliable at some point in the future.
970		2742
971	=cut	2743	=cut
972		2744
973	sub cf::client::query {	2745	sub cf::client::query {
974	my ($self, $flags, $text, $cb) = @_;	2746	my ($self, $flags, $text, $cb) = @_;
…		…
982	utf8::encode $text;	2754	utf8::encode $text;
983	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2755	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
984		2756
985	$self->send_packet ($self->{query_queue}[0][0])	2757	$self->send_packet ($self->{query_queue}[0][0])
986	if @{ $self->{query_queue} } == 1;	2758	if @{ $self->{query_queue} } == 1;
		2759
		2760	1
987	}	2761	}
988		2762
989	cf::client->attach (	2763	cf::client->attach (
		2764	on_connect => sub {
		2765	my ($ns) = @_;
		2766
		2767	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2768	},
990	on_reply => sub {	2769	on_reply => sub {
991	my ($ns, $msg) = @_;	2770	my ($ns, $msg) = @_;
992		2771
993	# this weird shuffling is so that direct followup queries	2772	# this weird shuffling is so that direct followup queries
994	# get handled first	2773	# get handled first
995	my $queue = delete $ns->{query_queue};	2774	my $queue = delete $ns->{query_queue}
		2775	or return; # be conservative, not sure how that can happen, but we saw a crash here
996		2776
997	(shift @$queue)->[1]->($msg);	2777	(shift @$queue)->[1]->($msg);
		2778	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
998		2779
999	push @{ $ns->{query_queue} }, @$queue;	2780	push @{ $ns->{query_queue} }, @$queue;
1000		2781
1001	if (@{ $ns->{query_queue} } == @$queue) {	2782	if (@{ $ns->{query_queue} } == @$queue) {
1002	if (@$queue) {	2783	if (@$queue) {
…		…
1004	} else {	2785	} else {
1005	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2786	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1006	}	2787	}
1007	}	2788	}
1008	},	2789	},
		2790	on_exticmd => sub {
		2791	my ($ns, $buf) = @_;
		2792
		2793	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2794
		2795	if (ref $msg) {
		2796	my ($type, $reply, @payload) =
		2797	"ARRAY" eq ref $msg
		2798	? @$msg
		2799	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2800
		2801	my @reply;
		2802
		2803	if (my $cb = $EXTICMD{$type}) {
		2804	@reply = $cb->($ns, @payload);
		2805	}
		2806
		2807	$ns->ext_reply ($reply, @reply)
		2808	if $reply;
		2809
		2810	} else {
		2811	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2812	}
		2813
		2814	cf::override;
		2815	},
1009	);	2816	);
1010		2817
1011	=item $client->coro (\&cb)	2818	=item $client->async (\&cb)
1012		2819
1013	Create a new coroutine, running the specified callback. The coroutine will	2820	Create a new coroutine, running the specified callback. The coroutine will
1014	be automatically cancelled when the client gets destroyed (e.g. on logout,	2821	be automatically cancelled when the client gets destroyed (e.g. on logout,
1015	or loss of connection).	2822	or loss of connection).
1016		2823
1017	=cut	2824	=cut
1018		2825
1019	sub cf::client::coro {	2826	sub cf::client::async {
1020	my ($self, $cb) = @_;	2827	my ($self, $cb) = @_;
1021		2828
1022	my $coro; $coro = async {	2829	my $coro = &Coro::async ($cb);
1023	eval {
1024	$cb->();
1025	};
1026	warn $@ if $@;
1027	};
1028		2830
1029	$coro->on_destroy (sub {	2831	$coro->on_destroy (sub {
1030	delete $self->{_coro}{$coro+0};	2832	delete $self->{_coro}{$coro+0};
1031	});	2833	});
1032		2834
…		…
1059	our $safe = new Safe "safe";	2861	our $safe = new Safe "safe";
1060	our $safe_hole = new Safe::Hole;	2862	our $safe_hole = new Safe::Hole;
1061		2863
1062	$SIG{FPE} = 'IGNORE';	2864	$SIG{FPE} = 'IGNORE';
1063		2865
1064	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2866	$safe->permit_only (Opcode::opset qw(
		2867	:base_core :base_mem :base_orig :base_math
		2868	grepstart grepwhile mapstart mapwhile
		2869	sort time
		2870	));
1065		2871
1066	# here we export the classes and methods available to script code	2872	# here we export the classes and methods available to script code
1067		2873
1068	=pod	2874	=pod
1069		2875
1070	The following fucntions and emthods are available within a safe environment:	2876	The following functions and methods are available within a safe environment:
1071		2877
1072	cf::object contr pay_amount pay_player map	2878	cf::object
		2879	contr pay_amount pay_player map x y force_find force_add
		2880	insert remove name archname title slaying race decrease_ob_nr
		2881
1073	cf::object::player player	2882	cf::object::player
1074	cf::player peaceful	2883	player
1075	cf::map trigger	2884
		2885	cf::player
		2886	peaceful
		2887
		2888	cf::map
		2889	trigger
1076		2890
1077	=cut	2891	=cut
1078		2892
1079	for (	2893	for (
1080	["cf::object" => qw(contr pay_amount pay_player map)],	2894	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2895	insert remove inv name archname title slaying race
		2896	decrease_ob_nr)],
1081	["cf::object::player" => qw(player)],	2897	["cf::object::player" => qw(player)],
1082	["cf::player" => qw(peaceful)],	2898	["cf::player" => qw(peaceful)],
1083	["cf::map" => qw(trigger)],	2899	["cf::map" => qw(trigger)],
1084	) {	2900	) {
1085	no strict 'refs';	2901	no strict 'refs';
…		…
1156	=back	2972	=back
1157		2973
1158	=cut	2974	=cut
1159		2975
1160	#############################################################################	2976	#############################################################################
		2977	# the server's init and main functions
1161		2978
1162	=head2 EXTENSION DATABASE SUPPORT	2979	sub load_facedata($) {
		2980	my ($path) = @_;
1163		2981
1164	Crossfire maintains a very simple database for extension use. It can	2982	# HACK to clear player env face cache, we need some signal framework
1165	currently store anything that can be serialised using Storable, which	2983	# for this (global event?)
1166	excludes objects.	2984	%ext::player_env::MUSIC_FACE_CACHE = ();
1167		2985
1168	The parameter C<$family> should best start with the name of the extension	2986	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1169	using it, it should be unique.
1170		2987
1171	=over 4	2988	warn "loading facedata from $path\n";
1172		2989
1173	=item $hashref = cf::db_get $family	2990	my $facedata;
		2991	0 < aio_load $path, $facedata
		2992	or die "$path: $!";
1174		2993
1175	Return a hashref for use by the extension C<$family>, which can be	2994	$facedata = Coro::Storable::thaw $facedata;
1176	modified. After modifications, you have to call C<cf::db_dirty> or
1177	C<cf::db_sync>.
1178		2995
1179	=item $value = cf::db_get $family => $key	2996	$facedata->{version} == 2
		2997	or cf::cleanup "$path: version mismatch, cannot proceed.";
1180		2998
1181	Returns a single value from the database	2999	# patch in the exptable
1182		3000	$facedata->{resource}{"res/exp_table"} = {
1183	=item cf::db_put $family => $hashref	3001	type => FT_RSRC,
1184		3002	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1185	Stores the given family hashref into the database. Updates are delayed, if
1186	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1187
1188	=item cf::db_put $family => $key => $value
1189
1190	Stores the given C<$value> in the family hash. Updates are delayed, if you
1191	want the data to be synced to disk immediately, use C<cf::db_sync>.
1192
1193	=item cf::db_dirty
1194
1195	Marks the database as dirty, to be updated at a later time.
1196
1197	=item cf::db_sync
1198
1199	Immediately write the database to disk I<if it is dirty>.
1200
1201	=cut
1202
1203	our $DB;
1204
1205	{
1206	my $path = cf::localdir . "/database.pst";
1207
1208	sub db_load() {
1209	warn "loading database $path\n";#d# remove later
1210	$DB = stat $path ? Storable::retrieve $path : { };
1211	}
1212
1213	my $pid;
1214
1215	sub db_save() {
1216	warn "saving database $path\n";#d# remove later
1217	waitpid $pid, 0 if $pid;
1218	if (0 == ($pid = fork)) {
1219	$DB->{_meta}{version} = 1;
1220	Storable::nstore $DB, "$path~";
1221	rename "$path~", $path;
1222	cf::_exit 0 if defined $pid;
1223	}
1224	}
1225
1226	my $dirty;
1227
1228	sub db_sync() {
1229	db_save if $dirty;
1230	undef $dirty;
1231	}
1232
1233	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1234	db_sync;
1235	});	3003	};
		3004	cf::cede_to_tick;
1236		3005
1237	sub db_dirty() {
1238	$dirty = 1;
1239	$idle->start;
1240	}	3006	{
		3007	my $faces = $facedata->{faceinfo};
1241		3008
1242	sub db_get($;$) {	3009	while (my ($face, $info) = each %$faces) {
1243	@_ >= 2	3010	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1244	? $DB->{$_[0]}{$_[1]}	3011	cf::face::set_visibility $idx, $info->{visibility};
1245	: ($DB->{$_[0]} ||= { })	3012	cf::face::set_magicmap $idx, $info->{magicmap};
1246	}	3013	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3014	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1247		3015
1248	sub db_put($$;$) {	3016	cf::cede_to_tick;
1249	if (@_ >= 3) {
1250	$DB->{$_[0]}{$_[1]} = $_[2];
1251	} else {
1252	$DB->{$_[0]} = $_[1];
1253	}
1254	db_dirty;
1255	}
1256
1257	cf::global->attach (
1258	prio => 10000,
1259	on_cleanup => sub {
1260	db_sync;
1261	},	3017	}
1262	);
1263	}
1264		3018
1265	#############################################################################	3019	while (my ($face, $info) = each %$faces) {
1266	# the server's main()	3020	next unless $info->{smooth};
		3021	my $idx = cf::face::find $face
		3022	or next;
		3023	if (my $smooth = cf::face::find $info->{smooth}) {
		3024	cf::face::set_smooth $idx, $smooth;
		3025	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3026	} else {
		3027	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3028	}
1267		3029
1268	sub cfg_load {	3030	cf::cede_to_tick;
		3031	}
		3032	}
		3033
		3034	{
		3035	my $anims = $facedata->{animinfo};
		3036
		3037	while (my ($anim, $info) = each %$anims) {
		3038	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3039	cf::cede_to_tick;
		3040	}
		3041
		3042	cf::anim::invalidate_all; # d'oh
		3043	}
		3044
		3045	{
		3046	# TODO: for gcfclient pleasure, we should give resources
		3047	# that gcfclient doesn't grok a >10000 face index.
		3048	my $res = $facedata->{resource};
		3049
		3050	my $soundconf = delete $res->{"res/sound.conf"};
		3051
		3052	while (my ($name, $info) = each %$res) {
		3053	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3054	my $data;
		3055
		3056	if ($info->{type} & 1) {
		3057	# prepend meta info
		3058
		3059	my $meta = $enc->encode ({
		3060	name => $name,
		3061	%{ $info->{meta} || {} },
		3062	});
		3063
		3064	$data = pack "(w/a*)*", $meta, $info->{data};
		3065	} else {
		3066	$data = $info->{data};
		3067	}
		3068
		3069	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3070	cf::face::set_type $idx, $info->{type};
		3071
		3072	cf::cede_to_tick;
		3073	}
		3074
		3075	if ($soundconf) {
		3076	$soundconf = $enc->decode (delete $soundconf->{data});
		3077
		3078	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3079	my $sound = $soundconf->{compat}[$_]
		3080	or next;
		3081
		3082	my $face = cf::face::find "sound/$sound->[1]";
		3083	cf::sound::set $sound->[0] => $face;
		3084	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3085	}
		3086
		3087	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3088	my $face = cf::face::find "sound/$v";
		3089	cf::sound::set $k => $face;
		3090	}
		3091	}
		3092	}
		3093
		3094	1
		3095	}
		3096
		3097	register_exticmd fx_want => sub {
		3098	my ($ns, $want) = @_;
		3099
		3100	while (my ($k, $v) = each %$want) {
		3101	$ns->fx_want ($k, $v);
		3102	}
		3103	};
		3104
		3105	sub reload_regions {
		3106	# HACK to clear player env face cache, we need some signal framework
		3107	# for this (global event?)
		3108	%ext::player_env::MUSIC_FACE_CACHE = ();
		3109
		3110	load_resource_file "$MAPDIR/regions"
		3111	or die "unable to load regions file\n";
		3112
		3113	for (cf::region::list) {
		3114	$_->{match} = qr/$_->{match}/
		3115	if exists $_->{match};
		3116	}
		3117	}
		3118
		3119	sub reload_facedata {
		3120	load_facedata "$DATADIR/facedata"
		3121	or die "unable to load facedata\n";
		3122	}
		3123
		3124	sub reload_archetypes {
		3125	load_resource_file "$DATADIR/archetypes"
		3126	or die "unable to load archetypes\n";
		3127	#d# NEED to laod twice to resolve forward references
		3128	# this really needs to be done in an extra post-pass
		3129	# (which needs to be synchronous, so solve it differently)
		3130	load_resource_file "$DATADIR/archetypes"
		3131	or die "unable to load archetypes\n";
		3132	}
		3133
		3134	sub reload_treasures {
		3135	load_resource_file "$DATADIR/treasures"
		3136	or die "unable to load treasurelists\n";
		3137	}
		3138
		3139	sub reload_resources {
		3140	warn "reloading resource files...\n";
		3141
		3142	reload_regions;
		3143	reload_facedata;
		3144	#reload_archetypes;#d#
		3145	reload_archetypes;
		3146	reload_treasures;
		3147
		3148	warn "finished reloading resource files\n";
		3149	}
		3150
		3151	sub init {
		3152	reload_resources;
		3153	}
		3154
		3155	sub reload_config {
1269	open my $fh, "<:utf8", cf::confdir . "/config"	3156	open my $fh, "<:utf8", "$CONFDIR/config"
1270	or return;	3157	or return;
1271		3158
1272	local $/;	3159	local $/;
1273	*CFG = YAML::Syck::Load <$fh>;	3160	*CFG = YAML::Syck::Load <$fh>;
		3161
		3162	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3163
		3164	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3165	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3166
		3167	if (exists $CFG{mlockall}) {
		3168	eval {
		3169	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3170	and die "WARNING: m(un)lockall failed: $!\n";
		3171	};
		3172	warn $@ if $@;
		3173	}
1274	}	3174	}
1275		3175
1276	sub main {	3176	sub main {
1277	cfg_load;	3177	# we must not ever block the main coroutine
1278	db_load;	3178	local $Coro::idle = sub {
		3179	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3180	(async {
		3181	Event::one_event;
		3182	})->prio (Coro::PRIO_MAX);
		3183	};
		3184
		3185	reload_config;
		3186	db_init;
1279	load_extensions;	3187	load_extensions;
		3188
		3189	$TICK_WATCHER->start;
1280	Event::loop;	3190	Event::loop;
1281	}	3191	}
1282		3192
1283	#############################################################################	3193	#############################################################################
1284	# initialisation	3194	# initialisation and cleanup
1285		3195
1286	sub perl_reload() {	3196	# install some emergency cleanup handlers
		3197	BEGIN {
		3198	for my $signal (qw(INT HUP TERM)) {
		3199	Event->signal (
		3200	reentrant => 0,
		3201	data => WF_AUTOCANCEL,
		3202	signal => $signal,
		3203	prio => 0,
		3204	cb => sub {
		3205	cf::cleanup "SIG$signal";
		3206	},
		3207	);
		3208	}
		3209	}
		3210
		3211	sub write_runtime {
		3212	my $runtime = "$LOCALDIR/runtime";
		3213
		3214	# first touch the runtime file to show we are still running:
		3215	# the fsync below can take a very very long time.
		3216
		3217	IO::AIO::aio_utime $runtime, undef, undef;
		3218
		3219	my $guard = cf::lock_acquire "write_runtime";
		3220
		3221	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3222	or return;
		3223
		3224	my $value = $cf::RUNTIME + 90 + 10;
		3225	# 10 is the runtime save interval, for a monotonic clock
		3226	# 60 allows for the watchdog to kill the server.
		3227
		3228	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3229	and return;
		3230
		3231	# always fsync - this file is important
		3232	aio_fsync $fh
		3233	and return;
		3234
		3235	# touch it again to show we are up-to-date
		3236	aio_utime $fh, undef, undef;
		3237
		3238	close $fh
		3239	or return;
		3240
		3241	aio_rename "$runtime~", $runtime
		3242	and return;
		3243
		3244	warn "runtime file written.\n";
		3245
		3246	1
		3247	}
		3248
		3249	sub emergency_save() {
		3250	my $freeze_guard = cf::freeze_mainloop;
		3251
		3252	warn "enter emergency perl save\n";
		3253
		3254	cf::sync_job {
		3255	# use a peculiar iteration method to avoid tripping on perl
		3256	# refcount bugs in for. also avoids problems with players
		3257	# and maps saved/destroyed asynchronously.
		3258	warn "begin emergency player save\n";
		3259	for my $login (keys %cf::PLAYER) {
		3260	my $pl = $cf::PLAYER{$login} or next;
		3261	$pl->valid or next;
		3262	$pl->save;
		3263	}
		3264	warn "end emergency player save\n";
		3265
		3266	warn "begin emergency map save\n";
		3267	for my $path (keys %cf::MAP) {
		3268	my $map = $cf::MAP{$path} or next;
		3269	$map->valid or next;
		3270	$map->save;
		3271	}
		3272	warn "end emergency map save\n";
		3273
		3274	warn "begin emergency database checkpoint\n";
		3275	BDB::db_env_txn_checkpoint $DB_ENV;
		3276	warn "end emergency database checkpoint\n";
		3277	};
		3278
		3279	warn "leave emergency perl save\n";
		3280	}
		3281
		3282	sub post_cleanup {
		3283	my ($make_core) = @_;
		3284
		3285	warn Carp::longmess "post_cleanup backtrace"
		3286	if $make_core;
		3287	}
		3288
		3289	sub do_reload_perl() {
1287	# can/must only be called in main	3290	# can/must only be called in main
1288	if ($Coro::current != $Coro::main) {	3291	if ($Coro::current != $Coro::main) {
1289	warn "can only reload from main coroutine\n";	3292	warn "can only reload from main coroutine";
1290	return;	3293	return;
1291	}	3294	}
1292		3295
1293	warn "reloading...";	3296	warn "reloading...";
1294		3297
1295	local $FREEZE = 1;	3298	warn "entering sync_job";
		3299
		3300	cf::sync_job {
		3301	cf::write_runtime; # external watchdog should not bark
1296	cf::emergency_save;	3302	cf::emergency_save;
		3303	cf::write_runtime; # external watchdog should not bark
1297		3304
1298	eval {	3305	warn "syncing database to disk";
		3306	BDB::db_env_txn_checkpoint $DB_ENV;
		3307
1299	# if anything goes wrong in here, we should simply crash as we already saved	3308	# if anything goes wrong in here, we should simply crash as we already saved
1300		3309
1301	# cancel all watchers	3310	warn "cancelling all WF_AUTOCANCEL watchers";
1302	for (Event::all_watchers) {	3311	for (Event::all_watchers) {
1303	$_->cancel if $_->data & WF_AUTOCANCEL;	3312	$_->cancel if $_->data & WF_AUTOCANCEL;
1304	}	3313	}
1305		3314
		3315	warn "flushing outstanding aio requests";
		3316	for (;;) {
		3317	BDB::flush;
		3318	IO::AIO::flush;
		3319	Coro::cede;
		3320	last unless IO::AIO::nreqs || BDB::nreqs;
		3321	warn "iterate...";
		3322	}
		3323
		3324	++$RELOAD;
		3325
1306	# cancel all extension coros	3326	warn "cancelling all extension coros";
1307	$_->cancel for values %EXT_CORO;	3327	$_->cancel for values %EXT_CORO;
1308	%EXT_CORO = ();	3328	%EXT_CORO = ();
1309		3329
1310	# unload all extensions	3330	warn "removing commands";
1311	for (@exts) {	3331	%COMMAND = ();
		3332
		3333	warn "removing ext/exti commands";
		3334	%EXTCMD = ();
		3335	%EXTICMD = ();
		3336
		3337	warn "unloading/nuking all extensions";
		3338	for my $pkg (@EXTS) {
1312	warn "unloading <$_>";	3339	warn "... unloading $pkg";
1313	unload_extension $_;	3340
		3341	if (my $cb = $pkg->can ("unload")) {
		3342	eval {
		3343	$cb->($pkg);
		3344	1
		3345	} or warn "$pkg unloaded, but with errors: $@";
1314	}	3346	}
1315		3347
		3348	warn "... nuking $pkg";
		3349	Symbol::delete_package $pkg;
		3350	}
		3351
1316	# unload all modules loaded from $LIBDIR	3352	warn "unloading all perl modules loaded from $LIBDIR";
1317	while (my ($k, $v) = each %INC) {	3353	while (my ($k, $v) = each %INC) {
1318	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3354	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319		3355
1320	warn "removing <$k>";	3356	warn "... unloading $k";
1321	delete $INC{$k};	3357	delete $INC{$k};
1322		3358
1323	$k =~ s/\.pm$//;	3359	$k =~ s/\.pm$//;
1324	$k =~ s/\//::/g;	3360	$k =~ s/\//::/g;
1325		3361
…		…
1328	}	3364	}
1329		3365
1330	Symbol::delete_package $k;	3366	Symbol::delete_package $k;
1331	}	3367	}
1332		3368
1333	# sync database to disk
1334	cf::db_sync;
1335	IO::AIO::flush;
1336
1337	# get rid of safe::, as good as possible	3369	warn "getting rid of safe::, as good as possible";
1338	Symbol::delete_package "safe::$_"	3370	Symbol::delete_package "safe::$_"
1339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3371	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340		3372
1341	# remove register_script_function callbacks
1342	# TODO
1343
1344	# unload cf.pm "a bit"	3373	warn "unloading cf.pm \"a bit\"";
1345	delete $INC{"cf.pm"};	3374	delete $INC{"cf.pm"};
		3375	delete $INC{"cf/pod.pm"};
1346		3376
1347	# don't, removes xs symbols, too,	3377	# don't, removes xs symbols, too,
1348	# and global variables created in xs	3378	# and global variables created in xs
1349	#Symbol::delete_package __PACKAGE__;	3379	#Symbol::delete_package __PACKAGE__;
1350		3380
1351	# reload cf.pm	3381	warn "unload completed, starting to reload now";
		3382
1352	warn "reloading cf.pm";	3383	warn "reloading cf.pm";
1353	require cf;	3384	require cf;
1354	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3385	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355		3386
1356	# load config and database again	3387	warn "loading config and database again";
1357	cf::cfg_load;	3388	cf::reload_config;
1358	cf::db_load;
1359		3389
1360	# load extensions
1361	warn "load extensions";	3390	warn "loading extensions";
1362	cf::load_extensions;	3391	cf::load_extensions;
1363		3392
1364	# reattach attachments to objects	3393	warn "reattaching attachments to objects/players";
1365	warn "reattach";	3394	_global_reattach; # objects, sockets
1366	_global_reattach;	3395	warn "reattaching attachments to maps";
1367	};	3396	reattach $_ for values %MAP;
		3397	warn "reattaching attachments to players";
		3398	reattach $_ for values %PLAYER;
1368		3399
1369	if ($@) {	3400	warn "leaving sync_job";
		3401
		3402	1
		3403	} or do {
1370	warn $@;	3404	warn $@;
1371	warn "error while reloading, exiting.";	3405	warn "error while reloading, exiting.";
1372	exit 1;	3406	exit 1;
1373	}	3407	};
1374		3408
1375	warn "reloaded successfully";	3409	warn "reloaded";
1376	};	3410	};
1377		3411
1378	register "<global>", __PACKAGE__;	3412	our $RELOAD_WATCHER; # used only during reload
1379		3413
		3414	sub reload_perl() {
		3415	# doing reload synchronously and two reloads happen back-to-back,
		3416	# coro crashes during coro_state_free->destroy here.
		3417
		3418	$RELOAD_WATCHER ||= Event->timer (
		3419	reentrant => 0,
		3420	after => 0,
		3421	data => WF_AUTOCANCEL,
		3422	cb => sub {
		3423	do_reload_perl;
		3424	undef $RELOAD_WATCHER;
		3425	},
		3426	);
		3427	}
		3428
1380	register_command "perl-reload" => sub {	3429	register_command "reload" => sub {
1381	my ($who, $arg) = @_;	3430	my ($who, $arg) = @_;
1382		3431
1383	if ($who->flag (FLAG_WIZ)) {	3432	if ($who->flag (FLAG_WIZ)) {
1384	$who->message ("start of reload.");
1385	perl_reload;
1386	$who->message ("end of reload.");	3433	$who->message ("reloading server.");
		3434	async { reload_perl };
1387	}	3435	}
1388	};	3436	};
1389		3437
1390	unshift @INC, $LIBDIR;	3438	unshift @INC, $LIBDIR;
		3439
		3440	my $bug_warning = 0;
		3441
		3442	our @WAIT_FOR_TICK;
		3443	our @WAIT_FOR_TICK_BEGIN;
		3444
		3445	sub wait_for_tick {
		3446	return unless $TICK_WATCHER->is_active;
		3447	return if $Coro::current == $Coro::main;
		3448
		3449	my $signal = new Coro::Signal;
		3450	push @WAIT_FOR_TICK, $signal;
		3451	$signal->wait;
		3452	}
		3453
		3454	sub wait_for_tick_begin {
		3455	return unless $TICK_WATCHER->is_active;
		3456	return if $Coro::current == $Coro::main;
		3457
		3458	my $signal = new Coro::Signal;
		3459	push @WAIT_FOR_TICK_BEGIN, $signal;
		3460	$signal->wait;
		3461	}
		3462
		3463	our $stat_fh;
		3464	sysopen $stat_fh, "/tmp/cfstats", Fcntl::O_APPEND | Fcntl::O_CREAT | Fcntl::O_WRONLY, 0600;#d#
1391		3465
1392	$TICK_WATCHER = Event->timer (	3466	$TICK_WATCHER = Event->timer (
1393	reentrant => 0,	3467	reentrant => 0,
		3468	parked => 1,
1394	prio => 0,	3469	prio => 0,
1395	at => $NEXT_TICK || $TICK,	3470	at => $NEXT_TICK || $TICK,
1396	data => WF_AUTOCANCEL,	3471	data => WF_AUTOCANCEL,
1397	cb => sub {	3472	cb => sub {
1398	unless ($FREEZE) {	3473	if ($Coro::current != $Coro::main) {
		3474	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3475	unless ++$bug_warning > 10;
		3476	return;
		3477	}
		3478
		3479	my @pl = cf::player::list; my $stats = sprintf "%.2f %d %d %d", $RUNTIME, (scalar @pl), cf::object::actives_size, cf::object::objects_size; #d#
		3480
		3481	$NOW = $tick_start = Event::time;
		3482
1399	cf::server_tick; # one server iteration	3483	cf::server_tick; # one server iteration
		3484
1400	$RUNTIME += $TICK;	3485	$RUNTIME += $TICK;
1401	}
1402
1403	$NEXT_TICK += $TICK;	3486	$NEXT_TICK += $TICK;
1404		3487
		3488	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3489	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3490	Coro::async_pool {
		3491	write_runtime
		3492	or warn "ERROR: unable to write runtime file: $!";
		3493	};
		3494	}
		3495
		3496	# my $AFTER = Event::time;
		3497	# warn $AFTER - $NOW;#d#
		3498
		3499	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3500	$sig->send;
		3501	}
		3502	while (my $sig = shift @WAIT_FOR_TICK) {
		3503	$sig->send;
		3504	}
		3505
		3506	$NOW = Event::time;
		3507
1405	# if we are delayed by four ticks or more, skip them all	3508	# if we are delayed by four ticks or more, skip them all
1406	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3509	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1407		3510
1408	$TICK_WATCHER->at ($NEXT_TICK);	3511	$TICK_WATCHER->at ($NEXT_TICK);
1409	$TICK_WATCHER->start;	3512	$TICK_WATCHER->start;
		3513
		3514	$LOAD = ($NOW - $tick_start) / $TICK;
		3515	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3516
		3517	_post_tick;
		3518
		3519	# gather some statistics#d#
		3520	$stats .= sprintf " %d\n", 10000 * ($NOW - $tick_start);#d#
		3521	IO::AIO::aio_write $stat_fh, undef, undef, $stats, 0;#d#
1410	},	3522	},
1411	);	3523	);
1412		3524
		3525	{
		3526	BDB::min_parallel 8;
		3527	BDB::max_poll_time $TICK * 0.1;
		3528	$BDB_POLL_WATCHER = Event->io (
		3529	reentrant => 0,
		3530	fd => BDB::poll_fileno,
		3531	poll => 'r',
		3532	prio => 0,
		3533	data => WF_AUTOCANCEL,
		3534	cb => \&BDB::poll_cb,
		3535	);
		3536
		3537	BDB::set_sync_prepare {
		3538	my $status;
		3539	my $current = $Coro::current;
		3540	(
		3541	sub {
		3542	$status = $!;
		3543	$current->ready; undef $current;
		3544	},
		3545	sub {
		3546	Coro::schedule while defined $current;
		3547	$! = $status;
		3548	},
		3549	)
		3550	};
		3551
		3552	unless ($DB_ENV) {
		3553	$DB_ENV = BDB::db_env_create;
		3554
		3555	cf::sync_job {
		3556	eval {
		3557	BDB::db_env_open
		3558	$DB_ENV,
		3559	$BDBDIR,
		3560	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3561	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3562	0666;
		3563
		3564	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3565
		3566	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3567	| BDB::LOG_AUTOREMOVE, 1);
		3568	$DB_ENV->set_lk_detect;
		3569	};
		3570
		3571	cf::cleanup "db_env_open(db): $@" if $@;
		3572	};
		3573	}
		3574
		3575	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3576	after => 11,
		3577	interval => 60,
		3578	hard => 1,
		3579	prio => 0,
		3580	data => WF_AUTOCANCEL,
		3581	cb => sub {
		3582	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3583	},
		3584	);
		3585	$BDB_TRICKLE_WATCHER = Event->timer (
		3586	after => 5,
		3587	interval => 10,
		3588	hard => 1,
		3589	prio => 0,
		3590	data => WF_AUTOCANCEL,
		3591	cb => sub {
		3592	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3593	},
		3594	);
		3595	}
		3596
		3597	{
		3598	IO::AIO::min_parallel 8;
		3599
		3600	undef $Coro::AIO::WATCHER;
1413	IO::AIO::max_poll_time $TICK * 0.2;	3601	IO::AIO::max_poll_time $TICK * 0.1;
1414		3602	$AIO_POLL_WATCHER = Event->io (
1415	Event->io (fd => IO::AIO::poll_fileno,	3603	reentrant => 0,
1416	poll => 'r',
1417	prio => 5,
1418	data => WF_AUTOCANCEL,	3604	data => WF_AUTOCANCEL,
		3605	fd => IO::AIO::poll_fileno,
		3606	poll => 'r',
		3607	prio => 6,
1419	cb => \&IO::AIO::poll_cb);	3608	cb => \&IO::AIO::poll_cb,
		3609	);
		3610	}
1420		3611
1421	# we must not ever block the main coroutine	3612	my $_log_backtrace;
1422	$Coro::idle = sub {	3613
1423	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	3614	sub _log_backtrace {
1424	warn "FATAL: Coro::idle was called, major BUG\n";	3615	my ($msg, @addr) = @_;
1425	(Coro::unblock_sub {	3616
1426	Event::one_event;	3617	$msg =~ s/\n//;
1427	})->();	3618
1428	};	3619	# limit the # of concurrent backtraces
		3620	if ($_log_backtrace < 2) {
		3621	++$_log_backtrace;
		3622	async {
		3623	my @bt = fork_call {
		3624	@addr = map { sprintf "%x", $_ } @addr;
		3625	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3626	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3627	or die "addr2line: $!";
		3628
		3629	my @funcs;
		3630	my @res = <$fh>;
		3631	chomp for @res;
		3632	while (@res) {
		3633	my ($func, $line) = splice @res, 0, 2, ();
		3634	push @funcs, "[$func] $line";
		3635	}
		3636
		3637	@funcs
		3638	};
		3639
		3640	LOG llevInfo, "[ABT] $msg\n";
		3641	LOG llevInfo, "[ABT] $_\n" for @bt;
		3642	--$_log_backtrace;
		3643	};
		3644	} else {
		3645	LOG llevInfo, "[ABT] $msg\n";
		3646	LOG llevInfo, "[ABT] [suppressed]\n";
		3647	}
		3648	}
		3649
		3650	# load additional modules
		3651	use cf::pod;
		3652
		3653	END { cf::emergency_save }
1429		3654
1430	1	3655	1
1431		3656

Diff Legend

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