ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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