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

Diff Legend

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