ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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