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

Diff Legend

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