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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.283 by root, Sun Jun 24 04:09:29 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use BDB ();
20	use Data::Dumper;	26	use Data::Dumper;
21	use Digest::MD5;	27	use Digest::MD5;
22	use Fcntl;	28	use Fcntl;
		29	use YAML::Syck ();
23	use IO::AIO 2.32 ();	30	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
26		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		41
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
33		44
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		46
		47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
35		48
36	our %COMMAND = ();	49	our %COMMAND = ();
37	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
38		51
39	our @EXTS = (); # list of extension package names	52	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	53	our %EXTCMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
43		56
		57	our $RELOAD; # number of reloads so far
44	our @EVENT;	58	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		59
47	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	73	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	74	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	76	our $NEXT_TICK;
52	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
53		82
54	our %CFG;	83	our %CFG;
55		84
56	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	86	our $RUNTIME;
58		87
59	our %PLAYER; # all users	88	our %PLAYER; # all users
60	our %MAP; # all maps	89	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	90	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		91
67	# used to convert map paths into valid unix filenames by replacing / by ∕	92	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
		98
70	binmode STDOUT;	99	binmode STDOUT;
71	binmode STDERR;	100	binmode STDERR;
72		101
73	# read virtual server time, if available	102	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
78	}	107	}
79		108
80	mkdir cf::localdir;	109	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		111
86	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
87		113
88	sub cf::map::normalise;	114	sub cf::map::normalise;
89		115
…		…
100	=item $cf::RUNTIME	126	=item $cf::RUNTIME
101		127
102	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
103	every server tick.	129	every server tick.
104		130
105	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
106		134
107	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
108	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
109		139
110	=item $cf::NOW	140	=item $cf::NOW
111		141
112	The time of the last (current) server tick.	142	The time of the last (current) server tick.
113		143
114	=item $cf::TICK	144	=item $cf::TICK
115		145
116	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
117		157
118	=item %cf::CFG	158	=item %cf::CFG
119		159
120	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
121	from wherever your confdir points to.	161	from wherever your confdir points to.
122		162
123	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
124		164
125	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
126	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	166	returns directly I<after> the tick processing (and consequently, can only wake one process
127	processing has been done. Call C<< ->wait >> on them to maximise the	167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
128	window of cpu time available, or simply to synchronise to the server tick.
129		168
130	=back	169	=back
131		170
132	=cut	171	=cut
133		172
134	BEGIN {	173	BEGIN {
135	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
136	my $msg = join "", @_;	175	my $msg = join "", @_;
137	utf8::encode $msg;
138		176
139	$msg .= "\n"	177	$msg .= "\n"
140	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
141		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
142	LOG llevError, $msg;	183	LOG llevError, $msg;
143	};	184	};
144	}	185	}
145		186
146	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
151	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
152		194
153	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
154	# within the Safe compartment.	196	# within the Safe compartment.
155	for my $pkg (qw(	197	for my $pkg (qw(
156	cf::global cf::attachable	198	cf::global cf::attachable
…		…
164	}	206	}
165		207
166	$Event::DIED = sub {	208	$Event::DIED = sub {
167	warn "error in event callback: @_";	209	warn "error in event callback: @_";
168	};	210	};
		211
		212	#############################################################################
169		213
170	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
171		215
172	=over 4	216	=over 4
173		217
…		…
192	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	236	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
193	$d	237	$d
194	} || "[unable to dump $_[0]: '$@']";	238	} || "[unable to dump $_[0]: '$@']";
195	}	239	}
196		240
197	use JSON::Syck (); # TODO# replace by JSON::PC once working	241	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
198		242
199	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
200		244
201	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
202		246
203	=cut
204
205	sub from_json($) {
206	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207	JSON::Syck::Load $_[0]
208	}
209
210	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
211		248
212	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
213
214	=cut
215
216	sub to_json($) {
217	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
218	JSON::Syck::Dump $_[0]
219	}
220		250
221	=item cf::lock_wait $string	251	=item cf::lock_wait $string
222		252
223	Wait until the given lock is available. See cf::lock_acquire.	253	Wait until the given lock is available. See cf::lock_acquire.
224		254
…		…
230	returned.	260	returned.
231		261
232	Lock names should begin with a unique identifier (for example, cf::map::find	262	Lock names should begin with a unique identifier (for example, cf::map::find
233	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
234		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
235	=cut	269	=cut
236		270
237	our %LOCK;	271	our %LOCK;
238		272
239	sub lock_wait($) {	273	sub lock_wait($) {
…		…
258	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
259	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
260	}	294	}
261	}	295	}
262		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
263	sub freeze_mainloop {	303	sub freeze_mainloop {
264	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
265		305
266	my $guard = Coro::guard {	306	my $guard = Coro::guard {
267	$TICK_WATCHER->start;	307	$TICK_WATCHER->start;
268	$WRITE_RUNTIME_WATCHER->start;
269	};	308	};
270	$WRITE_RUNTIME_WATCHER->stop;
271	$TICK_WATCHER->stop;	309	$TICK_WATCHER->stop;
272	$guard	310	$guard
273	}	311	}
274		312
275	=item cf::async { BLOCK }	313	=item cf::async { BLOCK }
…		…
282		320
283	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
284		322
285	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
286		324
287	The design of crossfire+ requires that the main coro ($Coro::main) is	325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288	always able to handle events or runnable, as crossfire+ is only partly	326	is always able to handle events or runnable, as Crossfire TRT is only
289	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
290		329
291	If it must be done, put the blocking parts into C<sync_job>. This will run	330	If it must be done, put the blocking parts into C<sync_job>. This will run
292	the given BLOCK in another coroutine while waiting for the result. The	331	the given BLOCK in another coroutine while waiting for the result. The
293	server will be frozen during this time, so the block should either finish	332	server will be frozen during this time, so the block should either finish
294	fast or be very important.	333	fast or be very important.
…		…
297		336
298	sub sync_job(&) {	337	sub sync_job(&) {
299	my ($job) = @_;	338	my ($job) = @_;
300		339
301	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
302	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
304		345
305	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
306	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
317		358
318	while ($busy) {	359	while ($busy) {
319	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
320	}	361	}
321		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
322	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
323	} else {	371	} else {
324	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
325		373
326	$job->()	374	$job->()
…		…
345	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
346		394
347	$coro	395	$coro
348	}	396	}
349		397
350	sub write_runtime {	398	=item fork_call { }, $args
351	my $runtime = cf::localdir . "/runtime";
352		399
353	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	400	Executes the given code block with the given arguments in a seperate
354	or return;	401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
355		404
356	my $value = $cf::RUNTIME + 90 + 10;	405	=cut
357	# 10 is the runtime save interval, for a monotonic clock
358	# 60 allows for the watchdog to kill the server.
359		406
360	(aio_write $fh, 0, (length $value), $value, 0) <= 0	407	sub fork_call(&@) {
361	and return;	408	my ($cb, @args) = @_;
362		409
363	aio_fsync $fh	410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
364	and return;	411	# or die "socketpair: $!";
		412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
365		414
		415	if (my $pid = fork) {
366	close $fh	416	close $fh2;
367	or return;
368		417
369	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
370	and return;	419	$res = Coro::Storable::thaw $res;
371		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
372	1	439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
		556	}
		557
		558	=item cf::datalog type => key => value, ...
		559
		560	Log a datalog packet of the given type with the given key-value pairs.
		561
		562	=cut
		563
		564	sub datalog($@) {
		565	my ($type, %kv) = @_;
		566	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
373	}	567	}
374		568
375	=back	569	=back
376		570
377	=cut	571	=cut
…		…
384	attach callbacks/event handlers (a collection of which is called an "attachment")	578	attach callbacks/event handlers (a collection of which is called an "attachment")
385	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
386		580
387	In the following description, CLASS can be any of C<global>, C<object>	581	In the following description, CLASS can be any of C<global>, C<object>
388	C<player>, C<client> or C<map> (i.e. the attachable objects in	582	C<player>, C<client> or C<map> (i.e. the attachable objects in
389	crossfire+).	583	Crossfire TRT).
390		584
391	=over 4	585	=over 4
392		586
393	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
394		588
…		…
557	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
558		752
559	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
560	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
561	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
562	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563		757
564	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
565	my $pkg = shift @arg;	759	my $pkg = shift @arg;
566		760
567	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
596	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
597	}	791	}
598		792
599	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
600	} else {	794	} else {
601	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
602	}	796	}
603		797
604	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
605	}	799	}
606		800
…		…
608	if (ref $_[0]) {	802	if (ref $_[0]) {
609	_object_attach @_;	803	_object_attach @_;
610	} else {	804	} else {
611	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
612	}	806	}
		807	_recalc_want;
