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

Diff Legend

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