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

Diff Legend

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