613	};	808	};
614		809
615	# all those should be optimised	810	# all those should be optimised
616	sub cf::attachable::detach {	811	sub cf::attachable::detach {
617	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
620	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
621	reattach ($obj);	816	reattach ($obj);
622	} else {	817	} else {
623	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
624	}	819	}
		820	_recalc_want;
625	};	821	};
626		822
627	sub cf::attachable::attached {	823	sub cf::attachable::attached {
628	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
629		825
…		…
752	$filename, length $$rdata, scalar @$objs;	948	$filename, length $$rdata, scalar @$objs;
753		949
754	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	950	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755	chmod SAVE_MODE, $fh;	951	chmod SAVE_MODE, $fh;
756	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	952	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757	aio_fsync $fh;	953	aio_fsync $fh if $cf::USE_FSYNC;
758	close $fh;	954	close $fh;
759		955
760	if (@$objs) {	956	if (@$objs) {
761	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	957	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
762	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
763	my $data = Storable::nfreeze { version => 1, objs => $objs };	959	my $data = Storable::nfreeze { version => 1, objs => $objs };
764	aio_write $fh, 0, (length $data), $data, 0;	960	aio_write $fh, 0, (length $data), $data, 0;
765	aio_fsync $fh;	961	aio_fsync $fh if $cf::USE_FSYNC;
766	close $fh;	962	close $fh;
767	aio_rename "$filename.pst~", "$filename.pst";	963	aio_rename "$filename.pst~", "$filename.pst";
768	}	964	}
769	} else {	965	} else {
770	aio_unlink "$filename.pst";	966	aio_unlink "$filename.pst";
…		…
776	}	972	}
777	} else {	973	} else {
778	aio_unlink $filename;	974	aio_unlink $filename;
779	aio_unlink "$filename.pst";	975	aio_unlink "$filename.pst";
780	}	976	}
781
782	#d##TODO# nuke non .map-files if exist
783	if ($filename =~ s/\.map$//) {
784	aio_unlink $filename;
785	aio_unlink "$filename.pst";
786	}
787	}	977	}
788	}	978	}
789		979
790	sub object_freezer_as_string {	980	sub object_freezer_as_string {
791	my ($rdata, $objs) = @_;	981	my ($rdata, $objs) = @_;
…		…
797		987
798	sub object_thawer_load {	988	sub object_thawer_load {
799	my ($filename) = @_;	989	my ($filename) = @_;
800		990
801	my ($data, $av);	991	my ($data, $av);
802
803	#d#TODO remove .map if file does not exist
804	aio_stat $filename and $filename =~ s/\.map$//;
805		992
806	(aio_load $filename, $data) >= 0	993	(aio_load $filename, $data) >= 0
807	or return;	994	or return;
808		995
809	unless (aio_stat "$filename.pst") {	996	unless (aio_stat "$filename.pst") {
…		…
811	or return;	998	or return;
812	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
813	}	1000	}
814		1001
815	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
816	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
817	return ($data, $av);	1004	return ($data, $av);
818	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
819		1012
820	#############################################################################	1013	#############################################################################
821	# command handling &c	1014	# command handling &c
822		1015
823	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
836	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
837	}	1030	}
838		1031
839	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
840		1033
841	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
842		1035
843	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
844	called.	1037	called.
845		1038
846	=cut	1039	=cut
…		…
881		1074
882	cf::override;	1075	cf::override;
883	},	1076	},
884	);	1077	);
885		1078
886	sub load_extension {
887	my ($path) = @_;
888
889	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
890	my $base = $1;
891	my $pkg = $1;
892	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "ext::$pkg";
894
895	warn "... loading '$path' into '$pkg'\n";
896
897	open my $fh, "<:utf8", $path
898	or die "$path: $!";
899
900	my $source =
901	"package $pkg; use strict; use utf8;\n"
902	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })
904	. "\n};\n1";
905
906	unless (eval $source) {
907	my $msg = $@ ? "$path: $@\n"
908	: "extension disabled.\n";
909	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910	warn $@;
911	warn "mandatory extension failed to load, exiting.\n";
912	exit 1;
913	}
914	die $@;
915	}
916
917	push @EXTS, $pkg;
918	}
919
920	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
921	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
922	next unless -r $ext;	1084	next unless -r $path;
923	eval {	1085
924	load_extension $ext;	1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
925	1	1143	}
926	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
927	}	1149	};
928	}	1150	}
929		1151
930	#############################################################################	1152	#############################################################################
931		1153
		1154	=back
		1155
