ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 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 fork_call(&@) {
359	and return;	415	my ($cb, @args) = @_;
360		416
		417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		418	# or die "socketpair: $!";
		419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
		421
		422	if (my $pid = fork) {
361	close $fh	423	close $fh2;
362	or return;
363		424
364	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
365	and return;	426	warn "pst<$res>" unless $res =~ /^pst/;
		427	$res = Coro::Storable::thaw $res;
366		428
		429	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		430
		431	Carp::confess $$res unless "ARRAY" eq ref $res;
		432
		433	return wantarray ? @$res : $res->[-1];
		434	} else {
		435	reset_signals;
		436	local $SIG{__WARN__};
		437	local $SIG{__DIE__};
		438	local $Coro::idle;
		439	$Coro::current->prio (Coro::PRIO_MAX);
		440	eval {
		441	close $fh1;
		442
		443	my @res = eval { $cb->(@args) };
		444
		445	open my $fh, ">", \my $buf
		446	or die "fork_call: cannot open fh-to-buf in child : $!";
		447	Storable::store_fd +($@ ? \"$@" : \@res), $fh;
		448	close $fh;
		449
		450	warn "writing ", length $buf;
		451	my $x;
		452	(length $buf) == ($x = syswrite $fh2, $buf)
		453	or warn "error writing ".(length $buf)." != $x\n";
		454	close $fh2;
		455	};
		456
		457	warn $@ if $@;
		458	_exit 0;
367	1	459	}
		460	}
		461
		462	=item $value = cf::db_get $family => $key
		463
		464	Returns a single value from the environment database.
		465
		466	=item cf::db_put $family => $key => $value
		467
		468	Stores the given C<$value> in the family. It can currently store binary
		469	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		470
		471	=cut
		472
		473	our $DB;
		474
		475	sub db_init {
		476	unless ($DB) {
		477	$DB = BDB::db_create $DB_ENV;
		478
		479	cf::sync_job {
		480	eval {
		481	$DB->set_flags (BDB::CHKSUM);
		482
		483	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		484	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		485	cf::cleanup "db_open(db): $!" if $!;
		486	};
		487	cf::cleanup "db_open(db): $@" if $@;
		488	};
		489	}
		490	}
		491
		492	sub db_get($$) {
		493	my $key = "$_[0]/$_[1]";
		494
		495	cf::sync_job {
		496	BDB::db_get $DB, undef, $key, my $data;
		497
		498	$! ? ()
		499	: $data
		500	}
		501	}
		502
		503	sub db_put($$$) {
		504	BDB::dbreq_pri 4;
		505	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		506	}
		507
		508	=item cf::cache $id => [$paths...], $processversion => $process
		509
		510	Generic caching function that returns the value of the resource $id,
		511	caching and regenerating as required.
		512
		513	This function can block.
		514
		515	=cut
		516
		517	sub cache {
		518	my ($id, $src, $processversion, $process) = @_;
		519
		520	my $meta =
		521	join "\x00",
		522	$processversion,
		523	map {
		524	aio_stat $_
		525	and Carp::croak "$_: $!";
		526
		527	($_, (stat _)[7,9])
		528	} @$src;
		529
		530	my $dbmeta = db_get cache => "$id/meta";
		531	if ($dbmeta ne $meta) {
		532	# changed, we may need to process
		533
		534	my @data;
		535	my $md5;
		536
		537	for (0 .. $#$src) {
		538	0 <= aio_load $src->[$_], $data[$_]
		539	or Carp::croak "$src->[$_]: $!";
		540	}
		541
		542	# if processing is expensive, check
		543	# checksum first
		544	if (1) {
		545	$md5 =
		546	join "\x00",
		547	$processversion,
		548	map {
		549	Coro::cede;
		550	($src->[$_], Digest::MD5::md5_hex $data[$_])
		551	} 0.. $#$src;
		552
		553
		554	my $dbmd5 = db_get cache => "$id/md5";
		555	if ($dbmd5 eq $md5) {
		556	db_put cache => "$id/meta", $meta;
		557
		558	return db_get cache => "$id/data";
		559	}
		560	}
		561
		562	my $t1 = Time::HiRes::time;
		563	my $data = $process->(\@data);
		564	my $t2 = Time::HiRes::time;
		565
		566	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		567
		568	db_put cache => "$id/data", $data;
		569	db_put cache => "$id/md5" , $md5;
		570	db_put cache => "$id/meta", $meta;
		571
		572	return $data;
		573	}
		574
		575	db_get cache => "$id/data"
		576	}
		577
		578	=item cf::datalog type => key => value, ...
		579
		580	Log a datalog packet of the given type with the given key-value pairs.
		581
		582	=cut
		583
		584	sub datalog($@) {
		585	my ($type, %kv) = @_;
		586	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
368	}	587	}
369		588
370	=back	589	=back
371		590
372	=cut	591	=cut
…		…
379	attach callbacks/event handlers (a collection of which is called an "attachment")	598	attach callbacks/event handlers (a collection of which is called an "attachment")
380	to it. All such attachable objects support the following methods.	599	to it. All such attachable objects support the following methods.
381		600
382	In the following description, CLASS can be any of C<global>, C<object>	601	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	602	C<player>, C<client> or C<map> (i.e. the attachable objects in
384	crossfire+).	603	Crossfire TRT).
385		604
386	=over 4	605	=over 4
387		606
388	=item $attachable->attach ($attachment, key => $value...)	607	=item $attachable->attach ($attachment, key => $value...)
389		608
…		…
503	our @CB_TYPE = (); # registry for type (cf-object class) based events	722	our @CB_TYPE = (); # registry for type (cf-object class) based events
504	our @CB_MAP = ();	723	our @CB_MAP = ();
505		724
506	my %attachment;	725	my %attachment;
507		726
		727	sub cf::attachable::thawer_merge {
		728	# simply override everything except _meta
		729	local $_[0]{_meta};
		730	%{$_[0]} = %{$_[1]};
		731	}
		732
508	sub _attach_cb($$$$) {	733	sub _attach_cb($$$$) {
509	my ($registry, $event, $prio, $cb) = @_;	734	my ($registry, $event, $prio, $cb) = @_;
510		735
511	use sort 'stable';	736	use sort 'stable';
512		737
…		…
546	$registry = $CB_TYPE[$object_type] ||= [];	771	$registry = $CB_TYPE[$object_type] ||= [];
547		772
548	} elsif ($type eq "subtype") {	773	} elsif ($type eq "subtype") {
549	defined $object_type or Carp::croak "subtype specified without type";	774	defined $object_type or Carp::croak "subtype specified without type";
550	my $object_subtype = shift @arg;	775	my $object_subtype = shift @arg;
551	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	776	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552		777
553	} elsif ($type eq "package") {	778	} elsif ($type eq "package") {
554	my $pkg = shift @arg;	779	my $pkg = shift @arg;
555		780
556	while (my ($name, $id) = each %cb_id) {	781	while (my ($name, $id) = each %cb_id) {
…		…
585	_attach $registry, $klass, @attach;	810	_attach $registry, $klass, @attach;
586	}	811	}
587		812
588	$obj->{$name} = \%arg;	813	$obj->{$name} = \%arg;
589	} else {	814	} else {
590	warn "object uses attachment '$name' that is not available, postponing.\n";	815	warn "object uses attachment '$name' which is not available, postponing.\n";
591	}	816	}
592		817
593	$obj->{_attachment}{$name} = undef;	818	$obj->{_attachment}{$name} = undef;
594	}	819	}
595		820
…		…
597	if (ref $_[0]) {	822	if (ref $_[0]) {
598	_object_attach @_;	823	_object_attach @_;
599	} else {	824	} else {
600	_attach shift->_attach_registry, @_;	825	_attach shift->_attach_registry, @_;
601	}	826	}
		827	_recalc_want;
602	};	828	};
603		829
604	# all those should be optimised	830	# all those should be optimised
605	sub cf::attachable::detach {	831	sub cf::attachable::detach {
606	my ($obj, $name) = @_;	832	my ($obj, $name) = @_;
…		…
609	delete $obj->{_attachment}{$name};	835	delete $obj->{_attachment}{$name};
610	reattach ($obj);	836	reattach ($obj);
611	} else {	837	} else {
612	Carp::croak "cannot, currently, detach class attachments";	838	Carp::croak "cannot, currently, detach class attachments";
613	}	839	}
		840	_recalc_want;
614	};	841	};
615		842
616	sub cf::attachable::attached {	843	sub cf::attachable::attached {
617	my ($obj, $name) = @_;	844	my ($obj, $name) = @_;
618		845
…		…
683	# object support	910	# object support
684		911
685	sub reattach {	912	sub reattach {
686	# basically do the same as instantiate, without calling instantiate	913	# basically do the same as instantiate, without calling instantiate
687	my ($obj) = @_;	914	my ($obj) = @_;
		915
		916	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
688		917
689	my $registry = $obj->registry;	918	my $registry = $obj->registry;
690		919
691	@$registry = ();	920	@$registry = ();
692		921
…		…
739	$filename, length $$rdata, scalar @$objs;	968	$filename, length $$rdata, scalar @$objs;
740		969
741	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	970	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
742	chmod SAVE_MODE, $fh;	971	chmod SAVE_MODE, $fh;
743	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	972	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
744	aio_fsync $fh;	973	aio_fsync $fh if $cf::USE_FSYNC;
745	close $fh;	974	close $fh;
746		975
747	if (@$objs) {	976	if (@$objs) {
748	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	977	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
749	chmod SAVE_MODE, $fh;	978	chmod SAVE_MODE, $fh;
750	my $data = Storable::nfreeze { version => 1, objs => $objs };	979	my $data = Storable::nfreeze { version => 1, objs => $objs };
751	aio_write $fh, 0, (length $data), $data, 0;	980	aio_write $fh, 0, (length $data), $data, 0;
752	aio_fsync $fh;	981	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	982	close $fh;
754	aio_rename "$filename.pst~", "$filename.pst";	983	aio_rename "$filename.pst~", "$filename.pst";
755	}	984	}
756	} else {	985	} else {
757	aio_unlink "$filename.pst";	986	aio_unlink "$filename.pst";
…		…
789	or return;	1018	or return;
790	$av = eval { (Storable::thaw $av)->{objs} };	1019	$av = eval { (Storable::thaw $av)->{objs} };
791	}	1020	}
792		1021
793	warn sprintf "loading %s (%d)\n",	1022	warn sprintf "loading %s (%d)\n",
794	$filename, length $data, scalar @{$av || []};#d#	1023	$filename, length $data, scalar @{$av || []};
795	return ($data, $av);	1024	return ($data, $av);
796	}	1025	}
		1026
		1027	=head2 COMMAND CALLBACKS
		1028
		1029	=over 4
		1030
		1031	=cut
