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.115 by root, Mon Jan 1 16:50:10 2007 UTC vs.
Revision 1.333 by root, Sun Aug 19 09:14:50 2007 UTC

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

Diff Legend

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