932	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
933		1157
934	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
935		1159
936	=cut	1160	=cut
…		…
948	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
949		1173
950	=cut	1174	=cut
951		1175
952	sub playerdir($) {	1176	sub playerdir($) {
953	cf::localdir	1177	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1179	}
959		1180
960	sub path($) {	1181	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1183
963	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
964	}	1185	}
965		1186
966	sub find_active($) {	1187	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1202	my $login = $_[0];
982		1203
983	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
984		1205
985	$cf::PLAYER{$_[0]} || do {	1206	$cf::PLAYER{$_[0]} || do {
		1207	# rename old playerfiles to new ones
		1208	#TODO: remove when no longer required
		1209	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1210	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1211	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1212	aio_unlink +(playerdir $login) . "/$login.pl";
		1213
986	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
987	or return;	1215	or return;
988	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
989	}	1217	}
990	}	1218	}
…		…
1027		1255
1028	=cut	1256	=cut
1029		1257
1030	sub quit_character {	1258	sub quit_character {
1031	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1032		1262
1033	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1264	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1265
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1275	$pl->destroy;
		1276
		1277	my $prefix = qr<^~\Q$name\E/>;
		1278
		1279	# nuke player maps
		1280	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1281
1046	IO::AIO::aio_rmtree $temp;	1282	IO::AIO::aio_rmtree $temp;
		1283	}
		1284
		1285	=item $pl->kick
		1286
		1287	Kicks a player out of the game. This destroys the connection.
		1288
		1289	=cut
		1290
		1291	sub kick {
		1292	my ($pl, $kicker) = @_;
		1293
		1294	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1295	$pl->killer ("kicked");
		1296	$pl->ns->destroy;
1047	}	1297	}
1048		1298
1049	=item cf::player::list_logins	1299	=item cf::player::list_logins
1050		1300
1051	Returns am arrayref of all valid playernames in the system, can take a	1301	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1053		1303
1054	=cut	1304	=cut
1055		1305
1056	sub list_logins {	1306	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1308	or return [];
1059		1309
1060	my @logins;	1310	my @logins;
1061		1311
1062	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1079	=cut	1329	=cut
1080		1330
1081	sub maps($) {	1331	sub maps($) {
1082	my ($pl) = @_;	1332	my ($pl) = @_;
1083		1333
		1334	$pl = ref $pl ? $pl->ob->name : $pl;
		1335
1084	my $files = aio_readdir playerdir $pl	1336	my $files = aio_readdir playerdir $pl
1085	or return;	1337	or return;
1086		1338
1087	my @paths;	1339	my @paths;
1088		1340
1089	for (@$files) {	1341	for (@$files) {
1090	utf8::decode $_;	1342	utf8::decode $_;
1091	next if /\.(?:pl|pst)$/;	1343	next if /\.(?:pl|pst)$/;
1092	next unless /^$PATH_SEP/o;	1344	next unless /^$PATH_SEP/o;
1093		1345
1094	push @paths, cf::map::normalise "~" . $pl->ob->name . "/" . $_;	1346	push @paths, cf::map::normalise "~$pl/$_";
1095	}	1347	}
1096		1348
1097	\@paths	1349	\@paths
1098	}	1350	}
1099		1351
		1352	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1353
		1354	Expand crossfire pod fragments into protocol xml.
		1355
		1356	=cut
		1357
		1358	sub expand_cfpod {
		1359	((my $self), (local $_)) = @_;
		1360
		1361	# escape & and <
		1362	s/&/&amp;/g;
		1363	s/(?<![BIUGH])</&lt;/g;
		1364
		1365	# this is buggy, it needs to properly take care of nested <'s
		1366
		1367	1 while
		1368	# replace B<>, I<>, U<> etc.
		1369	s/B<([^\>]*)>/<b>$1<\/b>/
		1370	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1371	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1372	# replace G<male|female> tags
		1373	|| s{G<([^>|]*)\|([^>]*)>}{
		1374	$self->gender ? $2 : $1
		1375	}ge
		1376	# replace H<hint text>
		1377	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1378
		1379	# create single paragraphs (very hackish)
		1380	s/(?<=\S)\n(?=\w)/ /g;
		1381
		1382	$_
		1383	}
		1384
1100	=item $player->ext_reply ($msgid, $msgtype, %msg)	1385	=item $player->ext_reply ($msgid, %msg)
1101		1386
1102	Sends an ext reply to the player.	1387	Sends an ext reply to the player.
1103		1388
1104	=cut	1389	=cut
1105		1390
1106	sub ext_reply($$$%) {	1391	sub ext_reply($$%) {
1107	my ($self, $id, %msg) = @_;	1392	my ($self, $id, %msg) = @_;
1108		1393
1109	$msg{msgid} = $id;	1394	$msg{msgid} = $id;
1110		1395
1111	$self->send ("ext " . cf::to_json \%msg);	1396	$self->send ("ext " . cf::to_json \%msg);
1112	}	1397	}
1113		1398
1114	package cf;	1399	=item $player->ext_event ($type, %msg)
		1400
		1401	Sends an ext event to the client.
		1402
		1403	=cut
		1404
		1405	sub ext_event($$%) {
		1406	my ($self, $type, %msg) = @_;
		1407
		1408	$self->ns->ext_event ($type, %msg);
		1409	}
		1410
		1411	=head3 cf::region
		1412
		1413	=over 4
		1414
		1415	=cut
		1416
		1417	package cf::region;
		1418
		1419	=item cf::region::find_by_path $path
		1420
		1421	Tries to decuce the likely region for a map knowing only its path.
		1422
		1423	=cut
		1424
		1425	sub find_by_path($) {
		1426	my ($path) = @_;
		1427
		1428	my ($match, $specificity);
		1429
		1430	for my $region (list) {
		1431	if ($region->match && $path =~ $region->match) {
		1432	($match, $specificity) = ($region, $region->specificity)
		1433	if $region->specificity > $specificity;
		1434	}
		1435	}
		1436
		1437	$match
		1438	}
1115		1439
1116	=back	1440	=back
1117
1118		1441
1119	=head3 cf::map	1442	=head3 cf::map
1120		1443
1121	=over 4	1444	=over 4
1122		1445
…		…
1177	my ($self, $merge) = @_;	1500	my ($self, $merge) = @_;
1178		1501
1179	# we have to keep some variables in memory intact	1502	# we have to keep some variables in memory intact
1180	local $self->{path};	1503	local $self->{path};
1181	local $self->{load_path};	1504	local $self->{load_path};
1182	local $self->{deny_save};
1183	local $self->{deny_reset};
1184		1505
1185	$self->SUPER::thawer_merge ($merge);	1506	$self->SUPER::thawer_merge ($merge);
1186	}	1507	}
1187		1508
1188	sub normalise {	1509	sub normalise {
…		…
1260		1581
1261	# the original (read-only) location	1582	# the original (read-only) location
1262	sub load_path {	1583	sub load_path {
1263	my ($self) = @_;	1584	my ($self) = @_;
1264		1585
1265	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1586	"$MAPDIR/$self->{path}.map"
1266	}	1587	}
1267		1588
1268	# the temporary/swap location	1589	# the temporary/swap location
1269	sub save_path {	1590	sub save_path {
1270	my ($self) = @_;	1591	my ($self) = @_;
1271		1592
1272	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1593	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1273	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1594	"$TMPDIR/$path.map"
1274	}	1595	}
1275		1596
1276	# the unique path, undef == no special unique path	1597	# the unique path, undef == no special unique path
1277	sub uniq_path {	1598	sub uniq_path {
1278	my ($self) = @_;	1599	my ($self) = @_;
1279		1600
1280	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1601	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1281	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1602	"$UNIQUEDIR/$path"
1282	}	1603	}
1283		1604
1284	# and all this just because we cannot iterate over	1605	# and all this just because we cannot iterate over
1285	# all maps in C++...	1606	# all maps in C++...
1286	sub change_all_map_light {	1607	sub change_all_map_light {
…		…
1288		1609
1289	$_->change_map_light ($change)	1610	$_->change_map_light ($change)
1290	for grep $_->outdoor, values %cf::MAP;	1611	for grep $_->outdoor, values %cf::MAP;
1291	}	1612	}
1292		1613
		1614	sub decay_objects {
		1615	my ($self) = @_;
		1616
		1617	return if $self->{deny_reset};
		1618
		1619	$self->do_decay_objects;
		1620	}
		1621
1293	sub unlink_save {	1622	sub unlink_save {
1294	my ($self) = @_;	1623	my ($self) = @_;
1295		1624
1296	utf8::encode (my $save = $self->save_path);	1625	utf8::encode (my $save = $self->save_path);
1297	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1626	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1298	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1627	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1299
1300	#d#TODO remove .map and also nuke
1301	$save =~ s/\.map// or return;#d#
1302	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1303	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1304	}	1628	}
1305		1629
1306	sub load_header_from($) {	1630	sub load_header_from($) {
1307	my ($self, $path) = @_;	1631	my ($self, $path) = @_;
1308		1632
…		…
1358	$self->load_header_orig	1682	$self->load_header_orig
1359	or return;	1683	or return;
1360	$self->prepare_orig;	1684	$self->prepare_orig;
1361	}	1685	}
1362		1686
		1687	$self->{deny_reset} = 1
		1688	if $self->no_reset;
		1689
		1690	$self->default_region (cf::region::find_by_path $self->{path})
		1691	unless $self->default_region;
		1692
1363	1	1693	1
1364	}	1694	}
1365		1695
1366	sub find;	1696	sub find;
1367	sub find {	1697	sub find {
…		…
1379	$map->{last_save} = $cf::RUNTIME;	1709	$map->{last_save} = $cf::RUNTIME;
1380		1710
1381	$map->load_header	1711	$map->load_header
1382	or return;	1712	or return;
1383		1713
1384	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1714	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1385	# doing this can freeze the server in a sync job, obviously	1715	# doing this can freeze the server in a sync job, obviously
1386	#$cf::WAIT_FOR_TICK->wait;	1716	#$cf::WAIT_FOR_TICK->wait;
1387	$map->reset;	1717	$map->reset;
1388	undef $guard;	1718	undef $guard;
1389	return find $path;	1719	return find $path;
…		…
1400	my ($self) = @_;	1730	my ($self) = @_;
1401		1731
1402	local $self->{deny_reset} = 1; # loading can take a long time	1732	local $self->{deny_reset} = 1; # loading can take a long time
1403		1733
1404	my $path = $self->{path};	1734	my $path = $self->{path};
		1735
		1736	{
1405	my $guard = cf::lock_acquire "map_load:$path";	1737	my $guard = cf::lock_acquire "map_load:$path";
1406		1738
1407	return if $self->in_memory != cf::MAP_SWAPPED;	1739	return if $self->in_memory != cf::MAP_SWAPPED;
1408		1740
1409	$self->in_memory (cf::MAP_LOADING);	1741	$self->in_memory (cf::MAP_LOADING);
1410		1742
1411	$self->alloc;	1743	$self->alloc;
1412		1744
1413	$self->pre_load;	1745	$self->pre_load;
1414
1415	$self->_load_objects ($self->{load_path}, 1)
1416	or return;
1417
1418	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1419	if delete $self->{load_original};
1420
1421	if (my $uniq = $self->uniq_path) {
1422	utf8::encode $uniq;
1423	if (aio_open $uniq, O_RDONLY, 0) {
1424	$self->clear_unique_items;
1425	$self->_load_objects ($uniq, 0);
1426	}
1427	}
1428
1429	Coro::cede;
1430
1431	# now do the right thing for maps
1432	$self->link_multipart_objects;
1433
1434	unless ($self->{deny_activate}) {
1435	$self->decay_objects;
1436	$self->fix_auto_apply;
1437	$self->update_buttons;
1438	Coro::cede;	1746	Coro::cede;
1439	$self->set_darkness_map;	1747
		1748	$self->_load_objects ($self->{load_path}, 1)
		1749	or return;
		1750
		1751	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1752	if delete $self->{load_original};
		1753
		1754	if (my $uniq = $self->uniq_path) {
		1755	utf8::encode $uniq;
		1756	if (aio_open $uniq, O_RDONLY, 0) {
		1757	$self->clear_unique_items;
		1758	$self->_load_objects ($uniq, 0);
		1759	}
		1760	}
		1761
		1762	Coro::cede;
		1763	# now do the right thing for maps
		1764	$self->link_multipart_objects;
1440	$self->difficulty ($self->estimate_difficulty)	1765	$self->difficulty ($self->estimate_difficulty)
1441	unless $self->difficulty;	1766	unless $self->difficulty;
1442	Coro::cede;	1767	Coro::cede;
		1768
		1769	unless ($self->{deny_activate}) {
		1770	$self->decay_objects;
		1771	$self->fix_auto_apply;
		1772	$self->update_buttons;
		1773	Coro::cede;
		1774	$self->set_darkness_map;
		1775	Coro::cede;
1443	$self->activate;	1776	$self->activate;
		1777	}
		1778
		1779	$self->in_memory (cf::MAP_IN_MEMORY);
1444	}	1780	}
1445		1781
1446	$self->post_load;	1782	$self->post_load;
1447
1448	$self->in_memory (cf::MAP_IN_MEMORY);
1449	}	1783	}
1450		1784
1451	sub customise_for {	1785	sub customise_for {
1452	my ($self, $ob) = @_;	1786	my ($self, $ob) = @_;
1453		1787
1454	return find "~" . $ob->name . "/" . $self->{path}	1788	return find "~" . $ob->name . "/" . $self->{path}
1455	if $self->per_player;	1789	if $self->per_player;
		1790
		1791	# return find "?party/" . $ob->name . "/" . $self->{path}
		1792	# if $self->per_party;
1456		1793
1457	$self	1794	$self
1458	}	1795	}
1459		1796
1460	# find and load all maps in the 3x3 area around a map	1797	# find and load all maps in the 3x3 area around a map
…		…
1571		1908
1572	sub reset_at {	1909	sub reset_at {
1573	my ($self) = @_;	1910	my ($self) = @_;
1574		1911
1575	# TODO: safety, remove and allow resettable per-player maps	1912	# TODO: safety, remove and allow resettable per-player maps
1576	return 1e99 if $self->isa ("ext::map_per_player");#d#
1577	return 1e99 if $self->{deny_reset};	1913	return 1e99 if $self->{deny_reset};
1578		1914
1579	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1915	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1580	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1916	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1581		1917
…		…
1592	my ($self) = @_;	1928	my ($self) = @_;
1593		1929
1594	my $lock = cf::lock_acquire "map_data:$self->{path}";	1930	my $lock = cf::lock_acquire "map_data:$self->{path}";
1595		1931
1596	return if $self->players;	1932	return if $self->players;
1597	return if $self->isa ("ext::map_per_player");#d#
1598		1933
1599	warn "resetting map ", $self->path;#d#	1934	warn "resetting map ", $self->path;
		1935
		1936	$self->in_memory (cf::MAP_SWAPPED);
		1937
		1938	# need to save uniques path
		1939	unless ($self->{deny_save}) {
		1940	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1941
		1942	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1943	if $uniq;
		1944	}
1600		1945
1601	delete $cf::MAP{$self->path};	1946	delete $cf::MAP{$self->path};
1602		1947
1603	$self->in_memory (cf::MAP_SWAPPED);
1604	$self->clear;	1948	$self->clear;
1605		1949
1606	$_->clear_links_to ($self) for values %cf::MAP;	1950	$_->clear_links_to ($self) for values %cf::MAP;
1607		1951
1608	$self->unlink_save;	1952	$self->unlink_save;
…		…
1627	$cf::MAP{$self->path} = $self;	1971	$cf::MAP{$self->path} = $self;
1628		1972
1629	$self->reset; # polite request, might not happen	1973	$self->reset; # polite request, might not happen
1630	}	1974	}
1631		1975
		1976	=item $maps = cf::map::tmp_maps
		1977
		1978	Returns an arrayref with all map paths of currently instantiated and saved
		1979	maps. May block.
		1980
		1981	=cut
		1982
		1983	sub tmp_maps() {
		1984	[
		1985	map {
		1986	utf8::decode $_;
		1987	/\.map$/
		1988	? normalise $_
		1989	: ()
		1990	} @{ aio_readdir $TMPDIR or [] }
		1991	]
		1992	}
		1993
		1994	=item $maps = cf::map::random_maps
		1995
		1996	Returns an arrayref with all map paths of currently instantiated and saved
		1997	random maps. May block.
		1998
		1999	=cut
		2000
		2001	sub random_maps() {
		2002	[
		2003	map {
		2004	utf8::decode $_;
		2005	/\.map$/
		2006	? normalise "?random/$_"
		2007	: ()
		2008	} @{ aio_readdir $RANDOMDIR or [] }
		2009	]
		2010	}
		2011