797		1032
798	#############################################################################	1033	#############################################################################
799	# command handling &c	1034	# command handling &c
800		1035
801	=item cf::register_command $name => \&callback($ob,$args);	1036	=item cf::register_command $name => \&callback($ob,$args);
…		…
814	push @{ $COMMAND{$name} }, [$caller, $cb];	1049	push @{ $COMMAND{$name} }, [$caller, $cb];
815	}	1050	}
816		1051
817	=item cf::register_extcmd $name => \&callback($pl,$packet);	1052	=item cf::register_extcmd $name => \&callback($pl,$packet);
818		1053
819	Register a callbackf ro execution when the client sends an extcmd packet.	1054	Register a callback for execution when the client sends an (synchronous)
		1055	extcmd packet. Ext commands will be processed in the order they are
		1056	received by the server, like other user commands. The first argument is
		1057	the logged-in player. Ext commands can only be processed after a player
		1058	has logged in successfully.
820		1059
821	If the callback returns something, it is sent back as if reply was being	1060	If the callback returns something, it is sent back as if reply was being
822	called.	1061	called.
823		1062
		1063	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1064
		1065	Register a callback for execution when the client sends an (asynchronous)
		1066	exticmd packet. Exti commands are processed by the server as soon as they
		1067	are received, i.e. out of order w.r.t. other commands. The first argument
		1068	is a client socket. Exti commands can be received anytime, even before
		1069	log-in.
		1070
		1071	If the callback returns something, it is sent back as if reply was being
		1072	called.
		1073
824	=cut	1074	=cut
825		1075
826	sub register_extcmd {	1076	sub register_extcmd {
827	my ($name, $cb) = @_;	1077	my ($name, $cb) = @_;
828		1078
829	$EXTCMD{$name} = $cb;	1079	$EXTCMD{$name} = $cb;
		1080	}
		1081
		1082	sub register_exticmd {
		1083	my ($name, $cb) = @_;
		1084
		1085	$EXTICMD{$name} = $cb;
830	}	1086	}
831		1087
832	cf::player->attach (	1088	cf::player->attach (
833	on_command => sub {	1089	on_command => sub {
834	my ($pl, $name, $params) = @_;	1090	my ($pl, $name, $params) = @_;
…		…
843	cf::override;	1099	cf::override;
844	},	1100	},
845	on_extcmd => sub {	1101	on_extcmd => sub {
846	my ($pl, $buf) = @_;	1102	my ($pl, $buf) = @_;
847		1103
848	my $msg = eval { from_json $buf };	1104	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
849		1105
850	if (ref $msg) {	1106	if (ref $msg) {
851	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1107	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
852	if (my %reply = $cb->($pl, $msg)) {	1108	if (my %reply = $cb->($pl, $msg)) {
853	$pl->ext_reply ($msg->{msgid}, %reply);	1109	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
859		1115
860	cf::override;	1116	cf::override;
861	},	1117	},
862	);	1118	);
863		1119
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 {	1120	sub load_extensions {
		1121	cf::sync_job {
		1122	my %todo;
		1123
899	for my $ext (<$LIBDIR/*.ext>) {	1124	for my $path (<$LIBDIR/*.ext>) {
900	next unless -r $ext;	1125	next unless -r $path;
901	eval {	1126
902	load_extension $ext;	1127	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1128	my $base = $1;
		1129	my $pkg = $1;
		1130	$pkg =~ s/[^[:word:]]/_/g;
		1131	$pkg = "ext::$pkg";
		1132
		1133	open my $fh, "<:utf8", $path
		1134	or die "$path: $!";
		1135
		1136	my $source = do { local $/; <$fh> };
		1137
		1138	my %ext = (
		1139	path => $path,
		1140	base => $base,
		1141	pkg => $pkg,
		1142	);
		1143
		1144	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1145	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1146
		1147	$ext{source} =
		1148	"package $pkg; use strict; use utf8;\n"
		1149	. "#line 1 \"$path\"\n{\n"
		1150	. $source
		1151	. "\n};\n1";
		1152
		1153	$todo{$base} = \%ext;
		1154	}
		1155
		1156	my %done;
		1157	while (%todo) {
		1158	my $progress;
		1159
		1160	while (my ($k, $v) = each %todo) {
		1161	for (split /,\s*/, $v->{meta}{depends}) {
		1162	goto skip
		1163	unless exists $done{$_};
		1164	}
		1165
		1166	warn "... loading '$k' into '$v->{pkg}'\n";
		1167
		1168	unless (eval $v->{source}) {
		1169	my $msg = $@ ? "$v->{path}: $@\n"
		1170	: "$v->{base}: extension inactive.\n";
		1171
		1172	if (exists $v->{meta}{mandatory}) {
		1173	warn $msg;
		1174	warn "mandatory extension failed to load, exiting.\n";
		1175	exit 1;
		1176	}
		1177
		1178	warn $msg;
		1179	}
		1180
		1181	$done{$k} = delete $todo{$k};
		1182	push @EXTS, $v->{pkg};
		1183	$progress = 1;
903	1	1184	}
904	} or warn "$ext not loaded: $@";	1185
		1186	skip:
		1187	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1188	unless $progress;
		1189	}
905	}	1190	};
906	}	1191	}
907		1192
908	#############################################################################	1193	#############################################################################
909		1194
		1195	=back
		1196
