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.118 by root, Mon Jan 1 21:19:52 2007 UTC vs.
Revision 1.354 by root, Sun Sep 2 12:26:54 2007 UTC

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

Diff Legend

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