1632	=item cf::map::unique_maps	2012	=item cf::map::unique_maps
1633		2013
1634	Returns an arrayref of paths of all shared maps that have	2014	Returns an arrayref of paths of all shared maps that have
1635	instantiated unique items. May block.	2015	instantiated unique items. May block.
1636		2016
1637	=cut	2017	=cut
1638		2018
1639	sub unique_maps() {	2019	sub unique_maps() {
1640	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2020	[
1641	or return;	2021	map {
1642
1643	my @paths;
1644
1645	for (@$files) {
1646	utf8::decode $_;	2022	utf8::decode $_;
1647	next if /\.pst$/;	2023	/\.map$/
1648	next unless /^$PATH_SEP/o;	2024	? normalise $_
1649		2025	: ()
1650	push @paths, cf::map::normalise $_;	2026	} @{ aio_readdir $UNIQUEDIR or [] }
1651	}	2027	]
1652
1653	\@paths
1654	}	2028	}
1655		2029
1656	package cf;	2030	package cf;
1657		2031
1658	=back	2032	=back
…		…
1704		2078
1705	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2079	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1706		2080
1707	if ($self->{record_replies}) {	2081	if ($self->{record_replies}) {
1708	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2082	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2083
1709	} else {	2084	} else {
		2085	my $pl = $self->contr;
		2086
		2087	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2088	my $diag = $pl->{npc_dialog};
		2089	$diag->{pl}->ext_reply (
		2090	$diag->{id},
		2091	msgtype => "reply",
		2092	msg => $diag->{pl}->expand_cfpod ($msg),
		2093	add_topics => []
		2094	);
		2095
		2096	} else {
1710	$msg = $npc->name . " says: $msg" if $npc;	2097	$msg = $npc->name . " says: $msg" if $npc;
1711	$self->message ($msg, $flags);	2098	$self->message ($msg, $flags);
		2099	}
1712	}	2100	}
1713	}	2101	}
1714		2102
1715	=item $player_object->may ("access")	2103	=item $player_object->may ("access")
1716		2104
…		…
1764	$self->deactivate_recursive;	2152	$self->deactivate_recursive;
1765		2153
1766	return if UNIVERSAL::isa $self->map, "ext::map_link";	2154	return if UNIVERSAL::isa $self->map, "ext::map_link";
1767		2155
1768	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2156	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1769	if $self->map;	2157	if $self->map && $self->map->{path} ne "{link}";
1770		2158
1771	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2159	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1772	}	2160	}
1773		2161
1774	sub cf::object::player::leave_link {	2162	sub cf::object::player::leave_link {
1775	my ($self, $map, $x, $y) = @_;	2163	my ($self, $map, $x, $y) = @_;
		2164
		2165	return unless $self->contr->active;
1776		2166
1777	my $link_pos = delete $self->{_link_pos};	2167	my $link_pos = delete $self->{_link_pos};
1778		2168
1779	unless ($map) {	2169	unless ($map) {
1780	# restore original map position	2170	# restore original map position
…		…
1798	$map->load;	2188	$map->load;
1799	$map->load_diag;	2189	$map->load_diag;
1800		2190
1801	return unless $self->contr->active;	2191	return unless $self->contr->active;
1802	$self->activate_recursive;	2192	$self->activate_recursive;
		2193
		2194	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1803	$self->enter_map ($map, $x, $y);	2195	$self->enter_map ($map, $x, $y);
1804	}	2196	}
1805		2197
1806	cf::player->attach (
1807	on_logout => sub {
1808	my ($pl) = @_;
1809
1810	# abort map switching before logout
1811	if ($pl->ob->{_link_pos}) {
1812	cf::sync_job {
1813	$pl->ob->leave_link
1814	};
1815	}
1816	},
1817	on_login => sub {
1818	my ($pl) = @_;
1819
1820	# try to abort aborted map switching on player login :)
1821	# should happen only on crashes
1822	if ($pl->ob->{_link_pos}) {
1823	$pl->ob->enter_link;
1824	(async {
1825	# we need this sleep as the login has a concurrent enter_exit running
1826	# and this sleep increases chances of the player not ending up in scorn
1827	$pl->ob->reply (undef,
1828	"There was an internal problem at your last logout, "
1829	. "the server will try to bring you to your intended destination in a second.",
1830	cf::NDI_RED);
1831	Coro::Timer::sleep 1;
1832	$pl->ob->leave_link;
1833	})->prio (2);
1834	}
1835	},
1836	);
1837
1838	=item $player_object->goto ($path, $x, $y)	2198	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1839		2199
		2200	Moves the player to the given map-path and coordinates by first freezing
		2201	her, loading and preparing them map, calling the provided $check callback
		2202	that has to return the map if sucecssful, and then unfreezes the player on
		2203	the new (success) or old (failed) map position.
		2204
1840	=cut	2205	=cut
		2206
		2207	our $GOTOGEN;
1841		2208
1842	sub cf::object::player::goto {	2209	sub cf::object::player::goto {
1843	my ($self, $path, $x, $y) = @_;	2210	my ($self, $path, $x, $y, $check) = @_;
		2211
		2212	# do generation counting so two concurrent goto's will be executed in-order
		2213	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1844		2214
1845	$self->enter_link;	2215	$self->enter_link;
1846		2216
1847	(async {	2217	(async {
1848	my $map = eval {	2218	my $map = eval {
1849	my $map = cf::map::find $path;	2219	my $map = cf::map::find $path;
		2220
		2221	if ($map) {
1850	$map = $map->customise_for ($self) if $map;	2222	$map = $map->customise_for ($self);
		2223	$map = $check->($map) if $check && $map;
		2224	} else {
		2225	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2226	}
		2227
1851	$map	2228	$map
		2229	};
		2230
		2231	if ($@) {
		2232	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2233	LOG llevError | logBacktrace, Carp::longmess $@;
1852	} or	2234	}
1853	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1854		2235
		2236	if ($gen == $self->{_goto_generation}) {
		2237	delete $self->{_goto_generation};
1855	$self->leave_link ($map, $x, $y);	2238	$self->leave_link ($map, $x, $y);
		2239	}
1856	})->prio (1);	2240	})->prio (1);
1857	}	2241	}
1858		2242
1859	=item $player_object->enter_exit ($exit_object)	2243	=item $player_object->enter_exit ($exit_object)
1860		2244
…		…
1899		2283
1900	$rmp->{random_seed} ||= $exit->random_seed;	2284	$rmp->{random_seed} ||= $exit->random_seed;
1901		2285
1902	my $data = cf::to_json $rmp;	2286	my $data = cf::to_json $rmp;
1903	my $md5 = Digest::MD5::md5_hex $data;	2287	my $md5 = Digest::MD5::md5_hex $data;
1904	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2288	my $meta = "$RANDOMDIR/$md5.meta";
1905		2289
1906	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2290	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1907	aio_write $fh, 0, (length $data), $data, 0;	2291	aio_write $fh, 0, (length $data), $data, 0;
1908	undef $fh;	2292	undef $fh;
1909	aio_rename "$meta~", $meta;	2293	aio_rename "$meta~", $meta;
…		…
1918		2302
1919	return unless $self->type == cf::PLAYER;	2303	return unless $self->type == cf::PLAYER;
1920		2304
1921	if ($exit->slaying eq "/!") {	2305	if ($exit->slaying eq "/!") {
1922	#TODO: this should de-fi-ni-te-ly not be a sync-job	2306	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2307	# the problem is that $exit might not survive long enough
		2308	# so it needs to be done right now, right here
1923	cf::sync_job { prepare_random_map $exit };	2309	cf::sync_job { prepare_random_map $exit };
1924	}	2310	}
1925		2311
1926	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2312	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1927	my $hp = $exit->stats->hp;	2313	my $hp = $exit->stats->hp;
…		…
1935	$self->goto ($slaying, $hp, $sp);	2321	$self->goto ($slaying, $hp, $sp);
1936		2322
1937	1;	2323	1;
1938	}) {	2324	}) {
1939	$self->message ("Something went wrong deep within the crossfire server. "	2325	$self->message ("Something went wrong deep within the crossfire server. "
1940	. "I'll try to bring you back to the map you were before. "	2326	. "I'll try to bring you back to the map you were before. "
1941	. "Please report this to the dungeon master!",	2327	. "Please report this to the dungeon master!",
1942	cf::NDI_UNIQUE | cf::NDI_RED);	2328	cf::NDI_UNIQUE | cf::NDI_RED);
1943		2329
1944	warn "ERROR in enter_exit: $@";	2330	warn "ERROR in enter_exit: $@";
1945	$self->leave_link;	2331	$self->leave_link;
1946	}	2332	}
1947	})->prio (1);	2333	})->prio (1);
…		…
1960		2346
1961	sub cf::client::send_drawinfo {	2347	sub cf::client::send_drawinfo {
1962	my ($self, $text, $flags) = @_;	2348	my ($self, $text, $flags) = @_;
1963		2349
1964	utf8::encode $text;	2350	utf8::encode $text;
1965	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2351	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1966	}	2352	}
1967		2353
		2354	=item $client->send_msg ($color, $type, $msg, [extra...])
		2355
		2356	Send a drawinfo or msg packet to the client, formatting the msg for the
		2357	client if neccessary. C<$type> should be a string identifying the type of
		2358	the message, with C<log> being the default. If C<$color> is negative, suppress
		2359	the message unless the client supports the msg packet.
		2360
		2361	=cut
		2362
		2363	sub cf::client::send_msg {
		2364	my ($self, $color, $type, $msg, @extra) = @_;
		2365
		2366	$msg = $self->pl->expand_cfpod ($msg);
		2367
		2368	if ($self->can_msg) {
		2369	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2370	} else {
		2371	# replace some tags by gcfclient-compatible ones
		2372	for ($msg) {
		2373	1 while
		2374	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2375	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2376	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2377	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2378	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${1}[\/color]/;
		2379	}
		2380
		2381	if ($color >= 0) {
		2382	if ($msg =~ /\[/) {
		2383	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2384	} else {
		2385	$self->send_packet ("drawinfo $color $msg")
		2386	}
		2387	}
		2388	}
		2389	}
		2390
		2391	=item $client->ext_event ($type, %msg)
		2392
		2393	Sends an exti event to the client.
		2394
		2395	=cut
		2396
		2397	sub cf::client::ext_event($$%) {
		2398	my ($self, $type, %msg) = @_;
		2399
		2400	$msg{msgtype} = "event_$type";
		2401	$self->send_packet ("ext " . cf::to_json \%msg);
		2402	}
1968		2403
1969	=item $success = $client->query ($flags, "text", \&cb)	2404	=item $success = $client->query ($flags, "text", \&cb)
1970		2405
1971	Queues a query to the client, calling the given callback with	2406	Queues a query to the client, calling the given callback with
1972	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2407	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
2001	# get handled first	2436	# get handled first
2002	my $queue = delete $ns->{query_queue}	2437	my $queue = delete $ns->{query_queue}
2003	or return; # be conservative, not sure how that can happen, but we saw a crash here	2438	or return; # be conservative, not sure how that can happen, but we saw a crash here
2004		2439
2005	(shift @$queue)->[1]->($msg);	2440	(shift @$queue)->[1]->($msg);
		2441	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2006		2442
2007	push @{ $ns->{query_queue} }, @$queue;	2443	push @{ $ns->{query_queue} }, @$queue;
2008		2444
2009	if (@{ $ns->{query_queue} } == @$queue) {	2445	if (@{ $ns->{query_queue} } == @$queue) {
2010	if (@$queue) {	2446	if (@$queue) {
…		…
2068		2504
2069	# here we export the classes and methods available to script code	2505	# here we export the classes and methods available to script code
2070		2506
2071	=pod	2507	=pod
2072		2508
2073	The following fucntions and emthods are available within a safe environment:	2509	The following functions and methods are available within a safe environment:
2074		2510
2075	cf::object contr pay_amount pay_player map	2511	cf::object contr pay_amount pay_player map
2076	cf::object::player player	2512	cf::object::player player
2077	cf::player peaceful	2513	cf::player peaceful
2078	cf::map trigger	2514	cf::map trigger
…		…
2159	=back	2595	=back
2160		2596
2161	=cut	2597	=cut
2162		2598
2163	#############################################################################	2599	#############################################################################
		2600	# the server's init and main functions
2164		2601
2165	=head2 EXTENSION DATABASE SUPPORT	2602	sub load_facedata($) {
		2603	my ($path) = @_;
2166		2604
2167	Crossfire maintains a very simple database for extension use. It can	2605	warn "loading facedata from $path\n";
2168	currently store anything that can be serialised using Storable, which
2169	excludes objects.
2170		2606
2171	The parameter C<$family> should best start with the name of the extension	2607	my $facedata;
2172	using it, it should be unique.	2608	0 < aio_load $path, $facedata
		2609	or die "$path: $!";
2173		2610
2174	=over 4	2611	$facedata = Coro::Storable::thaw $facedata;
2175		2612
2176	=item $hashref = cf::db_get $family	2613	$facedata->{version} == 2
		2614	or cf::cleanup "$path: version mismatch, cannot proceed.";
2177		2615
2178	Return a hashref for use by the extension C<$family>, which can be
2179	modified. After modifications, you have to call C<cf::db_dirty> or
2180	C<cf::db_sync>.
2181
2182	=item $value = cf::db_get $family => $key
2183
2184	Returns a single value from the database
2185
2186	=item cf::db_put $family => $hashref
2187
2188	Stores the given family hashref into the database. Updates are delayed, if
2189	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2190
2191	=item cf::db_put $family => $key => $value
2192
2193	Stores the given C<$value> in the family hash. Updates are delayed, if you
2194	want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196	=item cf::db_dirty
2197
2198	Marks the database as dirty, to be updated at a later time.
2199
2200	=item cf::db_sync
2201
2202	Immediately write the database to disk I<if it is dirty>.
2203
2204	=cut
2205
2206	our $DB;
2207
2208	{
2209	my $path = cf::localdir . "/database.pst";
2210
2211	sub db_load() {
2212	$DB = stat $path ? Storable::retrieve $path : { };
2213	}	2616	{
		2617	my $faces = $facedata->{faceinfo};
2214		2618
2215	my $pid;	2619	while (my ($face, $info) = each %$faces) {
2216		2620	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2217	sub db_save() {	2621	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2218	waitpid $pid, 0 if $pid;	2622	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2219	if (0 == ($pid = fork)) {	2623	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2220	$DB->{_meta}{version} = 1;	2624	Coro::cede;
2221	Storable::nstore $DB, "$path~";
2222	rename "$path~", $path;
2223	cf::_exit 0 if defined $pid;
2224	}
2225	}
2226
2227	my $dirty;
2228
2229	sub db_sync() {
2230	db_save if $dirty;
2231	undef $dirty;
2232	}
2233
2234	my $idle = Event->idle (
2235	reentrant => 0,
2236	min => 10,
2237	max => 20,
2238	repeat => 0,
2239	data => WF_AUTOCANCEL,
2240	cb => \&db_sync,
2241	);
2242
2243	sub db_dirty() {
2244	$dirty = 1;
2245	$idle->start;
2246	}
2247
2248	sub db_get($;$) {
2249	@_ >= 2
2250	? $DB->{$_[0]}{$_[1]}
2251	: ($DB->{$_[0]} ||= { })
2252	}
2253
2254	sub db_put($$;$) {
2255	if (@_ >= 3) {
2256	$DB->{$_[0]}{$_[1]} = $_[2];
2257	} else {
2258	$DB->{$_[0]} = $_[1];
2259	}
2260	db_dirty;
2261	}
2262
2263	cf::global->attach (
2264	prio => 10000,
2265	on_cleanup => sub {
2266	db_sync;
2267	},	2625	}
2268	);
2269	}
2270		2626
2271	#############################################################################	2627	while (my ($face, $info) = each %$faces) {
2272	# the server's main()	2628	next unless $info->{smooth};
		2629	my $idx = cf::face::find $face
		2630	or next;
		2631	if (my $smooth = cf::face::find $info->{smooth}) {
		2632	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2633	} else {
		2634	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2635	}
		2636	Coro::cede;
		2637	}
		2638	}
		2639
		2640	{
		2641	my $anims = $facedata->{animinfo};
		2642
		2643	while (my ($anim, $info) = each %$anims) {
		2644	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2645	Coro::cede;
		2646	}
		2647
		2648	cf::anim::invalidate_all; # d'oh
		2649	}
		2650
		2651	1
		2652	}
		2653
		2654	sub reload_regions {
		2655	load_resource_file "$MAPDIR/regions"
		2656	or die "unable to load regions file\n";
		2657	}
		2658
		2659	sub reload_facedata {
		2660	load_facedata "$DATADIR/facedata"
		2661	or die "unable to load facedata\n";
		2662	}
		2663
		2664	sub reload_archetypes {
		2665	load_resource_file "$DATADIR/archetypes"
		2666	or die "unable to load archetypes\n";
		2667	}
		2668
		2669	sub reload_treasures {
		2670	load_resource_file "$DATADIR/treasures"
		2671	or die "unable to load treasurelists\n";
		2672	}
		2673
		2674	sub reload_resources {
		2675	warn "reloading resource files...\n";
		2676
		2677	reload_regions;
		2678	reload_facedata;
		2679	#reload_archetypes;#d#
		2680	reload_archetypes;
		2681	reload_treasures;
		2682
		2683	warn "finished reloading resource files\n";
		2684	}
		2685
		2686	sub init {
		2687	reload_resources;
		2688	}
2273		2689
2274	sub cfg_load {	2690	sub cfg_load {
2275	open my $fh, "<:utf8", cf::confdir . "/config"	2691	open my $fh, "<:utf8", "$CONFDIR/config"
2276	or return;	2692	or return;
2277		2693
2278	local $/;	2694	local $/;
2279	*CFG = YAML::Syck::Load <$fh>;	2695	*CFG = YAML::Syck::Load <$fh>;
2280		2696
…		…
2300	Event::one_event;	2716	Event::one_event;
2301	})->prio (Coro::PRIO_MAX);	2717	})->prio (Coro::PRIO_MAX);
2302	};	2718	};
2303		2719
2304	cfg_load;	2720	cfg_load;
2305	db_load;	2721	db_init;
2306	load_extensions;	2722	load_extensions;
2307		2723
2308	$TICK_WATCHER->start;	2724	$TICK_WATCHER->start;
2309	Event::loop;	2725	Event::loop;
2310	}	2726	}
…		…
2325	},	2741	},
2326	);	2742	);
2327	}	2743	}
2328	}	2744	}
2329		2745
		2746	sub write_runtime {
		2747	my $runtime = "$LOCALDIR/runtime";
		2748
		2749	# first touch the runtime file to show we are still running:
		2750	# the fsync below can take a very very long time.
		2751
		2752	IO::AIO::aio_utime $runtime, undef, undef;
		2753
		2754	my $guard = cf::lock_acquire "write_runtime";
		2755
		2756	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2757	or return;
		2758
		2759	my $value = $cf::RUNTIME + 90 + 10;
		2760	# 10 is the runtime save interval, for a monotonic clock
		2761	# 60 allows for the watchdog to kill the server.
		2762
		2763	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2764	and return;
		2765
		2766	# always fsync - this file is important
		2767	aio_fsync $fh
		2768	and return;
		2769
		2770	# touch it again to show we are up-to-date
		2771	aio_utime $fh, undef, undef;
		2772
		2773	close $fh
		2774	or return;
		2775
		2776	aio_rename "$runtime~", $runtime
		2777	and return;
		2778
		2779	warn "runtime file written.\n";
		2780
		2781	1
		2782	}
		2783