910	=head2 CORE EXTENSIONS	1197	=head2 CORE EXTENSIONS
911		1198
912	Functions and methods that extend core crossfire objects.	1199	Functions and methods that extend core crossfire objects.
913		1200
914	=cut	1201	=cut
…		…
926	Returns the given player object, loading it if necessary (might block).	1213	Returns the given player object, loading it if necessary (might block).
927		1214
928	=cut	1215	=cut
929		1216
930	sub playerdir($) {	1217	sub playerdir($) {
931	cf::localdir	1218	"$PLAYERDIR/"
932	. "/"
933	. cf::playerdir
934	. "/"
935	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1219	. (ref $_[0] ? $_[0]->ob->name : $_[0])
936	}	1220	}
937		1221
938	sub path($) {	1222	sub path($) {
939	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1223	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
940		1224
941	(playerdir $login) . "/$login.pl"	1225	(playerdir $login) . "/playerdata"
942	}	1226	}
943		1227
944	sub find_active($) {	1228	sub find_active($) {
945	$cf::PLAYER{$_[0]}	1229	$cf::PLAYER{$_[0]}
946	and $cf::PLAYER{$_[0]}->active	1230	and $cf::PLAYER{$_[0]}->active
…		…
949		1233
950	sub exists($) {	1234	sub exists($) {
951	my ($login) = @_;	1235	my ($login) = @_;
952		1236
953	$cf::PLAYER{$login}	1237	$cf::PLAYER{$login}
954	or cf::sync_job { !aio_stat $login }	1238	or cf::sync_job { !aio_stat path $login }
955	}	1239	}
956		1240
957	sub find($) {	1241	sub find($) {
958	return $cf::PLAYER{$_[0]} || do {	1242	return $cf::PLAYER{$_[0]} || do {
959	my $login = $_[0];	1243	my $login = $_[0];
960		1244
961	my $guard = cf::lock_acquire "user_find:$login";	1245	my $guard = cf::lock_acquire "user_find:$login";
962		1246
963	$cf::PLAYER{$_[0]} || do {	1247	$cf::PLAYER{$_[0]} || do {
		1248	# rename old playerfiles to new ones
		1249	#TODO: remove when no longer required
		1250	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1251	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1252	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1253	aio_unlink +(playerdir $login) . "/$login.pl";
		1254
964	my $pl = load_pl path $login	1255	my $pl = load_pl path $login
965	or return;	1256	or return;
966	$cf::PLAYER{$login} = $pl	1257	$cf::PLAYER{$login} = $pl
967	}	1258	}
968	}	1259	}
…		…
1005		1296
1006	=cut	1297	=cut
1007		1298
1008	sub quit_character {	1299	sub quit_character {
1009	my ($pl) = @_;	1300	my ($pl) = @_;
		1301
		1302	my $name = $pl->ob->name;
1010		1303
1011	$pl->{deny_save} = 1;	1304	$pl->{deny_save} = 1;
1012	$pl->password ("*"); # this should lock out the player until we nuked the dir	1305	$pl->password ("*"); # this should lock out the player until we nuked the dir
1013		1306
1014	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1307	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1019	my $path = playerdir $pl;	1312	my $path = playerdir $pl;
1020	my $temp = "$path~$cf::RUNTIME~deleting~";	1313	my $temp = "$path~$cf::RUNTIME~deleting~";
1021	aio_rename $path, $temp;	1314	aio_rename $path, $temp;
1022	delete $cf::PLAYER{$pl->ob->name};	1315	delete $cf::PLAYER{$pl->ob->name};
1023	$pl->destroy;	1316	$pl->destroy;
		1317
		1318	my $prefix = qr<^~\Q$name\E/>;
		1319
		1320	# nuke player maps
		1321	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1322
1024	IO::AIO::aio_rmtree $temp;	1323	IO::AIO::aio_rmtree $temp;
		1324	}
		1325
		1326	=item $pl->kick
		1327
		1328	Kicks a player out of the game. This destroys the connection.
		1329
		1330	=cut
		1331
		1332	sub kick {
		1333	my ($pl, $kicker) = @_;
		1334
		1335	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1336	$pl->killer ("kicked");
		1337	$pl->ns->destroy;
1025	}	1338	}
1026		1339
1027	=item cf::player::list_logins	1340	=item cf::player::list_logins
1028		1341
1029	Returns am arrayref of all valid playernames in the system, can take a	1342	Returns am arrayref of all valid playernames in the system, can take a
1030	while and may block, so not sync_job-capable, ever.	1343	while and may block, so not sync_job-capable, ever.
1031		1344
1032	=cut	1345	=cut
1033		1346
1034	sub list_logins {	1347	sub list_logins {
1035	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1348	my $dirs = aio_readdir $PLAYERDIR
1036	or return [];	1349	or return [];
1037		1350
1038	my @logins;	1351	my @logins;
1039		1352
1040	for my $login (@$dirs) {	1353	for my $login (@$dirs) {
…		…
1057	=cut	1370	=cut
1058		1371
1059	sub maps($) {	1372	sub maps($) {
1060	my ($pl) = @_;	1373	my ($pl) = @_;
1061		1374
		1375	$pl = ref $pl ? $pl->ob->name : $pl;
		1376
1062	my $files = aio_readdir playerdir $pl	1377	my $files = aio_readdir playerdir $pl
1063	or return;	1378	or return;
1064		1379
1065	my @paths;	1380	my @paths;
1066		1381
1067	for (@$files) {	1382	for (@$files) {
1068	utf8::decode $_;	1383	utf8::decode $_;
1069	next if /\.(?:pl|pst)$/;	1384	next if /\.(?:pl|pst)$/;
1070	next unless /^$PATH_SEP/o;	1385	next unless /^$PATH_SEP/o;
1071		1386
1072	s/\.map$//;	1387	push @paths, cf::map::normalise "~$pl/$_";
1073	push @paths, "~" . $pl->ob->name . "/" . $_;
1074	}	1388	}
1075		1389
1076	\@paths	1390	\@paths
1077	}	1391	}
1078		1392
		1393	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1394
		1395	Expand crossfire pod fragments into protocol xml.
		1396
		1397	=cut
		1398
		1399	sub expand_cfpod {
		1400	((my $self), (local $_)) = @_;
		1401
		1402	# escape & and <
		1403	s/&/&amp;/g;
		1404	s/(?<![BIUGH])</&lt;/g;
		1405
		1406	# this is buggy, it needs to properly take care of nested <'s
		1407
		1408	1 while
		1409	# replace B<>, I<>, U<> etc.
		1410	s/B<([^\>]*)>/<b>$1<\/b>/
		1411	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1412	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1413	# replace G<male|female> tags
		1414	|| s{G<([^>|]*)\|([^>]*)>}{
		1415	$self->gender ? $2 : $1
		1416	}ge
		1417	# replace H<hint text>
		1418	|| s{H<([^\>]*)>}
		1419	{
		1420	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1421	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1422	"")
		1423	[$self->{hintmode}]
		1424	}ge;
		1425
		1426	# create single paragraphs (very hackish)
		1427	s/(?<=\S)\n(?=\w)/ /g;
		1428
		1429	# compress some whitespace
		1430	s/\s+\n/\n/g; # ws line-ends
		1431	s/\n\n+/\n/g; # double lines
		1432	s/^\n+//; # beginning lines
		1433	s/\n+$//; # ending lines
		1434
		1435	$_
		1436	}
		1437
		1438	sub hintmode {
		1439	$_[0]{hintmode} = $_[1] if @_ > 1;
		1440	$_[0]{hintmode}
		1441	}
		1442
1079	=item $player->ext_reply ($msgid, $msgtype, %msg)	1443	=item $player->ext_reply ($msgid, %msg)
1080		1444
1081	Sends an ext reply to the player.	1445	Sends an ext reply to the player.
1082		1446
1083	=cut	1447	=cut
1084		1448
1085	sub ext_reply($$$%) {	1449	sub ext_reply($$%) {
1086	my ($self, $id, %msg) = @_;	1450	my ($self, $id, %msg) = @_;
1087		1451
1088	$msg{msgid} = $id;	1452	$msg{msgid} = $id;
1089		1453	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1090	$self->send ("ext " . cf::to_json \%msg);
1091	}	1454	}
1092		1455
1093	package cf;	1456	=item $player->ext_event ($type, %msg)
		1457
		1458	Sends an ext event to the client.
		1459
		1460	=cut
		1461
		1462	sub ext_event($$%) {
		1463	my ($self, $type, %msg) = @_;
		1464
		1465	$self->ns->ext_event ($type, %msg);
		1466	}
		1467
		1468	=head3 cf::region
		1469
		1470	=over 4
		1471
		1472	=cut
		1473
		1474	package cf::region;
		1475
		1476	=item cf::region::find_by_path $path
		1477
		1478	Tries to decuce the likely region for a map knowing only its path.
		1479
		1480	=cut
		1481
		1482	sub find_by_path($) {
		1483	my ($path) = @_;
		1484
		1485	my ($match, $specificity);
		1486
		1487	for my $region (list) {
		1488	if ($region->match && $path =~ $region->match) {
		1489	($match, $specificity) = ($region, $region->specificity)
		1490	if $region->specificity > $specificity;
		1491	}
		1492	}
		1493
		1494	$match
		1495	}
1094		1496
1095	=back	1497	=back
1096
1097		1498
1098	=head3 cf::map	1499	=head3 cf::map
1099		1500
1100	=over 4	1501	=over 4
1101		1502
…		…
1105		1506
1106	use Fcntl;	1507	use Fcntl;
1107	use Coro::AIO;	1508	use Coro::AIO;
1108		1509
1109	use overload	1510	use overload
1110	'""' => \&as_string;	1511	'""' => \&as_string,
		1512	fallback => 1;
1111		1513
1112	our $MAX_RESET = 3600;	1514	our $MAX_RESET = 3600;
1113	our $DEFAULT_RESET = 3000;	1515	our $DEFAULT_RESET = 3000;
1114		1516
1115	sub generate_random_map {	1517	sub generate_random_map {
1116	my ($self, $rmp) = @_;	1518	my ($self, $rmp) = @_;
1117
1118	# mit "rum" bekleckern, nicht	1519	# mit "rum" bekleckern, nicht
1119	$self->_create_random_map (	1520	$self->_create_random_map (
1120	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1521	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1121	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1522	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1122	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1523	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1129	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1530	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1130	(cf::region::find $rmp->{region}), $rmp->{custom}	1531	(cf::region::find $rmp->{region}), $rmp->{custom}
1131	)	1532	)
1132	}	1533	}
1133		1534
		1535	=item cf::map->register ($regex, $prio)
		1536
		1537	Register a handler for the map path matching the given regex at the
		1538	givne priority (higher is better, built-in handlers have priority 0, the
		1539	default).
		1540
		1541	=cut
		1542
1134	sub register {	1543	sub register {
1135	my (undef, $regex) = @_;	1544	my (undef, $regex, $prio) = @_;
1136	my $pkg = caller;	1545	my $pkg = caller;
1137		1546
1138	no strict;	1547	no strict;
1139	push @{"$pkg\::ISA"}, __PACKAGE__;	1548	push @{"$pkg\::ISA"}, __PACKAGE__;
1140		1549
1141	$EXT_MAP{$pkg} = qr<$regex>;	1550	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1142	}	1551	}
1143		1552
1144	# also paths starting with '/'	1553	# also paths starting with '/'
1145	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1554	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1555
		1556	sub thawer_merge {
		1557	my ($self, $merge) = @_;
		1558
		1559	# we have to keep some variables in memory intact
		1560	local $self->{path};
		1561	local $self->{load_path};
		1562
		1563	$self->SUPER::thawer_merge ($merge);
		1564	}
1146		1565
1147	sub normalise {	1566	sub normalise {
1148	my ($path, $base) = @_;	1567	my ($path, $base) = @_;
		1568
		1569	$path = "$path"; # make sure its a string
		1570
		1571	$path =~ s/\.map$//;
1149		1572
1150	# map plan:	1573	# map plan:
1151	#	1574	#
1152	# /! non-realised random map exit (special hack!)	1575	# /! non-realised random map exit (special hack!)
1153	# {... are special paths that are not being touched	1576	# {... are special paths that are not being touched
…		…
1181		1604
1182	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1605	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1183		1606
1184	$path = normalise $path, $base;	1607	$path = normalise $path, $base;
1185		1608
1186	for my $pkg (keys %EXT_MAP) {	1609	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1187	if ($path =~ $EXT_MAP{$pkg}) {	1610	if ($path =~ $EXT_MAP{$pkg}[1]) {
1188	my $self = bless cf::map::new, $pkg;	1611	my $self = bless cf::map::new, $pkg;
1189	$self->{path} = $path; $self->path ($path);	1612	$self->{path} = $path; $self->path ($path);
1190	$self->init; # pass $1 etc.	1613	$self->init; # pass $1 etc.
1191	return $self;	1614	return $self;
1192	}	1615	}
1193	}	1616	}
1194		1617
1195	Carp::carp "unable to resolve path '$path'.";	1618	Carp::carp "unable to resolve path '$path' (base '$base').";
1196	()	1619	()
1197	}	1620	}
1198		1621
1199	sub init {	1622	sub init {
1200	my ($self) = @_;	1623	my ($self) = @_;
…		…
1215		1638
1216	# the original (read-only) location	1639	# the original (read-only) location
1217	sub load_path {	1640	sub load_path {
1218	my ($self) = @_;	1641	my ($self) = @_;
1219		1642
1220	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1643	"$MAPDIR/$self->{path}.map"
1221	}	1644	}
1222		1645
1223	# the temporary/swap location	1646	# the temporary/swap location
1224	sub save_path {	1647	sub save_path {
1225	my ($self) = @_;	1648	my ($self) = @_;
1226		1649
1227	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1650	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1228	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1651	"$TMPDIR/$path.map"
1229	}	1652	}
1230		1653
1231	# the unique path, undef == no special unique path	1654	# the unique path, undef == no special unique path
1232	sub uniq_path {	1655	sub uniq_path {
1233	my ($self) = @_;	1656	my ($self) = @_;
1234		1657
1235	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1658	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1236	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1659	"$UNIQUEDIR/$path"
1237	}	1660	}
1238		1661
1239	# and all this just because we cannot iterate over	1662	# and all this just because we cannot iterate over
1240	# all maps in C++...	1663	# all maps in C++...
1241	sub change_all_map_light {	1664	sub change_all_map_light {
…		…
1243		1666
1244	$_->change_map_light ($change)	1667	$_->change_map_light ($change)
1245	for grep $_->outdoor, values %cf::MAP;	1668	for grep $_->outdoor, values %cf::MAP;
1246	}	1669	}
1247		1670
		1671	sub decay_objects {
		1672	my ($self) = @_;
		1673
		1674	return if $self->{deny_reset};
		1675
		1676	$self->do_decay_objects;
		1677	}
		1678
1248	sub unlink_save {	1679	sub unlink_save {
1249	my ($self) = @_;	1680	my ($self) = @_;
1250		1681
1251	utf8::encode (my $save = $self->save_path);	1682	utf8::encode (my $save = $self->save_path);
1252	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;	1683	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1253	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";	1684	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1254	}	1685	}
1255		1686
1256	sub load_header_from($) {	1687	sub load_header_from($) {
1257	my ($self, $path) = @_;	1688	my ($self, $path) = @_;
1258		1689
1259	utf8::encode $path;	1690	utf8::encode $path;
1260	aio_open $path, O_RDONLY, 0	1691	#aio_open $path, O_RDONLY, 0
1261	or return;	1692	# or return;
1262		1693
1263	$self->_load_header ($path)	1694	$self->_load_header ($path)
1264	or return;	1695	or return;
1265		1696
1266	$self->{load_path} = $path;	1697	$self->{load_path} = $path;
1267		1698
1268	1	1699	1
1269	}	1700	}
1270		1701
1271	sub load_orig {	1702	sub load_header_orig {
1272	my ($self) = @_;	1703	my ($self) = @_;
1273		1704
1274	$self->load_header_from ($self->load_path)	1705	$self->load_header_from ($self->load_path)
1275	}	1706	}
1276		1707
1277	sub load_temp {	1708	sub load_header_temp {
1278	my ($self) = @_;	1709	my ($self) = @_;
1279		1710
1280	$self->load_header_from ($self->save_path)	1711	$self->load_header_from ($self->save_path)
		1712	}
		1713
		1714	sub prepare_temp {
		1715	my ($self) = @_;
		1716
		1717	$self->last_access ((delete $self->{last_access})
		1718	|| $cf::RUNTIME); #d#
		1719	# safety
		1720	$self->{instantiate_time} = $cf::RUNTIME
		1721	if $self->{instantiate_time} > $cf::RUNTIME;
		1722	}
		1723
		1724	sub prepare_orig {
		1725	my ($self) = @_;
		1726
		1727	$self->{load_original} = 1;
		1728	$self->{instantiate_time} = $cf::RUNTIME;
		1729	$self->last_access ($cf::RUNTIME);
		1730	$self->instantiate;
1281	}	1731	}
1282		1732
1283	sub load_header {	1733	sub load_header {
1284	my ($self) = @_;	1734	my ($self) = @_;
1285		1735
1286	if ($self->load_temp) {	1736	if ($self->load_header_temp) {
1287	$self->last_access ((delete $self->{last_access})	1737	$self->prepare_temp;
1288	|| $cf::RUNTIME); #d#
1289	# safety
1290	$self->{instantiate_time} = $cf::RUNTIME
1291	if $self->{instantiate_time} > $cf::RUNTIME;
1292	} else {	1738	} else {
1293	$self->load_orig	1739	$self->load_header_orig
1294	or return;	1740	or return;
1295		1741	$self->prepare_orig;
1296	$self->{load_original} = 1;
1297	$self->{instantiate_time} = $cf::RUNTIME;
1298	$self->last_access ($cf::RUNTIME);
1299	$self->instantiate;
1300	}	1742	}
		1743
		1744	$self->{deny_reset} = 1
		1745	if $self->no_reset;
		1746
		1747	$self->default_region (cf::region::find_by_path $self->{path})
		1748	unless $self->default_region;
1301		1749
1302	1	1750	1
1303	}	1751	}
1304		1752
1305	sub find;	1753	sub find;
…		…
1318	$map->{last_save} = $cf::RUNTIME;	1766	$map->{last_save} = $cf::RUNTIME;
1319		1767
1320	$map->load_header	1768	$map->load_header
1321	or return;	1769	or return;
1322		1770
1323	if ($map->should_reset) {	1771	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1772	# doing this can freeze the server in a sync job, obviously
		1773	#$cf::WAIT_FOR_TICK->wait;
1324	$map->reset;	1774	$map->reset;
1325	undef $guard;	1775	undef $guard;
1326	$map = find $path	1776	return find $path;
1327	or return;
1328	}	1777	}
1329		1778
1330	$cf::MAP{$path} = $map	1779	$cf::MAP{$path} = $map
1331	}	1780	}
1332	}	1781	}
		1782
		1783	sub pre_load { }
		1784	sub post_load { }
1333		1785
1334	sub load {	1786	sub load {
1335	my ($self) = @_;	1787	my ($self) = @_;
1336		1788
		1789	local $self->{deny_reset} = 1; # loading can take a long time
		1790
1337	my $path = $self->{path};	1791	my $path = $self->{path};
		1792
		1793	{
1338	my $guard = cf::lock_acquire "map_load:$path";	1794	my $guard = cf::lock_acquire "map_load:$path";
1339		1795
1340	return if $self->in_memory != cf::MAP_SWAPPED;	1796	return if $self->in_memory != cf::MAP_SWAPPED;
1341		1797
1342	$self->in_memory (cf::MAP_LOADING);	1798	$self->in_memory (cf::MAP_LOADING);
1343		1799
1344	$self->alloc;	1800	$self->alloc;
1345	$self->_load_objects ($self->{load_path}, 1)
1346	or return;
1347		1801
1348	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1802	$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;	1803	Coro::cede;
1369	$self->set_darkness_map;	1804
		1805	$self->_load_objects ($self->{load_path}, 1)
		1806	or return;
		1807
		1808	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1809	if delete $self->{load_original};
		1810
		1811	if (my $uniq = $self->uniq_path) {
		1812	utf8::encode $uniq;
		1813	if (aio_open $uniq, O_RDONLY, 0) {
		1814	$self->clear_unique_items;
		1815	$self->_load_objects ($uniq, 0);
		1816	}
		1817	}
		1818
		1819	Coro::cede;
		1820	# now do the right thing for maps
		1821	$self->link_multipart_objects;
1370	$self->difficulty ($self->estimate_difficulty)	1822	$self->difficulty ($self->estimate_difficulty)
1371	unless $self->difficulty;	1823	unless $self->difficulty;
1372	Coro::cede;	1824	Coro::cede;
		1825
		1826	unless ($self->{deny_activate}) {
		1827	$self->decay_objects;
		1828	$self->fix_auto_apply;
		1829	$self->update_buttons;
		1830	Coro::cede;
		1831	$self->set_darkness_map;
		1832	Coro::cede;
1373	$self->activate;	1833	$self->activate;
1374	}	1834	}
1375		1835
1376	$self->in_memory (cf::MAP_IN_MEMORY);	1836	$self->in_memory (cf::MAP_IN_MEMORY);
		1837	}
		1838
		1839	$self->post_load;
1377	}	1840	}
1378		1841
1379	sub customise_for {	1842	sub customise_for {
1380	my ($self, $ob) = @_;	1843	my ($self, $ob) = @_;
1381		1844
1382	return find "~" . $ob->name . "/" . $self->{path}	1845	return find "~" . $ob->name . "/" . $self->{path}
1383	if $self->per_player;	1846	if $self->per_player;
		1847
		1848	# return find "?party/" . $ob->name . "/" . $self->{path}
		1849	# if $self->per_party;
1384		1850
1385	$self	1851	$self
1386	}	1852	}
1387		1853
1388	# find and load all maps in the 3x3 area around a map	1854	# find and load all maps in the 3x3 area around a map
…		…
1420		1886
1421	cf::sync_job { $map->load };	1887	cf::sync_job { $map->load };
1422	}	1888	}
1423		1889
1424	our %MAP_PREFETCH;	1890	our %MAP_PREFETCH;
1425	our $MAP_PREFETCHER = Coro::async {	1891	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		1892
1438	sub find_async {	1893	sub find_async {
1439	my ($path, $origin) = @_;	1894	my ($path, $origin) = @_;
1440		1895
1441	$path = normalise $path, $origin && $origin->{path};	1896	$path = normalise $path, $origin && $origin->{path};
1442		1897
1443	if (my $map = $cf::MAP{$path}) {	1898	if (my $map = $cf::MAP{$path}) {
1444	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1899	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1445	}	1900	}
1446		1901
1447	$MAP_PREFETCH{$path} = 0;	1902	undef $MAP_PREFETCH{$path};
		1903	$MAP_PREFETCHER ||= cf::async {
		1904	while (%MAP_PREFETCH) {
		1905	for my $path (keys %MAP_PREFETCH) {
		1906	my $map = find $path
		1907	or next;
		1908	$map->load;
		1909
		1910	delete $MAP_PREFETCH{$path};
		1911	}
		1912	}
		1913	undef $MAP_PREFETCHER;
		1914	};
1448	$MAP_PREFETCHER->ready;	1915	$MAP_PREFETCHER->prio (6);
1449		1916
1450	()	1917	()
1451	}	1918	}
1452		1919
1453	sub save {	1920	sub save {
…		…
1498		1965
1499	sub reset_at {	1966	sub reset_at {
1500	my ($self) = @_;	1967	my ($self) = @_;
1501		1968
1502	# TODO: safety, remove and allow resettable per-player maps	1969	# 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};	1970	return 1e99 if $self->{deny_reset};
1505		1971
1506	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1972	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1507	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1973	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1508		1974
…		…
1513	my ($self) = @_;	1979	my ($self) = @_;
1514		1980
1515	$self->reset_at <= $cf::RUNTIME	1981	$self->reset_at <= $cf::RUNTIME
1516	}	1982	}
1517		1983
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 {	1984	sub reset {
1533	my ($self) = @_;	1985	my ($self) = @_;
1534		1986
1535	my $lock = cf::lock_acquire "map_data:$self->{path}";	1987	my $lock = cf::lock_acquire "map_data:$self->{path}";
1536		1988
1537	return if $self->players;	1989	return if $self->players;
1538	return if $self->isa ("ext::map_per_player");#d#
1539		1990
1540	warn "resetting map ", $self->path;#d#	1991	warn "resetting map ", $self->path;
		1992
		1993	$self->in_memory (cf::MAP_SWAPPED);
		1994
		1995	# need to save uniques path
		1996	unless ($self->{deny_save}) {
		1997	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1998
		1999	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2000	if $uniq;
		2001	}
1541		2002
1542	delete $cf::MAP{$self->path};	2003	delete $cf::MAP{$self->path};
1543		2004
1544	$self->in_memory (cf::MAP_SWAPPED);
1545	$self->clear;	2005	$self->clear;
1546		2006
1547	$_->clear_links_to ($self) for values %cf::MAP;	2007	$_->clear_links_to ($self) for values %cf::MAP;
1548		2008
1549	$self->unlink_save;	2009	$self->unlink_save;
…		…
1553	my $nuke_counter = "aaaa";	2013	my $nuke_counter = "aaaa";
1554		2014
1555	sub nuke {	2015	sub nuke {
1556	my ($self) = @_;	2016	my ($self) = @_;
1557		2017
		2018	delete $cf::MAP{$self->path};
		2019
		2020	$self->unlink_save;
		2021
		2022	bless $self, "cf::map";
		2023	delete $self->{deny_reset};
1558	$self->{deny_save} = 1;	2024	$self->{deny_save} = 1;
1559	$self->reset_timeout (1);	2025	$self->reset_timeout (1);
1560	$self->rename ("{nuke}/" . ($nuke_counter++));	2026	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2027
		2028	$cf::MAP{$self->path} = $self;
		2029
1561	$self->reset; # polite request, might not happen	2030	$self->reset; # polite request, might not happen
		2031	}
		2032
		2033	=item $maps = cf::map::tmp_maps
		2034
		2035	Returns an arrayref with all map paths of currently instantiated and saved
		2036	maps. May block.
		2037
		2038	=cut
		2039
		2040	sub tmp_maps() {
		2041	[
		2042	map {
		2043	utf8::decode $_;
		2044	/\.map$/
		2045	? normalise $_
		2046	: ()
		2047	} @{ aio_readdir $TMPDIR or [] }
		2048	]
		2049	}
		2050
		2051	=item $maps = cf::map::random_maps
		2052
		2053	Returns an arrayref with all map paths of currently instantiated and saved
		2054	random maps. May block.
		2055
		2056	=cut
		2057
		2058	sub random_maps() {
		2059	[
		2060	map {
		2061	utf8::decode $_;
		2062	/\.map$/
		2063	? normalise "?random/$_"
		2064	: ()
		2065	} @{ aio_readdir $RANDOMDIR or [] }
		2066	]
1562	}	2067	}
1563		2068
1564	=item cf::map::unique_maps	2069	=item cf::map::unique_maps
1565		2070
1566	Returns an arrayref of paths of all shared maps that have	2071	Returns an arrayref of paths of all shared maps that have
1567	instantiated unique items. May block.	2072	instantiated unique items. May block.
1568		2073
1569	=cut	2074	=cut
1570		2075
1571	sub unique_maps() {	2076	sub unique_maps() {
1572	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2077	[
1573	or return;	2078	map {
1574
1575	my @paths;
1576
1577	for (@$files) {
1578	utf8::decode $_;	2079	utf8::decode $_;
1579	next if /\.pst$/;
1580	next unless /^$PATH_SEP/o;
1581
1582	s/\.map$//;	2080	/\.map$/
1583	push @paths, $_;	2081	? normalise $_
		2082	: ()
		2083	} @{ aio_readdir $UNIQUEDIR or [] }
1584	}	2084	]
1585
1586	\@paths
1587	}	2085	}
1588		2086
1589	package cf;	2087	package cf;
1590		2088
1591	=back	2089	=back
…		…
1637		2135
1638	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2136	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1639		2137
1640	if ($self->{record_replies}) {	2138	if ($self->{record_replies}) {
1641	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2139	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2140
1642	} else {	2141	} else {
		2142	my $pl = $self->contr;
		2143
		2144	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2145	my $diag = $pl->{npc_dialog};
		2146	$diag->{pl}->ext_reply (
		2147	$diag->{id},
		2148	msgtype => "reply",
		2149	msg => $diag->{pl}->expand_cfpod ($msg),
		2150	add_topics => []
		2151	);
		2152
		2153	} else {
1643	$msg = $npc->name . " says: $msg" if $npc;	2154	$msg = $npc->name . " says: $msg" if $npc;
1644	$self->message ($msg, $flags);	2155	$self->message ($msg, $flags);
		2156	}
1645	}	2157	}
1646	}	2158	}
1647		2159
1648	=item $player_object->may ("access")	2160	=item $player_object->may ("access")
1649		2161
…		…
1682	=cut	2194	=cut
1683		2195
1684	sub link_map {	2196	sub link_map {
1685	unless ($LINK_MAP) {	2197	unless ($LINK_MAP) {
1686	$LINK_MAP = cf::map::find "{link}"	2198	$LINK_MAP = cf::map::find "{link}"
1687	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2199	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1688	$LINK_MAP->load;	2200	$LINK_MAP->load;
1689	}	2201	}
1690		2202
1691	$LINK_MAP	2203	$LINK_MAP
1692	}	2204	}
…		…
1697	$self->deactivate_recursive;	2209	$self->deactivate_recursive;
1698		2210
1699	return if UNIVERSAL::isa $self->map, "ext::map_link";	2211	return if UNIVERSAL::isa $self->map, "ext::map_link";
1700		2212
1701	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2213	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1702	if $self->map;	2214	if $self->map && $self->map->{path} ne "{link}";
1703		2215
1704	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2216	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1705	}	2217	}
1706		2218
1707	sub cf::object::player::leave_link {	2219	sub cf::object::player::leave_link {
1708	my ($self, $map, $x, $y) = @_;	2220	my ($self, $map, $x, $y) = @_;
		2221
		2222	return unless $self->contr->active;
1709		2223
1710	my $link_pos = delete $self->{_link_pos};	2224	my $link_pos = delete $self->{_link_pos};
1711		2225
1712	unless ($map) {	2226	unless ($map) {
1713	# restore original map position	2227	# restore original map position
…		…
1731	$map->load;	2245	$map->load;
1732	$map->load_diag;	2246	$map->load_diag;
1733		2247
1734	return unless $self->contr->active;	2248	return unless $self->contr->active;
1735	$self->activate_recursive;	2249	$self->activate_recursive;
		2250
		2251	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1736	$self->enter_map ($map, $x, $y);	2252	$self->enter_map ($map, $x, $y);
1737	}	2253	}
1738		2254
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)	2255	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1772		2256
		2257	Moves the player to the given map-path and coordinates by first freezing
		2258	her, loading and preparing them map, calling the provided $check callback
		2259	that has to return the map if sucecssful, and then unfreezes the player on
		2260	the new (success) or old (failed) map position.
		2261
1773	=cut	2262	=cut
		2263
		2264	our $GOTOGEN;
1774		2265
1775	sub cf::object::player::goto {	2266	sub cf::object::player::goto {
1776	my ($self, $path, $x, $y) = @_;	2267	my ($self, $path, $x, $y, $check) = @_;
		2268
		2269	# do generation counting so two concurrent goto's will be executed in-order
		2270	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1777		2271
1778	$self->enter_link;	2272	$self->enter_link;
1779		2273
1780	(async {	2274	(async {
		2275	my $map = eval {
1781	my $map = cf::map::find $path;	2276	my $map = cf::map::find $path;
		2277
		2278	if ($map) {
1782	$map = $map->customise_for ($self) if $map;	2279	$map = $map->customise_for ($self);
1783		2280	$map = $check->($map) if $check && $map;
1784	# warn "entering ", $map->path, " at ($x, $y)\n"	2281	} else {
1785	# if $map;
1786
1787	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2282	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2283	}
1788		2284
		2285	$map
		2286	};
		2287
		2288	if ($@) {
		2289	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2290	LOG llevError | logBacktrace, Carp::longmess $@;
		2291	}
		2292
		2293	if ($gen == $self->{_goto_generation}) {
		2294	delete $self->{_goto_generation};
1789	$self->leave_link ($map, $x, $y);	2295	$self->leave_link ($map, $x, $y);
		2296	}
1790	})->prio (1);	2297	})->prio (1);
1791	}	2298	}
1792		2299
1793	=item $player_object->enter_exit ($exit_object)	2300	=item $player_object->enter_exit ($exit_object)
1794		2301
…		…
1796		2303
1797	sub parse_random_map_params {	2304	sub parse_random_map_params {
1798	my ($spec) = @_;	2305	my ($spec) = @_;
1799		2306
1800	my $rmp = { # defaults	2307	my $rmp = { # defaults
1801	xsize => 10,	2308	xsize => (cf::rndm 15, 40),
1802	ysize => 10,	2309	ysize => (cf::rndm 15, 40),
		2310	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2311	#layout => string,
1803	};	2312	};
1804		2313
1805	for (split /\n/, $spec) {	2314	for (split /\n/, $spec) {
1806	my ($k, $v) = split /\s+/, $_, 2;	2315	my ($k, $v) = split /\s+/, $_, 2;
1807		2316
…		…
1811	$rmp	2320	$rmp
1812	}	2321	}
1813		2322
1814	sub prepare_random_map {	2323	sub prepare_random_map {
1815	my ($exit) = @_;	2324	my ($exit) = @_;
		2325
		2326	my $guard = cf::lock_acquire "exit_prepare:$exit";
1816		2327
1817	# all this does is basically replace the /! path by	2328	# all this does is basically replace the /! path by
1818	# a new random map path (?random/...) with a seed	2329	# a new random map path (?random/...) with a seed
1819	# that depends on the exit object	2330	# that depends on the exit object
1820		2331
1821	my $rmp = parse_random_map_params $exit->msg;	2332	my $rmp = parse_random_map_params $exit->msg;
1822		2333
1823	if ($exit->map) {	2334	if ($exit->map) {
1824	$rmp->{region} = $exit->map->region_name;	2335	$rmp->{region} = $exit->region->name;
1825	$rmp->{origin_map} = $exit->map->path;	2336	$rmp->{origin_map} = $exit->map->path;
1826	$rmp->{origin_x} = $exit->x;	2337	$rmp->{origin_x} = $exit->x;
1827	$rmp->{origin_y} = $exit->y;	2338	$rmp->{origin_y} = $exit->y;
1828	}	2339	}
1829		2340
1830	$rmp->{random_seed} ||= $exit->random_seed;	2341	$rmp->{random_seed} ||= $exit->random_seed;
1831		2342
1832	my $data = cf::to_json $rmp;	2343	my $data = cf::to_json $rmp;
1833	my $md5 = Digest::MD5::md5_hex $data;	2344	my $md5 = Digest::MD5::md5_hex $data;
		2345	my $meta = "$RANDOMDIR/$md5.meta";
1834		2346
1835	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2347	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1836	aio_write $fh, 0, (length $data), $data, 0;	2348	aio_write $fh, 0, (length $data), $data, 0;
		2349	undef $fh;
		2350	aio_rename "$meta~", $meta;
1837		2351
1838	$exit->slaying ("?random/$md5");	2352	$exit->slaying ("?random/$md5");
1839	$exit->msg (undef);	2353	$exit->msg (undef);
1840	}	2354	}
1841	}	2355	}
…		…
1843	sub cf::object::player::enter_exit {	2357	sub cf::object::player::enter_exit {
1844	my ($self, $exit) = @_;	2358	my ($self, $exit) = @_;
1845		2359
1846	return unless $self->type == cf::PLAYER;	2360	return unless $self->type == cf::PLAYER;
1847		2361
		2362	if ($exit->slaying eq "/!") {
		2363	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2364	# the problem is that $exit might not survive long enough
		2365	# so it needs to be done right now, right here
		2366	cf::sync_job { prepare_random_map $exit };
		2367	}
		2368
		2369	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2370	my $hp = $exit->stats->hp;
		2371	my $sp = $exit->stats->sp;
		2372
1848	$self->enter_link;	2373	$self->enter_link;
		2374
		2375	# if exit is damned, update players death & WoR home-position
		2376	$self->contr->savebed ($slaying, $hp, $sp)
		2377	if $exit->flag (FLAG_DAMNED);
1849		2378
1850	(async {	2379	(async {
1851	$self->deactivate_recursive; # just to be sure	2380	$self->deactivate_recursive; # just to be sure
1852	unless (eval {	2381	unless (eval {
1853	prepare_random_map $exit	2382	$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		2383
1859	1;	2384	1;
1860	}) {	2385	}) {
1861	$self->message ("Something went wrong deep within the crossfire server. "	2386	$self->message ("Something went wrong deep within the crossfire server. "
1862	. "I'll try to bring you back to the map you were before. "	2387	. "I'll try to bring you back to the map you were before. "
1863	. "Please report this to the dungeon master!",	2388	. "Please report this to the dungeon master!",
1864	cf::NDI_UNIQUE | cf::NDI_RED);	2389	cf::NDI_UNIQUE | cf::NDI_RED);
1865		2390
1866	warn "ERROR in enter_exit: $@";	2391	warn "ERROR in enter_exit: $@";
1867	$self->leave_link;	2392	$self->leave_link;
1868	}	2393	}
1869	})->prio (1);	2394	})->prio (1);
…		…
1882		2407
1883	sub cf::client::send_drawinfo {	2408	sub cf::client::send_drawinfo {
1884	my ($self, $text, $flags) = @_;	2409	my ($self, $text, $flags) = @_;
1885		2410
1886	utf8::encode $text;	2411	utf8::encode $text;
1887	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2412	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1888	}	2413	}
1889		2414
		2415	=item $client->send_msg ($color, $type, $msg, [extra...])
		2416
		2417	Send a drawinfo or msg packet to the client, formatting the msg for the
		2418	client if neccessary. C<$type> should be a string identifying the type of
		2419	the message, with C<log> being the default. If C<$color> is negative, suppress
		2420	the message unless the client supports the msg packet.
		2421
		2422	=cut
		2423
		2424	sub cf::client::send_msg {
		2425	my ($self, $color, $type, $msg, @extra) = @_;
		2426
		2427	$msg = $self->pl->expand_cfpod ($msg);
		2428
		2429	return unless @extra || length $msg;
		2430
		2431	if ($self->can_msg) {
		2432	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2433	} else {
		2434	# replace some tags by gcfclient-compatible ones
		2435	for ($msg) {
		2436	1 while
		2437	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2438	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2439	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2440	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2441	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2442	}
		2443
		2444	if ($color >= 0) {
		2445	if (0 && $msg =~ /\[/) {
		2446	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2447	} else {
		2448	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2449	$self->send_packet ("drawinfo $color $msg")
		2450	}
		2451	}
		2452	}
		2453	}
		2454
		2455	=item $client->ext_event ($type, %msg)
		2456
		2457	Sends an ext event to the client.
		2458
		2459	=cut
		2460
		2461	sub cf::client::ext_event($$%) {
		2462	my ($self, $type, %msg) = @_;
		2463
		2464	$msg{msgtype} = "event_$type";
		2465	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2466	}
1890		2467
1891	=item $success = $client->query ($flags, "text", \&cb)	2468	=item $success = $client->query ($flags, "text", \&cb)
1892		2469
1893	Queues a query to the client, calling the given callback with	2470	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>,	2471	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>.	2472	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1896		2473
1897	Queries can fail, so check the return code. Or don't, as queries will become	2474	Queries can fail, so check the return code. Or don't, as queries will
1898	reliable at some point in the future.	2475	become reliable at some point in the future.
1899		2476
1900	=cut	2477	=cut
1901		2478
1902	sub cf::client::query {	2479	sub cf::client::query {
1903	my ($self, $flags, $text, $cb) = @_;	2480	my ($self, $flags, $text, $cb) = @_;
…		…
1911	utf8::encode $text;	2488	utf8::encode $text;
1912	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2489	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1913		2490
1914	$self->send_packet ($self->{query_queue}[0][0])	2491	$self->send_packet ($self->{query_queue}[0][0])
1915	if @{ $self->{query_queue} } == 1;	2492	if @{ $self->{query_queue} } == 1;
		2493
		2494	1
1916	}	2495	}
1917		2496
1918	cf::client->attach (	2497	cf::client->attach (
		2498	on_connect => sub {
		2499	my ($ns) = @_;
		2500
		2501	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2502	},
1919	on_reply => sub {	2503	on_reply => sub {
1920	my ($ns, $msg) = @_;	2504	my ($ns, $msg) = @_;
1921		2505
1922	# this weird shuffling is so that direct followup queries	2506	# this weird shuffling is so that direct followup queries
1923	# get handled first	2507	# get handled first
1924	my $queue = delete $ns->{query_queue}	2508	my $queue = delete $ns->{query_queue}
1925	or return; # be conservative, not sure how that can happen, but we saw a crash here	2509	or return; # be conservative, not sure how that can happen, but we saw a crash here
1926		2510
1927	(shift @$queue)->[1]->($msg);	2511	(shift @$queue)->[1]->($msg);
		2512	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1928		2513
1929	push @{ $ns->{query_queue} }, @$queue;	2514	push @{ $ns->{query_queue} }, @$queue;
1930		2515
1931	if (@{ $ns->{query_queue} } == @$queue) {	2516	if (@{ $ns->{query_queue} } == @$queue) {
1932	if (@$queue) {	2517	if (@$queue) {
…		…
1934	} else {	2519	} else {
1935	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2520	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1936	}	2521	}
1937	}	2522	}
1938	},	2523	},
		2524	on_exticmd => sub {
		2525	my ($ns, $buf) = @_;
		2526
		2527	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2528
		2529	if (ref $msg) {
		2530	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2531	if (my %reply = $cb->($ns, $msg)) {
		2532	$reply{msgid} = $msg->{msgid};
		2533	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2534	}
		2535	}
		2536	} else {
		2537	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2538	}
		2539
		2540	cf::override;
		2541	},
1939	);	2542	);
1940		2543
1941	=item $client->async (\&cb)	2544	=item $client->async (\&cb)
1942		2545
1943	Create a new coroutine, running the specified callback. The coroutine will	2546	Create a new coroutine, running the specified callback. The coroutine will
…		…
1990		2593
1991	# here we export the classes and methods available to script code	2594	# here we export the classes and methods available to script code
1992		2595
1993	=pod	2596	=pod
1994		2597
1995	The following fucntions and emthods are available within a safe environment:	2598	The following functions and methods are available within a safe environment:
1996		2599
1997	cf::object contr pay_amount pay_player map	2600	cf::object
		2601	contr pay_amount pay_player map x y force_find force_add
		2602	insert remove
		2603
1998	cf::object::player player	2604	cf::object::player
1999	cf::player peaceful	2605	player
2000	cf::map trigger	2606
		2607	cf::player
		2608	peaceful
		2609
		2610	cf::map
		2611	trigger
2001		2612
2002	=cut	2613	=cut
2003		2614
2004	for (	2615	for (
2005	["cf::object" => qw(contr pay_amount pay_player map)],	2616	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2617	insert remove)],
2006	["cf::object::player" => qw(player)],	2618	["cf::object::player" => qw(player)],
2007	["cf::player" => qw(peaceful)],	2619	["cf::player" => qw(peaceful)],
2008	["cf::map" => qw(trigger)],	2620	["cf::map" => qw(trigger)],
2009	) {	2621	) {
2010	no strict 'refs';	2622	no strict 'refs';
…		…
2081	=back	2693	=back
2082		2694
2083	=cut	2695	=cut
2084		2696
2085	#############################################################################	2697	#############################################################################
		2698	# the server's init and main functions
2086		2699
2087	=head2 EXTENSION DATABASE SUPPORT	2700	sub load_facedata($) {
		2701	my ($path) = @_;
2088		2702
2089	Crossfire maintains a very simple database for extension use. It can	2703	warn "loading facedata from $path\n";
2090	currently store anything that can be serialised using Storable, which
2091	excludes objects.
2092		2704
2093	The parameter C<$family> should best start with the name of the extension	2705	my $facedata;
2094	using it, it should be unique.	2706	0 < aio_load $path, $facedata
		2707	or die "$path: $!";
2095		2708
2096	=over 4	2709	$facedata = Coro::Storable::thaw $facedata;
2097		2710
2098	=item $hashref = cf::db_get $family	2711	$facedata->{version} == 2
		2712	or cf::cleanup "$path: version mismatch, cannot proceed.";
2099		2713
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	}	2714	{
		2715	my $faces = $facedata->{faceinfo};
2136		2716
2137	my $pid;	2717	while (my ($face, $info) = each %$faces) {
2138		2718	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2139	sub db_save() {	2719	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2140	waitpid $pid, 0 if $pid;	2720	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2141	if (0 == ($pid = fork)) {	2721	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2142	$DB->{_meta}{version} = 1;	2722	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	},	2723	}
2185	);
2186	}
2187		2724
2188	#############################################################################	2725	while (my ($face, $info) = each %$faces) {
2189	# the server's main()	2726	next unless $info->{smooth};
		2727	my $idx = cf::face::find $face
		2728	or next;
		2729	if (my $smooth = cf::face::find $info->{smooth}) {
		2730	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2731	} else {
		2732	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2733	}
		2734	Coro::cede;
		2735	}
		2736	}
		2737
		2738	{
		2739	my $anims = $facedata->{animinfo};
		2740
		2741	while (my ($anim, $info) = each %$anims) {
		2742	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2743	Coro::cede;
		2744	}
		2745
		2746	cf::anim::invalidate_all; # d'oh
		2747	}
		2748
		2749	1
		2750	}
		2751
		2752	sub reload_regions {
		2753	load_resource_file "$MAPDIR/regions"
		2754	or die "unable to load regions file\n";
		2755	}
		2756
		2757	sub reload_facedata {
		2758	load_facedata "$DATADIR/facedata"
		2759	or die "unable to load facedata\n";
		2760	}
		2761
		2762	sub reload_archetypes {
		2763	load_resource_file "$DATADIR/archetypes"
		2764	or die "unable to load archetypes\n";
		2765	#d# NEED to laod twice to resolve forward references
		2766	# this really needs to be done in an extra post-pass
		2767	# (which needs to be synchronous, so solve it differently)
		2768	load_resource_file "$DATADIR/archetypes"
		2769	or die "unable to load archetypes\n";
		2770	}
		2771
		2772	sub reload_treasures {
		2773	load_resource_file "$DATADIR/treasures"
		2774	or die "unable to load treasurelists\n";
		2775	}
		2776
		2777	sub reload_resources {
		2778	warn "reloading resource files...\n";
		2779
		2780	reload_regions;
		2781	reload_facedata;
		2782	#reload_archetypes;#d#
		2783	reload_archetypes;
		2784	reload_treasures;
		2785
		2786	warn "finished reloading resource files\n";
		2787	}
		2788
		2789	sub init {
		2790	reload_resources;
		2791	}
2190		2792
2191	sub cfg_load {	2793	sub cfg_load {
2192	open my $fh, "<:utf8", cf::confdir . "/config"	2794	open my $fh, "<:utf8", "$CONFDIR/config"
2193	or return;	2795	or return;
2194		2796
2195	local $/;	2797	local $/;
2196	*CFG = YAML::Syck::Load <$fh>;	2798	*CFG = YAML::Syck::Load <$fh>;
2197		2799
…		…
2211		2813
2212	sub main {	2814	sub main {
2213	# we must not ever block the main coroutine	2815	# we must not ever block the main coroutine
2214	local $Coro::idle = sub {	2816	local $Coro::idle = sub {
2215	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2817	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2818	(async {
2216	async { Event::one_event };	2819	Event::one_event;
		2820	})->prio (Coro::PRIO_MAX);
2217	};	2821	};
2218		2822
2219	cfg_load;	2823	cfg_load;
2220	db_load;	2824	db_init;
2221	load_extensions;	2825	load_extensions;
		2826
		2827	$TICK_WATCHER->start;
2222	Event::loop;	2828	Event::loop;
2223	}	2829	}
2224		2830
2225	#############################################################################	2831	#############################################################################
2226	# initialisation and cleanup	2832	# initialisation and cleanup
2227		2833
2228	# install some emergency cleanup handlers	2834	# install some emergency cleanup handlers
2229	BEGIN {	2835	BEGIN {
2230	for my $signal (qw(INT HUP TERM)) {	2836	for my $signal (qw(INT HUP TERM)) {
2231	Event->signal (	2837	Event->signal (
		2838	reentrant => 0,
2232	data => WF_AUTOCANCEL,	2839	data => WF_AUTOCANCEL,
2233	signal => $signal,	2840	signal => $signal,
		2841	prio => 0,
2234	cb => sub {	2842	cb => sub {
2235	cf::cleanup "SIG$signal";	2843	cf::cleanup "SIG$signal";
2236	},	2844	},
2237	);	2845	);
2238	}	2846	}
		2847	}
		2848
		2849	sub write_runtime {
		2850	my $runtime = "$LOCALDIR/runtime";
		2851
		2852	# first touch the runtime file to show we are still running:
		2853	# the fsync below can take a very very long time.
		2854
		2855	IO::AIO::aio_utime $runtime, undef, undef;
		2856
		2857	my $guard = cf::lock_acquire "write_runtime";
		2858
		2859	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2860	or return;
		2861
		2862	my $value = $cf::RUNTIME + 90 + 10;
		2863	# 10 is the runtime save interval, for a monotonic clock
		2864	# 60 allows for the watchdog to kill the server.
		2865
		2866	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2867	and return;
		2868
		2869	# always fsync - this file is important
		2870	aio_fsync $fh
		2871	and return;
		2872
		2873	# touch it again to show we are up-to-date
		2874	aio_utime $fh, undef, undef;
		2875
		2876	close $fh
		2877	or return;
		2878
		2879	aio_rename "$runtime~", $runtime
		2880	and return;
		2881
		2882	warn "runtime file written.\n";
		2883
		2884	1
2239	}	2885	}
2240		2886
2241	sub emergency_save() {	2887	sub emergency_save() {
2242	my $freeze_guard = cf::freeze_mainloop;	2888	my $freeze_guard = cf::freeze_mainloop;
2243		2889
…		…
2260	my $map = $cf::MAP{$path} or next;	2906	my $map = $cf::MAP{$path} or next;
2261	$map->valid or next;	2907	$map->valid or next;
2262	$map->save;	2908	$map->save;
2263	}	2909	}
2264	warn "end emergency map save\n";	2910	warn "end emergency map save\n";
		2911
		2912	warn "begin emergency database checkpoint\n";
		2913	BDB::db_env_txn_checkpoint $DB_ENV;
		2914	warn "end emergency database checkpoint\n";
2265	};	2915	};
2266		2916
2267	warn "leave emergency perl save\n";	2917	warn "leave emergency perl save\n";
2268	}	2918	}
2269		2919
		2920	sub post_cleanup {
		2921	my ($make_core) = @_;
		2922
		2923	warn Carp::longmess "post_cleanup backtrace"
		2924	if $make_core;
		2925	}
		2926
