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

Diff Legend

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