2330	sub emergency_save() {	2784	sub emergency_save() {
2331	my $freeze_guard = cf::freeze_mainloop;	2785	my $freeze_guard = cf::freeze_mainloop;
2332		2786
2333	warn "enter emergency perl save\n";	2787	warn "enter emergency perl save\n";
2334		2788
…		…
2349	my $map = $cf::MAP{$path} or next;	2803	my $map = $cf::MAP{$path} or next;
2350	$map->valid or next;	2804	$map->valid or next;
2351	$map->save;	2805	$map->save;
2352	}	2806	}
2353	warn "end emergency map save\n";	2807	warn "end emergency map save\n";
		2808
		2809	warn "begin emergency database checkpoint\n";
		2810	BDB::db_env_txn_checkpoint $DB_ENV;
		2811	warn "end emergency database checkpoint\n";
2354	};	2812	};
2355		2813
2356	warn "leave emergency perl save\n";	2814	warn "leave emergency perl save\n";
2357	}	2815	}
2358		2816
		2817	sub post_cleanup {
		2818	my ($make_core) = @_;
		2819
		2820	warn Carp::longmess "post_cleanup backtrace"
		2821	if $make_core;
		2822	}
		2823
2359	sub reload() {	2824	sub do_reload_perl() {
2360	# can/must only be called in main	2825	# can/must only be called in main
2361	if ($Coro::current != $Coro::main) {	2826	if ($Coro::current != $Coro::main) {
2362	warn "can only reload from main coroutine";	2827	warn "can only reload from main coroutine";
2363	return;	2828	return;
2364	}	2829	}
2365		2830
2366	warn "reloading...";	2831	warn "reloading...";
2367		2832
2368	warn "cancelling server ticker";	2833	warn "entering sync_job";
2369	$TICK_WATCHER->cancel;
2370		2834
		2835	cf::sync_job {
		2836	cf::write_runtime; # external watchdog should not bark
2371	cf::emergency_save;	2837	cf::emergency_save;
		2838	cf::write_runtime; # external watchdog should not bark
2372		2839
2373	eval {	2840	warn "syncing database to disk";
		2841	BDB::db_env_txn_checkpoint $DB_ENV;
		2842
2374	# if anything goes wrong in here, we should simply crash as we already saved	2843	# if anything goes wrong in here, we should simply crash as we already saved
2375
2376	warn "syncing database to disk";
2377	cf::db_sync;
2378		2844
2379	warn "cancelling all WF_AUTOCANCEL watchers";	2845	warn "cancelling all WF_AUTOCANCEL watchers";
2380	for (Event::all_watchers) {	2846	for (Event::all_watchers) {
2381	$_->cancel if $_->data & WF_AUTOCANCEL;	2847	$_->cancel if $_->data & WF_AUTOCANCEL;
2382	}	2848	}
2383		2849
2384	warn "flushing outstanding aio requests";	2850	warn "flushing outstanding aio requests";
2385	for (;;) {	2851	for (;;) {
		2852	BDB::flush;
2386	IO::AIO::flush;	2853	IO::AIO::flush;
2387	Coro::cede;	2854	Coro::cede;
2388	last unless IO::AIO::nreqs;	2855	last unless IO::AIO::nreqs || BDB::nreqs;
2389	warn "iterate...";	2856	warn "iterate...";
2390	}	2857	}
		2858
		2859	++$RELOAD;
2391		2860
2392	warn "cancelling all extension coros";	2861	warn "cancelling all extension coros";
2393	$_->cancel for values %EXT_CORO;	2862	$_->cancel for values %EXT_CORO;
2394	%EXT_CORO = ();	2863	%EXT_CORO = ();
2395		2864
…		…
2435	Symbol::delete_package "safe::$_"	2904	Symbol::delete_package "safe::$_"
2436	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2905	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2437		2906
2438	warn "unloading cf.pm \"a bit\"";	2907	warn "unloading cf.pm \"a bit\"";
2439	delete $INC{"cf.pm"};	2908	delete $INC{"cf.pm"};
		2909	delete $INC{"cf/pod.pm"};
2440		2910
2441	# don't, removes xs symbols, too,	2911	# don't, removes xs symbols, too,
2442	# and global variables created in xs	2912	# and global variables created in xs
2443	#Symbol::delete_package __PACKAGE__;	2913	#Symbol::delete_package __PACKAGE__;
2444		2914
…		…
2448	require cf;	2918	require cf;
2449	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2919	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2450		2920
2451	warn "loading config and database again";	2921	warn "loading config and database again";
2452	cf::cfg_load;	2922	cf::cfg_load;
2453	cf::db_load;
2454		2923
2455	warn "loading extensions";	2924	warn "loading extensions";
2456	cf::load_extensions;	2925	cf::load_extensions;
2457		2926
2458	warn "reattaching attachments to objects/players";	2927	warn "reattaching attachments to objects/players";
2459	_global_reattach;	2928	_global_reattach; # objects, sockets
2460	warn "reattaching attachments to maps";	2929	warn "reattaching attachments to maps";
2461	reattach $_ for values %MAP;	2930	reattach $_ for values %MAP;
		2931	warn "reattaching attachments to players";
		2932	reattach $_ for values %PLAYER;
2462		2933
2463	warn "restarting server ticker";	2934	warn "leaving sync_job";
2464		2935
2465	$TICK_WATCHER->start;	2936	1
2466	};	2937	} or do {
2467
2468	if ($@) {
2469	warn $@;	2938	warn $@;
2470	warn "error while reloading, exiting.";	2939	warn "error while reloading, exiting.";
2471	exit 1;	2940	exit 1;
2472	}	2941	};
2473		2942
2474	warn "reloaded";	2943	warn "reloaded";
2475	};	2944	};
2476		2945
2477	our $RELOAD_WATCHER; # used only during reload	2946	our $RELOAD_WATCHER; # used only during reload
2478		2947
		2948	sub reload_perl() {
		2949	# doing reload synchronously and two reloads happen back-to-back,
		2950	# coro crashes during coro_state_free->destroy here.
		2951
		2952	$RELOAD_WATCHER ||= Event->timer (
		2953	reentrant => 0,
		2954	after => 0,
		2955	data => WF_AUTOCANCEL,
		2956	cb => sub {
		2957	do_reload_perl;
		2958	undef $RELOAD_WATCHER;
		2959	},
		2960	);
		2961	}
		2962
