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

Diff Legend

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