2270	sub reload() {	2927	sub do_reload_perl() {
2271	# can/must only be called in main	2928	# can/must only be called in main
2272	if ($Coro::current != $Coro::main) {	2929	if ($Coro::current != $Coro::main) {
2273	warn "can only reload from main coroutine\n";	2930	warn "can only reload from main coroutine";
2274	return;	2931	return;
2275	}	2932	}
2276		2933
2277	warn "reloading...";	2934	warn "reloading...";
2278		2935
2279	warn "freezing server";	2936	warn "entering sync_job";
2280	my $guard = freeze_mainloop;	2937
		2938	cf::sync_job {
		2939	cf::write_runtime; # external watchdog should not bark
2281	cf::emergency_save;	2940	cf::emergency_save;
		2941	cf::write_runtime; # external watchdog should not bark
2282		2942
2283	warn "sync database to disk";	2943	warn "syncing database to disk";
2284	cf::db_sync;	2944	BDB::db_env_txn_checkpoint $DB_ENV;
2285	IO::AIO::flush;
2286		2945
2287	eval {
2288	# if anything goes wrong in here, we should simply crash as we already saved	2946	# if anything goes wrong in here, we should simply crash as we already saved
2289		2947
2290	warn "cancel all watchers";	2948	warn "cancelling all WF_AUTOCANCEL watchers";
2291	for (Event::all_watchers) {	2949	for (Event::all_watchers) {
2292	$_->cancel if $_->data & WF_AUTOCANCEL;	2950	$_->cancel if $_->data & WF_AUTOCANCEL;
2293	}	2951	}
2294		2952
		2953	warn "flushing outstanding aio requests";
		2954	for (;;) {
		2955	BDB::flush;
		2956	IO::AIO::flush;
		2957	Coro::cede;
		2958	last unless IO::AIO::nreqs || BDB::nreqs;
		2959	warn "iterate...";
		2960	}
		2961
		2962	++$RELOAD;
		2963
2295	warn "cancel all extension coros";	2964	warn "cancelling all extension coros";
2296	$_->cancel for values %EXT_CORO;	2965	$_->cancel for values %EXT_CORO;
2297	%EXT_CORO = ();	2966	%EXT_CORO = ();
2298		2967
2299	warn "remove commands";	2968	warn "removing commands";
2300	%COMMAND = ();	2969	%COMMAND = ();
2301		2970
2302	warn "remove ext commands";	2971	warn "removing ext/exti commands";
2303	%EXTCMD = ();	2972	%EXTCMD = ();
		2973	%EXTICMD = ();
2304		2974
2305	warn "unload/nuke all extensions";	2975	warn "unloading/nuking all extensions";
2306	for my $pkg (@EXTS) {	2976	for my $pkg (@EXTS) {
2307	warn "... unloading $pkg";	2977	warn "... unloading $pkg";
2308		2978
2309	if (my $cb = $pkg->can ("unload")) {	2979	if (my $cb = $pkg->can ("unload")) {
2310	eval {	2980	eval {
…		…
2315		2985
2316	warn "... nuking $pkg";	2986	warn "... nuking $pkg";
2317	Symbol::delete_package $pkg;	2987	Symbol::delete_package $pkg;
2318	}	2988	}
2319		2989
2320	warn "unload all perl modules loaded from $LIBDIR";	2990	warn "unloading all perl modules loaded from $LIBDIR";
2321	while (my ($k, $v) = each %INC) {	2991	while (my ($k, $v) = each %INC) {
2322	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2992	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2323		2993
2324	warn "removing <$k>";	2994	warn "... unloading $k";
2325	delete $INC{$k};	2995	delete $INC{$k};
2326		2996
2327	$k =~ s/\.pm$//;	2997	$k =~ s/\.pm$//;
2328	$k =~ s/\//::/g;	2998	$k =~ s/\//::/g;
2329		2999
…		…
2332	}	3002	}
2333		3003
2334	Symbol::delete_package $k;	3004	Symbol::delete_package $k;
2335	}	3005	}
2336		3006
2337	warn "get rid of safe::, as good as possible";	3007	warn "getting rid of safe::, as good as possible";
2338	Symbol::delete_package "safe::$_"	3008	Symbol::delete_package "safe::$_"
2339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3009	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2340		3010
2341	warn "unload cf.pm \"a bit\"";	3011	warn "unloading cf.pm \"a bit\"";
2342	delete $INC{"cf.pm"};	3012	delete $INC{"cf.pm"};
		3013	delete $INC{"cf/pod.pm"};
2343		3014
2344	# don't, removes xs symbols, too,	3015	# don't, removes xs symbols, too,
2345	# and global variables created in xs	3016	# and global variables created in xs
2346	#Symbol::delete_package __PACKAGE__;	3017	#Symbol::delete_package __PACKAGE__;
2347		3018
		3019	warn "unload completed, starting to reload now";
		3020
2348	warn "reloading cf.pm";	3021	warn "reloading cf.pm";
2349	require cf;	3022	require cf;
2350	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3023	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2351		3024
2352	warn "load config and database again";	3025	warn "loading config and database again";
2353	cf::cfg_load;	3026	cf::cfg_load;
2354	cf::db_load;
2355		3027
2356	warn "load extensions";	3028	warn "loading extensions";
2357	cf::load_extensions;	3029	cf::load_extensions;
2358		3030
2359	warn "reattach attachments to objects/players";	3031	warn "reattaching attachments to objects/players";
2360	_global_reattach;	3032	_global_reattach; # objects, sockets
2361	warn "reattach attachments to maps";	3033	warn "reattaching attachments to maps";
2362	reattach $_ for values %MAP;	3034	reattach $_ for values %MAP;
2363	};	3035	warn "reattaching attachments to players";
		3036	reattach $_ for values %PLAYER;
2364		3037
2365	if ($@) {	3038	warn "leaving sync_job";
		3039
		3040	1
		3041	} or do {
2366	warn $@;	3042	warn $@;
2367	warn "error while reloading, exiting.";	3043	warn "error while reloading, exiting.";
2368	exit 1;	3044	exit 1;
2369	}	3045	};
2370		3046
2371	warn "reloaded";	3047	warn "reloaded";
2372	};	3048	};
2373		3049
		3050	our $RELOAD_WATCHER; # used only during reload
		3051
		3052	sub reload_perl() {
		3053	# doing reload synchronously and two reloads happen back-to-back,
		3054	# coro crashes during coro_state_free->destroy here.
		3055
		3056	$RELOAD_WATCHER ||= Event->timer (
		3057	reentrant => 0,
		3058	after => 0,
		3059	data => WF_AUTOCANCEL,
		3060	cb => sub {
		3061	do_reload_perl;
		3062	undef $RELOAD_WATCHER;
		3063	},
		3064	);
		3065	}
		3066
2374	register_command "reload" => sub {	3067	register_command "reload" => sub {
2375	my ($who, $arg) = @_;	3068	my ($who, $arg) = @_;
2376		3069
2377	if ($who->flag (FLAG_WIZ)) {	3070	if ($who->flag (FLAG_WIZ)) {
2378	$who->message ("start of reload.");
2379	reload;
2380	$who->message ("end of reload.");	3071	$who->message ("reloading server.");
		3072	async { reload_perl };
2381	}	3073	}
2382	};	3074	};
2383		3075
2384	unshift @INC, $LIBDIR;	3076	unshift @INC, $LIBDIR;
2385		3077
		3078	my $bug_warning = 0;
		3079
		3080	our @WAIT_FOR_TICK;
		3081	our @WAIT_FOR_TICK_BEGIN;
		3082
		3083	sub wait_for_tick {
		3084	return unless $TICK_WATCHER->is_active;
		3085	return if $Coro::current == $Coro::main;
		3086
		3087	my $signal = new Coro::Signal;
		3088	push @WAIT_FOR_TICK, $signal;
		3089	$signal->wait;
		3090	}
		3091
		3092	sub wait_for_tick_begin {
		3093	return unless $TICK_WATCHER->is_active;
		3094	return if $Coro::current == $Coro::main;
		3095
		3096	my $signal = new Coro::Signal;
		3097	push @WAIT_FOR_TICK_BEGIN, $signal;
		3098	$signal->wait;
		3099	}
		3100
		3101	my $min = 1e6;#d#
		3102	my $avg = 10;
2386	$TICK_WATCHER = Event->timer (	3103	$TICK_WATCHER = Event->timer (
2387	reentrant => 0,	3104	reentrant => 0,
		3105	parked => 1,
2388	prio => 0,	3106	prio => 0,
2389	at => $NEXT_TICK || $TICK,	3107	at => $NEXT_TICK || $TICK,
2390	data => WF_AUTOCANCEL,	3108	data => WF_AUTOCANCEL,
2391	cb => sub {	3109	cb => sub {
		3110	if ($Coro::current != $Coro::main) {
		3111	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3112	unless ++$bug_warning > 10;
		3113	return;
		3114	}
		3115
2392	$NOW = Event::time;	3116	$NOW = $tick_start = Event::time;
2393		3117
2394	cf::server_tick; # one server iteration	3118	cf::server_tick; # one server iteration
		3119
		3120	0 && sync_job {#d#
		3121	for(1..10) {
		3122	my $t = Event::time;
		3123	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3124	or die;
		3125
		3126	$map->width (50);
		3127	$map->height (50);
		3128	$map->alloc;
		3129	$map->_load_objects ("/tmp/x.map", 1);
		3130	my $t = Event::time - $t;
		3131
		3132	#next unless $t < 0.0013;#d#
		3133	if ($t < $min) {
		3134	$min = $t;
		3135	}
		3136	$avg = $avg * 0.99 + $t * 0.01;
		3137	}
		3138	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3139	exit 0;
		3140	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3141	};
		3142
2395	$RUNTIME += $TICK;	3143	$RUNTIME += $TICK;
2396	$NEXT_TICK += $TICK;	3144	$NEXT_TICK += $TICK;
2397		3145
2398	$WAIT_FOR_TICK->broadcast;	3146	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2399	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3147	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3148	Coro::async_pool {
		3149	write_runtime
		3150	or warn "ERROR: unable to write runtime file: $!";
		3151	};
		3152	}
		3153
		3154	# my $AFTER = Event::time;
		3155	# warn $AFTER - $NOW;#d#
		3156
		3157	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3158	$sig->send;
		3159	}
		3160	while (my $sig = shift @WAIT_FOR_TICK) {
		3161	$sig->send;
		3162	}
		3163
		3164	$NOW = Event::time;
2400		3165
2401	# if we are delayed by four ticks or more, skip them all	3166	# if we are delayed by four ticks or more, skip them all
2402	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3167	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2403		3168
2404	$TICK_WATCHER->at ($NEXT_TICK);	3169	$TICK_WATCHER->at ($NEXT_TICK);
2405	$TICK_WATCHER->start;	3170	$TICK_WATCHER->start;
		3171
		3172	$LOAD = ($NOW - $tick_start) / $TICK;
		3173	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3174
		3175	_post_tick;
		3176
		3177
2406	},	3178	},
2407	);	3179	);
2408		3180
		3181	{
		3182	BDB::max_poll_time $TICK * 0.1;
		3183	$BDB_POLL_WATCHER = Event->io (
		3184	reentrant => 0,
		3185	fd => BDB::poll_fileno,
		3186	poll => 'r',
		3187	prio => 0,
		3188	data => WF_AUTOCANCEL,
		3189	cb => \&BDB::poll_cb,
		3190	);
		3191	BDB::min_parallel 8;
		3192
		3193	BDB::set_sync_prepare {
		3194	my $status;
		3195	my $current = $Coro::current;
		3196	(
		3197	sub {
		3198	$status = $!;
		3199	$current->ready; undef $current;
		3200	},
		3201	sub {
		3202	Coro::schedule while defined $current;
		3203	$! = $status;
		3204	},
		3205	)
		3206	};
		3207
		3208	unless ($DB_ENV) {
		3209	$DB_ENV = BDB::db_env_create;
		3210
		3211	cf::sync_job {
		3212	eval {
		3213	BDB::db_env_open
		3214	$DB_ENV,
		3215	$BDBDIR,
		3216	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3217	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3218	0666;
		3219
		3220	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3221
		3222	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3223	$DB_ENV->set_lk_detect;
		3224	};
		3225
		3226	cf::cleanup "db_env_open(db): $@" if $@;
		3227	};
		3228	}
		3229	}
		3230
		3231	{
		3232	IO::AIO::min_parallel 8;
		3233
		3234	undef $Coro::AIO::WATCHER;
2409	IO::AIO::max_poll_time $TICK * 0.2;	3235	IO::AIO::max_poll_time $TICK * 0.1;
2410
2411	$AIO_POLL_WATCHER = Event->io (	3236	$AIO_POLL_WATCHER = Event->io (
2412	fd => IO::AIO::poll_fileno,	3237	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,	3238	data => WF_AUTOCANCEL,
2421	after => 0,	3239	fd => IO::AIO::poll_fileno,
2422	interval => 10,	3240	poll => 'r',
2423	cb => sub {	3241	prio => 6,
2424	(Coro::unblock_sub {	3242	cb => \&IO::AIO::poll_cb,
2425	write_runtime	3243	);
2426	or warn "ERROR: unable to write runtime file: $!";	3244	}
		3245
		3246	my $_log_backtrace;
		3247
		3248	sub _log_backtrace {
		3249	my ($msg, @addr) = @_;
		3250
		3251	$msg =~ s/\n//;
		3252
		3253	# limit the # of concurrent backtraces
		3254	if ($_log_backtrace < 2) {
		3255	++$_log_backtrace;
		3256	async {
		3257	my @bt = fork_call {
		3258	@addr = map { sprintf "%x", $_ } @addr;
		3259	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3260	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3261	or die "addr2line: $!";
		3262
		3263	my @funcs;
		3264	my @res = <$fh>;
		3265	chomp for @res;
		3266	while (@res) {
		3267	my ($func, $line) = splice @res, 0, 2, ();
		3268	push @funcs, "[$func] $line";
		3269	}
		3270
		3271	@funcs
		3272	};
		3273
		3274	LOG llevInfo, "[ABT] $msg\n";
		3275	LOG llevInfo, "[ABT] $_\n" for @bt;
		3276	--$_log_backtrace;
2427	})->();	3277	};
		3278	} else {
		3279	LOG llevInfo, "[ABT] $msg\n";
		3280	LOG llevInfo, "[ABT] [suppressed]\n";
2428	},	3281	}
2429	);	3282	}
		3283
		3284	# load additional modules
		3285	use cf::pod;
2430		3286
2431	END { cf::emergency_save }	3287	END { cf::emergency_save }
2432		3288
2433	1	3289	1
2434		3290

Diff Legend

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