2479	register_command "reload" => sub {	2963	register_command "reload" => sub {
2480	my ($who, $arg) = @_;	2964	my ($who, $arg) = @_;
2481		2965
2482	if ($who->flag (FLAG_WIZ)) {	2966	if ($who->flag (FLAG_WIZ)) {
2483	$who->message ("reloading server.");	2967	$who->message ("reloading server.");
2484		2968	async { reload_perl };
2485	# doing reload synchronously and two reloads happen back-to-back,
2486	# coro crashes during coro_state_free->destroy here.
2487
2488	$RELOAD_WATCHER ||= Event->timer (
2489	reentrant => 0,
2490	after => 0,
2491	data => WF_AUTOCANCEL,
2492	cb => sub {
2493	reload;
2494	undef $RELOAD_WATCHER;
2495	},
2496	);
2497	}	2969	}
2498	};	2970	};
2499		2971
2500	unshift @INC, $LIBDIR;	2972	unshift @INC, $LIBDIR;
2501		2973
2502	my $bug_warning = 0;	2974	my $bug_warning = 0;
2503		2975
		2976	our @WAIT_FOR_TICK;
		2977	our @WAIT_FOR_TICK_BEGIN;
		2978
		2979	sub wait_for_tick {
		2980	return unless $TICK_WATCHER->is_active;
		2981	return if $Coro::current == $Coro::main;
		2982
		2983	my $signal = new Coro::Signal;
		2984	push @WAIT_FOR_TICK, $signal;
		2985	$signal->wait;
		2986	}
		2987
		2988	sub wait_for_tick_begin {
		2989	return unless $TICK_WATCHER->is_active;
		2990	return if $Coro::current == $Coro::main;
		2991
		2992	my $signal = new Coro::Signal;
		2993	push @WAIT_FOR_TICK_BEGIN, $signal;
		2994	$signal->wait;
		2995	}
		2996
		2997	my $min = 1e6;#d#
		2998	my $avg = 10;
