ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

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

Diff Legend

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