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.287 by root, Mon Jun 25 05:43:45 2007 UTC

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

Diff Legend

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