2504	$TICK_WATCHER = Event->timer (	2999	$TICK_WATCHER = Event->timer (
2505	reentrant => 0,	3000	reentrant => 0,
2506	parked => 1,	3001	parked => 1,
2507	prio => 0,	3002	prio => 0,
2508	at => $NEXT_TICK || $TICK,	3003	at => $NEXT_TICK || $TICK,
…		…
2512	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3007	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2513	unless ++$bug_warning > 10;	3008	unless ++$bug_warning > 10;
2514	return;	3009	return;
2515	}	3010	}
2516		3011
2517	$NOW = Event::time;	3012	$NOW = $tick_start = Event::time;
2518		3013
2519	cf::server_tick; # one server iteration	3014	cf::server_tick; # one server iteration
		3015
		3016	0 && sync_job {#d#
		3017	for(1..10) {
		3018	my $t = Event::time;
		3019	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3020	or die;
		3021
		3022	$map->width (50);
		3023	$map->height (50);
		3024	$map->alloc;
		3025	$map->_load_objects ("/tmp/x.map", 1);
		3026	my $t = Event::time - $t;
		3027
		3028	#next unless $t < 0.0013;#d#
		3029	if ($t < $min) {
		3030	$min = $t;
		3031	}
		3032	$avg = $avg * 0.99 + $t * 0.01;
		3033	}
		3034	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3035	exit 0;
		3036	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3037	};
		3038
2520	$RUNTIME += $TICK;	3039	$RUNTIME += $TICK;
2521	$NEXT_TICK += $TICK;	3040	$NEXT_TICK += $TICK;
2522		3041
2523	$WAIT_FOR_TICK->broadcast;	3042	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2524	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3043	$NEXT_RUNTIME_WRITE = $NOW + 10;
2525		3044	Coro::async_pool {
2526	Event::sweep;	3045	write_runtime
2527	Coro::cede_notself;	3046	or warn "ERROR: unable to write runtime file: $!";
		3047	};
2528		3048	}
		3049
2529	# my $AFTER = Event::time;	3050	# my $AFTER = Event::time;
2530	# warn $AFTER - $NOW;#d#	3051	# warn $AFTER - $NOW;#d#
2531		3052
		3053	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3054	$sig->send;
		3055	}
		3056	while (my $sig = shift @WAIT_FOR_TICK) {
		3057	$sig->send;
		3058	}
		3059
		3060	$NOW = Event::time;
		3061
2532	# if we are delayed by four ticks or more, skip them all	3062	# if we are delayed by four ticks or more, skip them all
2533	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3063	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2534		3064
2535	$TICK_WATCHER->at ($NEXT_TICK);	3065	$TICK_WATCHER->at ($NEXT_TICK);
2536	$TICK_WATCHER->start;	3066	$TICK_WATCHER->start;
		3067
		3068	$LOAD = ($NOW - $tick_start) / $TICK;
		3069	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3070
		3071	_post_tick;
		3072
		3073
2537	},	3074	},
2538	);	3075	);
2539		3076
		3077	{
		3078	BDB::max_poll_time $TICK * 0.1;
		3079	$BDB_POLL_WATCHER = Event->io (
		3080	reentrant => 0,
		3081	fd => BDB::poll_fileno,
		3082	poll => 'r',
		3083	prio => 0,
		3084	data => WF_AUTOCANCEL,
		3085	cb => \&BDB::poll_cb,
		3086	);
		3087	BDB::min_parallel 8;
		3088
		3089	BDB::set_sync_prepare {
		3090	my $status;
		3091	my $current = $Coro::current;
		3092	(
		3093	sub {
		3094	$status = $!;
		3095	$current->ready; undef $current;
		3096	},
		3097	sub {
		3098	Coro::schedule while defined $current;
		3099	$! = $status;
		3100	},
		3101	)
		3102	};
		3103
		3104	unless ($DB_ENV) {
		3105	$DB_ENV = BDB::db_env_create;
		3106
		3107	cf::sync_job {
		3108	eval {
		3109	BDB::db_env_open
		3110	$DB_ENV,
		3111	$BDBDIR,
		3112	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3113	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3114	0666;
		3115
		3116	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3117
		3118	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3119	$DB_ENV->set_lk_detect;
		3120	};
		3121
		3122	cf::cleanup "db_env_open(db): $@" if $@;
		3123	};
		3124	}
		3125	}
		3126
		3127	{
		3128	IO::AIO::min_parallel 8;
		3129
		3130	undef $Coro::AIO::WATCHER;
2540	IO::AIO::max_poll_time $TICK * 0.1;	3131	IO::AIO::max_poll_time $TICK * 0.1;
2541
2542	undef $Coro::AIO::WATCHER;
2543	$AIO_POLL_WATCHER = Event->io (	3132	$AIO_POLL_WATCHER = Event->io (
2544	reentrant => 0,	3133	reentrant => 0,
		3134	data => WF_AUTOCANCEL,
2545	fd => IO::AIO::poll_fileno,	3135	fd => IO::AIO::poll_fileno,
2546	poll => 'r',	3136	poll => 'r',
2547	prio => 6,	3137	prio => 6,
2548	data => WF_AUTOCANCEL,
2549	cb => \&IO::AIO::poll_cb,	3138	cb => \&IO::AIO::poll_cb,
2550	);	3139	);
		3140	}
2551		3141
2552	$WRITE_RUNTIME_WATCHER = Event->timer (	3142	my $_log_backtrace;
2553	reentrant => 0,	3143
2554	data => WF_AUTOCANCEL,	3144	sub _log_backtrace {
2555	after => 1,	3145	my ($msg, @addr) = @_;
2556	interval => 10,	3146
2557	prio => 6, # keep it lowest so it acts like a watchdog	3147	$msg =~ s/\n//;
2558	cb => Coro::unblock_sub {	3148
2559	write_runtime	3149	# limit the # of concurrent backtraces
2560	or warn "ERROR: unable to write runtime file: $!";	3150	if ($_log_backtrace < 2) {
		3151	++$_log_backtrace;
		3152	async {
		3153	my @bt = fork_call {
		3154	@addr = map { sprintf "%x", $_ } @addr;
		3155	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3156	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3157	or die "addr2line: $!";
		3158
		3159	my @funcs;
		3160	my @res = <$fh>;
		3161	chomp for @res;
		3162	while (@res) {
		3163	my ($func, $line) = splice @res, 0, 2, ();
		3164	push @funcs, "[$func] $line";
		3165	}
		3166
		3167	@funcs
		3168	};
		3169
		3170	LOG llevInfo, "[ABT] $msg\n";
		3171	LOG llevInfo, "[ABT] $_\n" for @bt;
		3172	--$_log_backtrace;
		3173	};
		3174	} else {
		3175	LOG llevInfo, "[ABT] $msg\n";
		3176	LOG llevInfo, "[ABT] [suppressed]\n";
2561	},	3177	}
2562	);	3178	}
		3179
		3180	# load additional modules
		3181	use cf::pod;
2563		3182
2564	END { cf::emergency_save }	3183	END { cf::emergency_save }
2565		3184
2566	1	3185	1
2567		3186

Diff Legend

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