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.209 by root, Mon Feb 12 01:25:55 2007 UTC vs.
Revision 1.287 by root, Mon Jun 25 05:43:45 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.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
20	use BDB ();	25	use BDB ();
21	use Data::Dumper;	26	use Data::Dumper;
22	use Digest::MD5;	27	use Digest::MD5;
23	use Fcntl;	28	use Fcntl;
		29	use YAML::Syck ();
24	use IO::AIO 2.32 ();	30	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	31	use Time::HiRes;
27	use Compress::LZF;	32	use Compress::LZF;
28		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
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		39
31	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
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		41
35	# 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?
36	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
37		44
38	$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
39		46
		47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		48
40	our %COMMAND = ();	49	our %COMMAND = ();
41	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
42		51
43	our @EXTS = (); # list of extension package names	52	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	55	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	56	our %EXT_MAP = (); # pluggable maps
47		57
		58	our $RELOAD; # number of reloads so far
48	our @EVENT;	59	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		60
51	our $TICK = MAX_TIME * 1e-6;	61	our $CONFDIR = confdir;
		62	our $DATADIR = datadir;
		63	our $LIBDIR = "$DATADIR/ext";
		64	our $PODDIR = "$DATADIR/pod";
		65	our $MAPDIR = "$DATADIR/" . mapdir;
		66	our $LOCALDIR = localdir;
		67	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		68	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		69	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		70	our $RANDOMDIR = "$LOCALDIR/random";
		71	our $BDBDIR = "$LOCALDIR/db";
		72
		73	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52	our $TICK_WATCHER;	74	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	75	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	76	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	77	our $NEXT_TICK;
56	our $NOW;	78	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	79	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		80
59	our $BDB_POLL_WATCHER;	81	our $BDB_POLL_WATCHER;
…		…
65	our $RUNTIME;	87	our $RUNTIME;
66		88
67	our %PLAYER; # all users	89	our %PLAYER; # all users
68	our %MAP; # all maps	90	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	91	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		92
76	# used to convert map paths into valid unix filenames by replacing / by ∕	93	# used to convert map paths into valid unix filenames by replacing / by ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	94	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		95
		96	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		97	our $LOADAVG; # same thing, but with alpha-smoothing
		98	our $tick_start; # for load detecting purposes
		99
79	binmode STDOUT;	100	binmode STDOUT;
80	binmode STDERR;	101	binmode STDERR;
81		102
82	# read virtual server time, if available	103	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	104	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	105	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	106	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	107	$RUNTIME = <$fh> + 0.;
87	}	108	}
88		109
89	mkdir cf::localdir;	110	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	111	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		112
96	our $EMERGENCY_POSITION;	113	our $EMERGENCY_POSITION;
97		114
98	sub cf::map::normalise;	115	sub cf::map::normalise;
99		116
…		…
110	=item $cf::RUNTIME	127	=item $cf::RUNTIME
111		128
112	The time this server has run, starts at 0 and is increased by $cf::TICK on	129	The time this server has run, starts at 0 and is increased by $cf::TICK on
113	every server tick.	130	every server tick.
114		131
115	=item $cf::LIBDIR	132	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		133	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		134	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116		135
117	The perl library directory, where extensions and cf-specific modules can	136	Various directories - "/etc", read-only install directory, perl-library
118	be found. It will be added to C<@INC> automatically.	137	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		138	unique-items directory, player file directory, random maps directory and
		139	database environment.
119		140
120	=item $cf::NOW	141	=item $cf::NOW
121		142
122	The time of the last (current) server tick.	143	The time of the last (current) server tick.
123		144
124	=item $cf::TICK	145	=item $cf::TICK
125		146
126	The interval between server ticks, in seconds.	147	The interval between server ticks, in seconds.
		148
		149	=item $cf::LOADAVG
		150
		151	The current CPU load on the server (alpha-smoothed), as a value between 0
		152	(none) and 1 (overloaded), indicating how much time is spent on processing
		153	objects per tick. Healthy values are < 0.5.
		154
		155	=item $cf::LOAD
		156
		157	The raw value load value from the last tick.
127		158
128	=item %cf::CFG	159	=item %cf::CFG
129		160
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	161	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	162	from wherever your confdir points to.
132		163
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	164	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		165
135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	166	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	167	returns directly I<after> the tick processing (and consequently, can only wake one process
137	processing has been done. Call C<< ->wait >> on them to maximise the	168	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138	window of cpu time available, or simply to synchronise to the server tick.
139		169
140	=back	170	=back
141		171
142	=cut	172	=cut
143		173
144	BEGIN {	174	BEGIN {
145	*CORE::GLOBAL::warn = sub {	175	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	176	my $msg = join "", @_;
147	utf8::encode $msg;
148		177
149	$msg .= "\n"	178	$msg .= "\n"
150	unless $msg =~ /\n$/;	179	unless $msg =~ /\n$/;
151		180
		181	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		182
		183	utf8::encode $msg;
152	LOG llevError, $msg;	184	LOG llevError, $msg;
153	};	185	};
154	}	186	}
155		187
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	188	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	189	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	190	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	191	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	192	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		193	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	194	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162		195
163	# we bless all objects into (empty) derived classes to force a method lookup	196	# we bless all objects into (empty) derived classes to force a method lookup
164	# within the Safe compartment.	197	# within the Safe compartment.
165	for my $pkg (qw(	198	for my $pkg (qw(
166	cf::global cf::attachable	199	cf::global cf::attachable
…		…
174	}	207	}
175		208
176	$Event::DIED = sub {	209	$Event::DIED = sub {
177	warn "error in event callback: @_";	210	warn "error in event callback: @_";
178	};	211	};
		212
		213	#############################################################################
179		214
180	=head2 UTILITY FUNCTIONS	215	=head2 UTILITY FUNCTIONS
181		216
182	=over 4	217	=over 4
183		218
…		…
202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	237	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203	$d	238	$d
204	} || "[unable to dump $_[0]: '$@']";	239	} || "[unable to dump $_[0]: '$@']";
205	}	240	}
206		241
207	use JSON::Syck (); # TODO# replace by JSON::PC once working	242	use JSON::XS ();
208		243
209	=item $ref = cf::from_json $json	244	=item $ref = cf::from_json $json
210		245
211	Converts a JSON string into the corresponding perl data structure.	246	Converts a JSON string into the corresponding perl data structure.
212		247
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	248	=item $json = cf::to_json $ref
221		249
222	Converts a perl data structure into its JSON representation.	250	Converts a perl data structure into its JSON representation.
223		251
224	=cut	252	=cut
225		253
226	sub to_json($) {	254	our $json_coder = JSON::XS->new->convert_blessed->utf8;
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	255
228	JSON::Syck::Dump $_[0]	256	sub to_json ($) { $json_coder->encode ($_[0]) }
229	}	257	sub from_json ($) { $json_coder->decode ($_[0]) }
230		258
231	=item cf::lock_wait $string	259	=item cf::lock_wait $string
232		260
233	Wait until the given lock is available. See cf::lock_acquire.	261	Wait until the given lock is available. See cf::lock_acquire.
234		262
…		…
240	returned.	268	returned.
241		269
242	Lock names should begin with a unique identifier (for example, cf::map::find	270	Lock names should begin with a unique identifier (for example, cf::map::find
243	uses map_find and cf::map::load uses map_load).	271	uses map_find and cf::map::load uses map_load).
244		272
		273	=item $locked = cf::lock_active $string
		274
		275	Return true if the lock is currently active, i.e. somebody has locked it.
		276
245	=cut	277	=cut
246		278
247	our %LOCK;	279	our %LOCK;
248		280
249	sub lock_wait($) {	281	sub lock_wait($) {
…		…
268	# wake up all waiters, to be on the safe side	300	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	301	$_->ready for @{ delete $LOCK{$key} };
270	}	302	}
271	}	303	}
272		304
		305	sub lock_active($) {
		306	my ($key) = @_;
		307
		308	! ! $LOCK{$key}
		309	}
		310
273	sub freeze_mainloop {	311	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	312	return unless $TICK_WATCHER->is_active;
275		313
276	my $guard = Coro::guard {	314	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	315	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	316	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	317	$TICK_WATCHER->stop;
282	$guard	318	$guard
283	}	319	}
284		320
285	=item cf::async { BLOCK }	321	=item cf::async { BLOCK }
…		…
292		328
293	BEGIN { *async = \&Coro::async_pool }	329	BEGIN { *async = \&Coro::async_pool }
294		330
295	=item cf::sync_job { BLOCK }	331	=item cf::sync_job { BLOCK }
296		332
297	The design of crossfire+ requires that the main coro ($Coro::main) is	333	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298	always able to handle events or runnable, as crossfire+ is only partly	334	is always able to handle events or runnable, as Crossfire TRT is only
299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	335	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		336	acceptable.
300		337
301	If it must be done, put the blocking parts into C<sync_job>. This will run	338	If it must be done, put the blocking parts into C<sync_job>. This will run
302	the given BLOCK in another coroutine while waiting for the result. The	339	the given BLOCK in another coroutine while waiting for the result. The
303	server will be frozen during this time, so the block should either finish	340	server will be frozen during this time, so the block should either finish
304	fast or be very important.	341	fast or be very important.
…		…
307		344
308	sub sync_job(&) {	345	sub sync_job(&) {
309	my ($job) = @_;	346	my ($job) = @_;
310		347
311	if ($Coro::current == $Coro::main) {	348	if ($Coro::current == $Coro::main) {
		349	my $time = Event::time;
		350
312	# this is the main coro, too bad, we have to block	351	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	352	# till the operation succeeds, freezing the server :/
314		353
315	# TODO: use suspend/resume instead	354	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	355	# (but this is cancel-safe)
…		…
327		366
328	while ($busy) {	367	while ($busy) {
329	Coro::cede or Event::one_event;	368	Coro::cede or Event::one_event;
330	}	369	}
331		370
		371	$time = Event::time - $time;
		372
		373	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		374	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		375
		376	$tick_start += $time; # do not account sync jobs to server load
		377
332	wantarray ? @res : $res[0]	378	wantarray ? @res : $res[0]
333	} else {	379	} else {
334	# we are in another coroutine, how wonderful, everything just works	380	# we are in another coroutine, how wonderful, everything just works
335		381
336	$job->()	382	$job->()
…		…
355	$EXT_CORO{$coro+0} = $coro;	401	$EXT_CORO{$coro+0} = $coro;
356		402
357	$coro	403	$coro
358	}	404	}
359		405
360	sub write_runtime {	406	=item fork_call { }, $args
361	my $runtime = cf::localdir . "/runtime";
362		407
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	408	Executes the given code block with the given arguments in a seperate
364	or return;	409	process, returning the results. Everything must be serialisable with
		410	Coro::Storable. May, of course, block. Note that the executed sub may
		411	never block itself or use any form of Event handling.
365		412
366	my $value = $cf::RUNTIME + 90 + 10;	413	=cut
367	# 10 is the runtime save interval, for a monotonic clock
368	# 60 allows for the watchdog to kill the server.
369		414
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	415	sub fork_call(&@) {
371	and return;	416	my ($cb, @args) = @_;
372		417
373	# always fsync - this file is important	418	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
374	aio_fsync $fh	419	# or die "socketpair: $!";
375	and return;	420	pipe my $fh1, my $fh2
		421	or die "pipe: $!";
376		422
		423	if (my $pid = fork) {
377	close $fh	424	close $fh2;
378	or return;
379		425
380	aio_rename "$runtime~", $runtime	426	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
381	and return;	427	$res = Coro::Storable::thaw $res;
382		428
		429	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		430
		431	die $$res unless "ARRAY" eq ref $res;
		432
		433	return wantarray ? @$res : $res->[-1];
		434	} else {
		435	reset_signals;
		436	local $SIG{__WARN__};
		437	local $SIG{__DIE__};
		438	eval {
		439	close $fh1;
		440
		441	my @res = eval { $cb->(@args) };
		442	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		443	};
		444
		445	warn $@ if $@;
		446	_exit 0;
383	1	447	}
		448	}
		449
		450	=item $value = cf::db_get $family => $key
		451
		452	Returns a single value from the environment database.
		453
		454	=item cf::db_put $family => $key => $value
		455
		456	Stores the given C<$value> in the family. It can currently store binary
		457	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		458
		459	=cut
		460
		461	our $DB;
		462
		463	sub db_init {
		464	unless ($DB) {
		465	$DB = BDB::db_create $DB_ENV;
		466
		467	cf::sync_job {
		468	eval {
		469	$DB->set_flags (BDB::CHKSUM);
		470
		471	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		472	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		473	cf::cleanup "db_open(db): $!" if $!;
		474	};
		475	cf::cleanup "db_open(db): $@" if $@;
		476	};
		477	}
		478	}
		479
		480	sub db_get($$) {
		481	my $key = "$_[0]/$_[1]";
		482
		483	cf::sync_job {
		484	BDB::db_get $DB, undef, $key, my $data;
		485
		486	$! ? ()
		487	: $data
		488	}
		489	}
		490
		491	sub db_put($$$) {
		492	BDB::dbreq_pri 4;
		493	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		494	}
		495
		496	=item cf::cache $id => [$paths...], $processversion => $process
		497
		498	Generic caching function that returns the value of the resource $id,
		499	caching and regenerating as required.
		500
		501	This function can block.
		502
		503	=cut
		504
		505	sub cache {
		506	my ($id, $src, $processversion, $process) = @_;
		507
		508	my $meta =
		509	join "\x00",
		510	$processversion,
		511	map {
		512	aio_stat $_
		513	and Carp::croak "$_: $!";
		514
		515	($_, (stat _)[7,9])
		516	} @$src;
		517
		518	my $dbmeta = db_get cache => "$id/meta";
		519	if ($dbmeta ne $meta) {
		520	# changed, we may need to process
		521
		522	my @data;
		523	my $md5;
		524
		525	for (0 .. $#$src) {
		526	0 <= aio_load $src->[$_], $data[$_]
		527	or Carp::croak "$src->[$_]: $!";
		528	}
		529
		530	# if processing is expensive, check
		531	# checksum first
		532	if (1) {
		533	$md5 =
		534	join "\x00",
		535	$processversion,
		536	map {
		537	Coro::cede;
		538	($src->[$_], Digest::MD5::md5_hex $data[$_])
		539	} 0.. $#$src;
		540
		541
		542	my $dbmd5 = db_get cache => "$id/md5";
		543	if ($dbmd5 eq $md5) {
		544	db_put cache => "$id/meta", $meta;
		545
		546	return db_get cache => "$id/data";
		547	}
		548	}
		549
		550	my $t1 = Time::HiRes::time;
		551	my $data = $process->(\@data);
		552	my $t2 = Time::HiRes::time;
		553
		554	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		555
		556	db_put cache => "$id/data", $data;
		557	db_put cache => "$id/md5" , $md5;
		558	db_put cache => "$id/meta", $meta;
		559
		560	return $data;
		561	}
		562
		563	db_get cache => "$id/data"
		564	}
		565
		566	=item cf::datalog type => key => value, ...
		567
		568	Log a datalog packet of the given type with the given key-value pairs.
		569
		570	=cut
		571
		572	sub datalog($@) {
		573	my ($type, %kv) = @_;
		574	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384	}	575	}
385		576
386	=back	577	=back
387		578
388	=cut	579	=cut
…		…
395	attach callbacks/event handlers (a collection of which is called an "attachment")	586	attach callbacks/event handlers (a collection of which is called an "attachment")
396	to it. All such attachable objects support the following methods.	587	to it. All such attachable objects support the following methods.
397		588
398	In the following description, CLASS can be any of C<global>, C<object>	589	In the following description, CLASS can be any of C<global>, C<object>
399	C<player>, C<client> or C<map> (i.e. the attachable objects in	590	C<player>, C<client> or C<map> (i.e. the attachable objects in
400	crossfire+).	591	Crossfire TRT).
401		592
402	=over 4	593	=over 4
403		594
404	=item $attachable->attach ($attachment, key => $value...)	595	=item $attachable->attach ($attachment, key => $value...)
405		596
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	759	$registry = $CB_TYPE[$object_type] ||= [];
569		760
570	} elsif ($type eq "subtype") {	761	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	762	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	763	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	764	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		765
575	} elsif ($type eq "package") {	766	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	767	my $pkg = shift @arg;
577		768
578	while (my ($name, $id) = each %cb_id) {	769	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	798	_attach $registry, $klass, @attach;
608	}	799	}
609		800
610	$obj->{$name} = \%arg;	801	$obj->{$name} = \%arg;
611	} else {	802	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	803	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	804	}
614		805
615	$obj->{_attachment}{$name} = undef;	806	$obj->{_attachment}{$name} = undef;
616	}	807	}
617		808
…		…
619	if (ref $_[0]) {	810	if (ref $_[0]) {
620	_object_attach @_;	811	_object_attach @_;
621	} else {	812	} else {
622	_attach shift->_attach_registry, @_;	813	_attach shift->_attach_registry, @_;
623	}	814	}
		815	_recalc_want;
624	};	816	};
625		817
626	# all those should be optimised	818	# all those should be optimised
627	sub cf::attachable::detach {	819	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	820	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	823	delete $obj->{_attachment}{$name};
632	reattach ($obj);	824	reattach ($obj);
633	} else {	825	} else {
634	Carp::croak "cannot, currently, detach class attachments";	826	Carp::croak "cannot, currently, detach class attachments";
635	}	827	}
		828	_recalc_want;
636	};	829	};
637		830
638	sub cf::attachable::attached {	831	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	832	my ($obj, $name) = @_;
640		833
…		…
787	}	980	}
788	} else {	981	} else {
789	aio_unlink $filename;	982	aio_unlink $filename;
790	aio_unlink "$filename.pst";	983	aio_unlink "$filename.pst";
791	}	984	}
792
793	#d##TODO# nuke non .map-files if exist
794	if ($filename =~ s/\.map$//) {
795	aio_unlink $filename;
796	aio_unlink "$filename.pst";
797	}
798	}	985	}
799	}	986	}
800		987
801	sub object_freezer_as_string {	988	sub object_freezer_as_string {
802	my ($rdata, $objs) = @_;	989	my ($rdata, $objs) = @_;
…		…
808		995
809	sub object_thawer_load {	996	sub object_thawer_load {
810	my ($filename) = @_;	997	my ($filename) = @_;
811		998
812	my ($data, $av);	999	my ($data, $av);
813
814	#d#TODO remove .map if file does not exist
815	aio_stat $filename and $filename =~ s/\.map$//;
816		1000
817	(aio_load $filename, $data) >= 0	1001	(aio_load $filename, $data) >= 0
818	or return;	1002	or return;
819		1003
820	unless (aio_stat "$filename.pst") {	1004	unless (aio_stat "$filename.pst") {
…		…
822	or return;	1006	or return;
823	$av = eval { (Storable::thaw $av)->{objs} };	1007	$av = eval { (Storable::thaw $av)->{objs} };
824	}	1008	}
825		1009
826	warn sprintf "loading %s (%d)\n",	1010	warn sprintf "loading %s (%d)\n",
827	$filename, length $data, scalar @{$av || []};#d#	1011	$filename, length $data, scalar @{$av || []};
828	return ($data, $av);	1012	return ($data, $av);
829	}	1013	}
		1014
		1015	=head2 COMMAND CALLBACKS
		1016
		1017	=over 4
		1018
		1019	=cut
830		1020
831	#############################################################################	1021	#############################################################################
832	# command handling &c	1022	# command handling &c
833		1023
834	=item cf::register_command $name => \&callback($ob,$args);	1024	=item cf::register_command $name => \&callback($ob,$args);
…		…
847	push @{ $COMMAND{$name} }, [$caller, $cb];	1037	push @{ $COMMAND{$name} }, [$caller, $cb];
848	}	1038	}
849		1039
850	=item cf::register_extcmd $name => \&callback($pl,$packet);	1040	=item cf::register_extcmd $name => \&callback($pl,$packet);
851		1041
852	Register a callbackf ro execution when the client sends an extcmd packet.	1042	Register a callback for execution when the client sends an (synchronous)
		1043	extcmd packet. Ext commands will be processed in the order they are
		1044	received by the server, like other user commands. The first argument is
		1045	the logged-in player. Ext commands can only be processed after a player
		1046	has logged in successfully.
853		1047
854	If the callback returns something, it is sent back as if reply was being	1048	If the callback returns something, it is sent back as if reply was being
855	called.	1049	called.
856		1050
		1051	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1052
		1053	Register a callback for execution when the client sends an (asynchronous)
		1054	exticmd packet. Exti commands are processed by the server as soon as they
		1055	are received, i.e. out of order w.r.t. other commands. The first argument
		1056	is a client socket. Exti commands can be received anytime, even before
		1057	log-in.
		1058
		1059	If the callback returns something, it is sent back as if reply was being
		1060	called.
		1061
857	=cut	1062	=cut
858		1063
859	sub register_extcmd {	1064	sub register_extcmd {
860	my ($name, $cb) = @_;	1065	my ($name, $cb) = @_;
861		1066
862	$EXTCMD{$name} = $cb;	1067	$EXTCMD{$name} = $cb;
		1068	}
		1069
		1070	sub register_exticmd {
		1071	my ($name, $cb) = @_;
		1072
		1073	$EXTICMD{$name} = $cb;
863	}	1074	}
864		1075
865	cf::player->attach (	1076	cf::player->attach (
866	on_command => sub {	1077	on_command => sub {
867	my ($pl, $name, $params) = @_;	1078	my ($pl, $name, $params) = @_;
…		…
892		1103
893	cf::override;	1104	cf::override;
894	},	1105	},
895	);	1106	);
896		1107
897	sub load_extension {
898	my ($path) = @_;
899
900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
901	my $base = $1;
902	my $pkg = $1;
903	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "ext::$pkg";
905
906	warn "... loading '$path' into '$pkg'\n";
907
908	open my $fh, "<:utf8", $path
909	or die "$path: $!";
910
911	my $source =
912	"package $pkg; use strict; use utf8;\n"
913	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })
915	. "\n};\n1";
916
917	unless (eval $source) {
918	my $msg = $@ ? "$path: $@\n"
919	: "extension disabled.\n";
920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921	warn $@;
922	warn "mandatory extension failed to load, exiting.\n";
923	exit 1;
924	}
925	die $@;
926	}
927
928	push @EXTS, $pkg;
929	}
930
931	sub load_extensions {	1108	sub load_extensions {
		1109	cf::sync_job {
		1110	my %todo;
		1111
932	for my $ext (<$LIBDIR/*.ext>) {	1112	for my $path (<$LIBDIR/*.ext>) {
933	next unless -r $ext;	1113	next unless -r $path;
934	eval {	1114
935	load_extension $ext;	1115	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1116	my $base = $1;
		1117	my $pkg = $1;
		1118	$pkg =~ s/[^[:word:]]/_/g;
		1119	$pkg = "ext::$pkg";
		1120
		1121	open my $fh, "<:utf8", $path
		1122	or die "$path: $!";
		1123
		1124	my $source = do { local $/; <$fh> };
		1125
		1126	my %ext = (
		1127	path => $path,
		1128	base => $base,
		1129	pkg => $pkg,
		1130	);
		1131
		1132	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1133	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1134
		1135	$ext{source} =
		1136	"package $pkg; use strict; use utf8;\n"
		1137	. "#line 1 \"$path\"\n{\n"
		1138	. $source
		1139	. "\n};\n1";
		1140
		1141	$todo{$base} = \%ext;
		1142	}
		1143
		1144	my %done;
		1145	while (%todo) {
		1146	my $progress;
		1147
		1148	while (my ($k, $v) = each %todo) {
		1149	for (split /,\s*/, $v->{meta}{depends}) {
		1150	goto skip
		1151	unless exists $done{$_};
		1152	}
		1153
		1154	warn "... loading '$k' into '$v->{pkg}'\n";
		1155
		1156	unless (eval $v->{source}) {
		1157	my $msg = $@ ? "$v->{path}: $@\n"
		1158	: "$v->{base}: extension inactive.\n";
		1159
		1160	if (exists $v->{meta}{mandatory}) {
		1161	warn $msg;
		1162	warn "mandatory extension failed to load, exiting.\n";
		1163	exit 1;
		1164	}
		1165
		1166	warn $msg;
		1167	}
		1168
		1169	$done{$k} = delete $todo{$k};
		1170	push @EXTS, $v->{pkg};
		1171	$progress = 1;
936	1	1172	}
937	} or warn "$ext not loaded: $@";	1173
		1174	skip:
		1175	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1176	unless $progress;
		1177	}
938	}	1178	};
939	}	1179	}
940		1180
941	#############################################################################	1181	#############################################################################
942		1182
		1183	=back
		1184
943	=head2 CORE EXTENSIONS	1185	=head2 CORE EXTENSIONS
944		1186
945	Functions and methods that extend core crossfire objects.	1187	Functions and methods that extend core crossfire objects.
946		1188
947	=cut	1189	=cut
…		…
959	Returns the given player object, loading it if necessary (might block).	1201	Returns the given player object, loading it if necessary (might block).
960		1202
961	=cut	1203	=cut
962		1204
963	sub playerdir($) {	1205	sub playerdir($) {
964	cf::localdir	1206	"$PLAYERDIR/"
965	. "/"
966	. cf::playerdir
967	. "/"
968	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1207	. (ref $_[0] ? $_[0]->ob->name : $_[0])
969	}	1208	}
970		1209
971	sub path($) {	1210	sub path($) {
972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1211	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973		1212
974	(playerdir $login) . "/$login.pl"	1213	(playerdir $login) . "/playerdata"
975	}	1214	}
976		1215
977	sub find_active($) {	1216	sub find_active($) {
978	$cf::PLAYER{$_[0]}	1217	$cf::PLAYER{$_[0]}
979	and $cf::PLAYER{$_[0]}->active	1218	and $cf::PLAYER{$_[0]}->active
…		…
992	my $login = $_[0];	1231	my $login = $_[0];
993		1232
994	my $guard = cf::lock_acquire "user_find:$login";	1233	my $guard = cf::lock_acquire "user_find:$login";
995		1234
996	$cf::PLAYER{$_[0]} || do {	1235	$cf::PLAYER{$_[0]} || do {
		1236	# rename old playerfiles to new ones
		1237	#TODO: remove when no longer required
		1238	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1239	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1240	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1241	aio_unlink +(playerdir $login) . "/$login.pl";
		1242
997	my $pl = load_pl path $login	1243	my $pl = load_pl path $login
998	or return;	1244	or return;
999	$cf::PLAYER{$login} = $pl	1245	$cf::PLAYER{$login} = $pl
1000	}	1246	}
1001	}	1247	}
…		…
1038		1284
1039	=cut	1285	=cut
1040		1286
1041	sub quit_character {	1287	sub quit_character {
1042	my ($pl) = @_;	1288	my ($pl) = @_;
		1289
		1290	my $name = $pl->ob->name;
1043		1291
1044	$pl->{deny_save} = 1;	1292	$pl->{deny_save} = 1;
1045	$pl->password ("*"); # this should lock out the player until we nuked the dir	1293	$pl->password ("*"); # this should lock out the player until we nuked the dir
1046		1294
1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1295	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1052	my $path = playerdir $pl;	1300	my $path = playerdir $pl;
1053	my $temp = "$path~$cf::RUNTIME~deleting~";	1301	my $temp = "$path~$cf::RUNTIME~deleting~";
1054	aio_rename $path, $temp;	1302	aio_rename $path, $temp;
1055	delete $cf::PLAYER{$pl->ob->name};	1303	delete $cf::PLAYER{$pl->ob->name};
1056	$pl->destroy;	1304	$pl->destroy;
		1305
		1306	my $prefix = qr<^~\Q$name\E/>;
		1307
		1308	# nuke player maps
		1309	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1310
1057	IO::AIO::aio_rmtree $temp;	1311	IO::AIO::aio_rmtree $temp;
		1312	}
		1313
		1314	=item $pl->kick
		1315
		1316	Kicks a player out of the game. This destroys the connection.
		1317
		1318	=cut
		1319
		1320	sub kick {
		1321	my ($pl, $kicker) = @_;
		1322
		1323	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1324	$pl->killer ("kicked");
		1325	$pl->ns->destroy;
1058	}	1326	}
1059		1327
1060	=item cf::player::list_logins	1328	=item cf::player::list_logins
1061		1329
1062	Returns am arrayref of all valid playernames in the system, can take a	1330	Returns am arrayref of all valid playernames in the system, can take a
1063	while and may block, so not sync_job-capable, ever.	1331	while and may block, so not sync_job-capable, ever.
1064		1332
1065	=cut	1333	=cut
1066		1334
1067	sub list_logins {	1335	sub list_logins {
1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1336	my $dirs = aio_readdir $PLAYERDIR
1069	or return [];	1337	or return [];
1070		1338
1071	my @logins;	1339	my @logins;
1072		1340
1073	for my $login (@$dirs) {	1341	for my $login (@$dirs) {
…		…
1108	}	1376	}
1109		1377
1110	\@paths	1378	\@paths
1111	}	1379	}
1112		1380
		1381	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1382
		1383	Expand crossfire pod fragments into protocol xml.
		1384
		1385	=cut
		1386
		1387	sub expand_cfpod {
		1388	((my $self), (local $_)) = @_;
		1389
		1390	# escape & and <
		1391	s/&/&amp;/g;
		1392	s/(?<![BIUGH])</&lt;/g;
		1393
		1394	# this is buggy, it needs to properly take care of nested <'s
		1395
		1396	1 while
		1397	# replace B<>, I<>, U<> etc.
		1398	s/B<([^\>]*)>/<b>$1<\/b>/
		1399	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1400	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1401	# replace G<male|female> tags
		1402	|| s{G<([^>|]*)\|([^>]*)>}{
		1403	$self->gender ? $2 : $1
		1404	}ge
		1405	# replace H<hint text>
		1406	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1407
		1408	# create single paragraphs (very hackish)
		1409	s/(?<=\S)\n(?=\w)/ /g;
		1410
		1411	$_
		1412	}
		1413
1113	=item $player->ext_reply ($msgid, $msgtype, %msg)	1414	=item $player->ext_reply ($msgid, %msg)
1114		1415
1115	Sends an ext reply to the player.	1416	Sends an ext reply to the player.
1116		1417
1117	=cut	1418	=cut
1118		1419
1119	sub ext_reply($$$%) {	1420	sub ext_reply($$%) {
1120	my ($self, $id, %msg) = @_;	1421	my ($self, $id, %msg) = @_;
1121		1422
1122	$msg{msgid} = $id;	1423	$msg{msgid} = $id;
1123
1124	$self->send ("ext " . cf::to_json \%msg);	1424	$self->send ("ext " . cf::to_json \%msg);
1125	}	1425	}
1126		1426
1127	package cf;	1427	=item $player->ext_event ($type, %msg)
		1428
		1429	Sends an ext event to the client.
		1430
		1431	=cut
		1432
		1433	sub ext_event($$%) {
		1434	my ($self, $type, %msg) = @_;
		1435
		1436	$self->ns->ext_event ($type, %msg);
		1437	}
		1438
		1439	=head3 cf::region
		1440
		1441	=over 4
		1442
		1443	=cut
		1444
		1445	package cf::region;
		1446
		1447	=item cf::region::find_by_path $path
		1448
		1449	Tries to decuce the likely region for a map knowing only its path.
		1450
		1451	=cut
		1452
		1453	sub find_by_path($) {
		1454	my ($path) = @_;
		1455
		1456	my ($match, $specificity);
		1457
		1458	for my $region (list) {
		1459	if ($region->match && $path =~ $region->match) {
		1460	($match, $specificity) = ($region, $region->specificity)
		1461	if $region->specificity > $specificity;
		1462	}
		1463	}
		1464
		1465	$match
		1466	}
1128		1467
1129	=back	1468	=back
1130
1131		1469
1132	=head3 cf::map	1470	=head3 cf::map
1133		1471
1134	=over 4	1472	=over 4
1135		1473
…		…
1190	my ($self, $merge) = @_;	1528	my ($self, $merge) = @_;
1191		1529
1192	# we have to keep some variables in memory intact	1530	# we have to keep some variables in memory intact
1193	local $self->{path};	1531	local $self->{path};
1194	local $self->{load_path};	1532	local $self->{load_path};
1195	local $self->{deny_save};
1196	local $self->{deny_reset};
1197		1533
1198	$self->SUPER::thawer_merge ($merge);	1534	$self->SUPER::thawer_merge ($merge);
1199	}	1535	}
1200		1536
1201	sub normalise {	1537	sub normalise {
…		…
1273		1609
1274	# the original (read-only) location	1610	# the original (read-only) location
1275	sub load_path {	1611	sub load_path {
1276	my ($self) = @_;	1612	my ($self) = @_;
1277		1613
1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1614	"$MAPDIR/$self->{path}.map"
1279	}	1615	}
1280		1616
1281	# the temporary/swap location	1617	# the temporary/swap location
1282	sub save_path {	1618	sub save_path {
1283	my ($self) = @_;	1619	my ($self) = @_;
1284		1620
1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1621	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1622	"$TMPDIR/$path.map"
1287	}	1623	}
1288		1624
1289	# the unique path, undef == no special unique path	1625	# the unique path, undef == no special unique path
1290	sub uniq_path {	1626	sub uniq_path {
1291	my ($self) = @_;	1627	my ($self) = @_;
1292		1628
1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1629	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1630	"$UNIQUEDIR/$path"
1295	}	1631	}
1296		1632
1297	# and all this just because we cannot iterate over	1633	# and all this just because we cannot iterate over
1298	# all maps in C++...	1634	# all maps in C++...
1299	sub change_all_map_light {	1635	sub change_all_map_light {
…		…
1301		1637
1302	$_->change_map_light ($change)	1638	$_->change_map_light ($change)
1303	for grep $_->outdoor, values %cf::MAP;	1639	for grep $_->outdoor, values %cf::MAP;
1304	}	1640	}
1305		1641
		1642	sub decay_objects {
		1643	my ($self) = @_;
		1644
		1645	return if $self->{deny_reset};
		1646
		1647	$self->do_decay_objects;
		1648	}
		1649
1306	sub unlink_save {	1650	sub unlink_save {
1307	my ($self) = @_;	1651	my ($self) = @_;
1308		1652
1309	utf8::encode (my $save = $self->save_path);	1653	utf8::encode (my $save = $self->save_path);
1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1654	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1655	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313	#d#TODO remove .map and also nuke
1314	$save =~ s/\.map// or return;#d#
1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317	}	1656	}
1318		1657
1319	sub load_header_from($) {	1658	sub load_header_from($) {
1320	my ($self, $path) = @_;	1659	my ($self, $path) = @_;
1321		1660
…		…
1371	$self->load_header_orig	1710	$self->load_header_orig
1372	or return;	1711	or return;
1373	$self->prepare_orig;	1712	$self->prepare_orig;
1374	}	1713	}
1375		1714
		1715	$self->{deny_reset} = 1
		1716	if $self->no_reset;
		1717
		1718	$self->default_region (cf::region::find_by_path $self->{path})
		1719	unless $self->default_region;
		1720
1376	1	1721	1
1377	}	1722	}
1378		1723
1379	sub find;	1724	sub find;
1380	sub find {	1725	sub find {
…		…
1392	$map->{last_save} = $cf::RUNTIME;	1737	$map->{last_save} = $cf::RUNTIME;
1393		1738
1394	$map->load_header	1739	$map->load_header
1395	or return;	1740	or return;
1396		1741
1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1742	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398	# doing this can freeze the server in a sync job, obviously	1743	# doing this can freeze the server in a sync job, obviously
1399	#$cf::WAIT_FOR_TICK->wait;	1744	#$cf::WAIT_FOR_TICK->wait;
1400	$map->reset;	1745	$map->reset;
1401	undef $guard;	1746	undef $guard;
1402	return find $path;	1747	return find $path;
…		…
1413	my ($self) = @_;	1758	my ($self) = @_;
1414		1759
1415	local $self->{deny_reset} = 1; # loading can take a long time	1760	local $self->{deny_reset} = 1; # loading can take a long time
1416		1761
1417	my $path = $self->{path};	1762	my $path = $self->{path};
		1763
		1764	{
1418	my $guard = cf::lock_acquire "map_load:$path";	1765	my $guard = cf::lock_acquire "map_load:$path";
1419		1766
1420	return if $self->in_memory != cf::MAP_SWAPPED;	1767	return if $self->in_memory != cf::MAP_SWAPPED;
1421		1768
1422	$self->in_memory (cf::MAP_LOADING);	1769	$self->in_memory (cf::MAP_LOADING);
1423		1770
1424	$self->alloc;	1771	$self->alloc;
1425		1772
1426	$self->pre_load;	1773	$self->pre_load;
1427
1428	$self->_load_objects ($self->{load_path}, 1)
1429	or return;
1430
1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432	if delete $self->{load_original};
1433
1434	if (my $uniq = $self->uniq_path) {
1435	utf8::encode $uniq;
1436	if (aio_open $uniq, O_RDONLY, 0) {
1437	$self->clear_unique_items;
1438	$self->_load_objects ($uniq, 0);
1439	}
1440	}
1441
1442	Coro::cede;
1443
1444	# now do the right thing for maps
1445	$self->link_multipart_objects;
1446
1447	unless ($self->{deny_activate}) {
1448	$self->decay_objects;
1449	$self->fix_auto_apply;
1450	$self->update_buttons;
1451	Coro::cede;	1774	Coro::cede;
1452	$self->set_darkness_map;	1775
		1776	$self->_load_objects ($self->{load_path}, 1)
		1777	or return;
		1778
		1779	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1780	if delete $self->{load_original};
		1781
		1782	if (my $uniq = $self->uniq_path) {
		1783	utf8::encode $uniq;
		1784	if (aio_open $uniq, O_RDONLY, 0) {
		1785	$self->clear_unique_items;
		1786	$self->_load_objects ($uniq, 0);
		1787	}
		1788	}
		1789
		1790	Coro::cede;
		1791	# now do the right thing for maps
		1792	$self->link_multipart_objects;
1453	$self->difficulty ($self->estimate_difficulty)	1793	$self->difficulty ($self->estimate_difficulty)
1454	unless $self->difficulty;	1794	unless $self->difficulty;
1455	Coro::cede;	1795	Coro::cede;
		1796
		1797	unless ($self->{deny_activate}) {
		1798	$self->decay_objects;
		1799	$self->fix_auto_apply;
		1800	$self->update_buttons;
		1801	Coro::cede;
		1802	$self->set_darkness_map;
		1803	Coro::cede;
1456	$self->activate;	1804	$self->activate;
		1805	}
		1806
		1807	$self->in_memory (cf::MAP_IN_MEMORY);
1457	}	1808	}
1458		1809
1459	$self->post_load;	1810	$self->post_load;
1460
1461	$self->in_memory (cf::MAP_IN_MEMORY);
1462	}	1811	}
1463		1812
1464	sub customise_for {	1813	sub customise_for {
1465	my ($self, $ob) = @_;	1814	my ($self, $ob) = @_;
1466		1815
1467	return find "~" . $ob->name . "/" . $self->{path}	1816	return find "~" . $ob->name . "/" . $self->{path}
1468	if $self->per_player;	1817	if $self->per_player;
		1818
		1819	# return find "?party/" . $ob->name . "/" . $self->{path}
		1820	# if $self->per_party;
1469		1821
1470	$self	1822	$self
1471	}	1823	}
1472		1824
1473	# find and load all maps in the 3x3 area around a map	1825	# find and load all maps in the 3x3 area around a map
…		…
1584		1936
1585	sub reset_at {	1937	sub reset_at {
1586	my ($self) = @_;	1938	my ($self) = @_;
1587		1939
1588	# TODO: safety, remove and allow resettable per-player maps	1940	# TODO: safety, remove and allow resettable per-player maps
1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
1590	return 1e99 if $self->{deny_reset};	1941	return 1e99 if $self->{deny_reset};
1591		1942
1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1943	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1944	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594		1945
…		…
1605	my ($self) = @_;	1956	my ($self) = @_;
1606		1957
1607	my $lock = cf::lock_acquire "map_data:$self->{path}";	1958	my $lock = cf::lock_acquire "map_data:$self->{path}";
1608		1959
1609	return if $self->players;	1960	return if $self->players;
1610	return if $self->isa ("ext::map_per_player");#d#
1611		1961
1612	warn "resetting map ", $self->path;#d#	1962	warn "resetting map ", $self->path;
		1963
		1964	$self->in_memory (cf::MAP_SWAPPED);
		1965
		1966	# need to save uniques path
		1967	unless ($self->{deny_save}) {
		1968	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1969
		1970	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1971	if $uniq;
		1972	}
1613		1973
1614	delete $cf::MAP{$self->path};	1974	delete $cf::MAP{$self->path};
1615		1975
1616	$self->in_memory (cf::MAP_SWAPPED);
1617	$self->clear;	1976	$self->clear;
1618		1977
1619	$_->clear_links_to ($self) for values %cf::MAP;	1978	$_->clear_links_to ($self) for values %cf::MAP;
1620		1979
1621	$self->unlink_save;	1980	$self->unlink_save;
…		…
1640	$cf::MAP{$self->path} = $self;	1999	$cf::MAP{$self->path} = $self;
1641		2000
1642	$self->reset; # polite request, might not happen	2001	$self->reset; # polite request, might not happen
1643	}	2002	}
1644		2003
		2004	=item $maps = cf::map::tmp_maps
		2005
		2006	Returns an arrayref with all map paths of currently instantiated and saved
		2007	maps. May block.
		2008
		2009	=cut
		2010
		2011	sub tmp_maps() {
		2012	[
		2013	map {
		2014	utf8::decode $_;
		2015	/\.map$/
		2016	? normalise $_
		2017	: ()
		2018	} @{ aio_readdir $TMPDIR or [] }
		2019	]
		2020	}
		2021
		2022	=item $maps = cf::map::random_maps
		2023
		2024	Returns an arrayref with all map paths of currently instantiated and saved
		2025	random maps. May block.
		2026
		2027	=cut
		2028
		2029	sub random_maps() {
		2030	[
		2031	map {
		2032	utf8::decode $_;
		2033	/\.map$/
		2034	? normalise "?random/$_"
		2035	: ()
		2036	} @{ aio_readdir $RANDOMDIR or [] }
		2037	]
		2038	}
		2039
1645	=item cf::map::unique_maps	2040	=item cf::map::unique_maps
1646		2041
1647	Returns an arrayref of paths of all shared maps that have	2042	Returns an arrayref of paths of all shared maps that have
1648	instantiated unique items. May block.	2043	instantiated unique items. May block.
1649		2044
1650	=cut	2045	=cut
1651		2046
1652	sub unique_maps() {	2047	sub unique_maps() {
1653	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2048	[
1654	or return;	2049	map {
1655
1656	my @paths;
1657
1658	for (@$files) {
1659	utf8::decode $_;	2050	utf8::decode $_;
1660	next if /\.pst$/;	2051	/\.map$/
1661	next unless /^$PATH_SEP/o;	2052	? normalise $_
1662		2053	: ()
1663	push @paths, cf::map::normalise $_;	2054	} @{ aio_readdir $UNIQUEDIR or [] }
1664	}	2055	]
1665
1666	\@paths
1667	}	2056	}
1668		2057
1669	package cf;	2058	package cf;
1670		2059
1671	=back	2060	=back
…		…
1717		2106
1718	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2107	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719		2108
1720	if ($self->{record_replies}) {	2109	if ($self->{record_replies}) {
1721	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2110	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2111
1722	} else {	2112	} else {
		2113	my $pl = $self->contr;
		2114
		2115	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2116	my $diag = $pl->{npc_dialog};
		2117	$diag->{pl}->ext_reply (
		2118	$diag->{id},
		2119	msgtype => "reply",
		2120	msg => $diag->{pl}->expand_cfpod ($msg),
		2121	add_topics => []
		2122	);
		2123
		2124	} else {
1723	$msg = $npc->name . " says: $msg" if $npc;	2125	$msg = $npc->name . " says: $msg" if $npc;
1724	$self->message ($msg, $flags);	2126	$self->message ($msg, $flags);
		2127	}
1725	}	2128	}
1726	}	2129	}
1727		2130
1728	=item $player_object->may ("access")	2131	=item $player_object->may ("access")
1729		2132
…		…
1777	$self->deactivate_recursive;	2180	$self->deactivate_recursive;
1778		2181
1779	return if UNIVERSAL::isa $self->map, "ext::map_link";	2182	return if UNIVERSAL::isa $self->map, "ext::map_link";
1780		2183
1781	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2184	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782	if $self->map;	2185	if $self->map && $self->map->{path} ne "{link}";
1783		2186
1784	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2187	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1785	}	2188	}
1786		2189
1787	sub cf::object::player::leave_link {	2190	sub cf::object::player::leave_link {
1788	my ($self, $map, $x, $y) = @_;	2191	my ($self, $map, $x, $y) = @_;
		2192
		2193	return unless $self->contr->active;
1789		2194
1790	my $link_pos = delete $self->{_link_pos};	2195	my $link_pos = delete $self->{_link_pos};
1791		2196
1792	unless ($map) {	2197	unless ($map) {
1793	# restore original map position	2198	# restore original map position
…		…
1811	$map->load;	2216	$map->load;
1812	$map->load_diag;	2217	$map->load_diag;
1813		2218
1814	return unless $self->contr->active;	2219	return unless $self->contr->active;
1815	$self->activate_recursive;	2220	$self->activate_recursive;
		2221
		2222	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816	$self->enter_map ($map, $x, $y);	2223	$self->enter_map ($map, $x, $y);
1817	}	2224	}
1818		2225
1819	cf::player->attach (
1820	on_logout => sub {
1821	my ($pl) = @_;
1822
1823	# abort map switching before logout
1824	if ($pl->ob->{_link_pos}) {
1825	cf::sync_job {
1826	$pl->ob->leave_link
1827	};
1828	}
1829	},
1830	on_login => sub {
1831	my ($pl) = @_;
1832
1833	# try to abort aborted map switching on player login :)
1834	# should happen only on crashes
1835	if ($pl->ob->{_link_pos}) {
1836	$pl->ob->enter_link;
1837	(async {
1838	# we need this sleep as the login has a concurrent enter_exit running
1839	# and this sleep increases chances of the player not ending up in scorn
1840	$pl->ob->reply (undef,
1841	"There was an internal problem at your last logout, "
1842	. "the server will try to bring you to your intended destination in a second.",
1843	cf::NDI_RED);
1844	Coro::Timer::sleep 1;
1845	$pl->ob->leave_link;
1846	})->prio (2);
1847	}
1848	},
1849	);
1850
1851	=item $player_object->goto ($path, $x, $y)	2226	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1852		2227
		2228	Moves the player to the given map-path and coordinates by first freezing
		2229	her, loading and preparing them map, calling the provided $check callback
		2230	that has to return the map if sucecssful, and then unfreezes the player on
		2231	the new (success) or old (failed) map position.
		2232
1853	=cut	2233	=cut
		2234
		2235	our $GOTOGEN;
1854		2236
1855	sub cf::object::player::goto {	2237	sub cf::object::player::goto {
1856	my ($self, $path, $x, $y) = @_;	2238	my ($self, $path, $x, $y, $check) = @_;
		2239
		2240	# do generation counting so two concurrent goto's will be executed in-order
		2241	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857		2242
1858	$self->enter_link;	2243	$self->enter_link;
1859		2244
1860	(async {	2245	(async {
1861	my $map = eval {	2246	my $map = eval {
1862	my $map = cf::map::find $path;	2247	my $map = cf::map::find $path;
		2248
		2249	if ($map) {
1863	$map = $map->customise_for ($self) if $map;	2250	$map = $map->customise_for ($self);
		2251	$map = $check->($map) if $check && $map;
		2252	} else {
		2253	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2254	}
		2255
1864	$map	2256	$map
		2257	};
		2258
		2259	if ($@) {
		2260	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2261	LOG llevError | logBacktrace, Carp::longmess $@;
1865	} or	2262	}
1866	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867		2263
		2264	if ($gen == $self->{_goto_generation}) {
		2265	delete $self->{_goto_generation};
1868	$self->leave_link ($map, $x, $y);	2266	$self->leave_link ($map, $x, $y);
		2267	}
1869	})->prio (1);	2268	})->prio (1);
1870	}	2269	}
1871		2270
1872	=item $player_object->enter_exit ($exit_object)	2271	=item $player_object->enter_exit ($exit_object)
1873		2272
…		…
1912		2311
1913	$rmp->{random_seed} ||= $exit->random_seed;	2312	$rmp->{random_seed} ||= $exit->random_seed;
1914		2313
1915	my $data = cf::to_json $rmp;	2314	my $data = cf::to_json $rmp;
1916	my $md5 = Digest::MD5::md5_hex $data;	2315	my $md5 = Digest::MD5::md5_hex $data;
1917	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2316	my $meta = "$RANDOMDIR/$md5.meta";
1918		2317
1919	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2318	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920	aio_write $fh, 0, (length $data), $data, 0;	2319	aio_write $fh, 0, (length $data), $data, 0;
1921	undef $fh;	2320	undef $fh;
1922	aio_rename "$meta~", $meta;	2321	aio_rename "$meta~", $meta;
…		…
1931		2330
1932	return unless $self->type == cf::PLAYER;	2331	return unless $self->type == cf::PLAYER;
1933		2332
1934	if ($exit->slaying eq "/!") {	2333	if ($exit->slaying eq "/!") {
1935	#TODO: this should de-fi-ni-te-ly not be a sync-job	2334	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2335	# the problem is that $exit might not survive long enough
		2336	# so it needs to be done right now, right here
1936	cf::sync_job { prepare_random_map $exit };	2337	cf::sync_job { prepare_random_map $exit };
1937	}	2338	}
1938		2339
1939	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2340	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940	my $hp = $exit->stats->hp;	2341	my $hp = $exit->stats->hp;
…		…
1948	$self->goto ($slaying, $hp, $sp);	2349	$self->goto ($slaying, $hp, $sp);
1949		2350
1950	1;	2351	1;
1951	}) {	2352	}) {
1952	$self->message ("Something went wrong deep within the crossfire server. "	2353	$self->message ("Something went wrong deep within the crossfire server. "
1953	. "I'll try to bring you back to the map you were before. "	2354	. "I'll try to bring you back to the map you were before. "
1954	. "Please report this to the dungeon master!",	2355	. "Please report this to the dungeon master!",
1955	cf::NDI_UNIQUE | cf::NDI_RED);	2356	cf::NDI_UNIQUE | cf::NDI_RED);
1956		2357
1957	warn "ERROR in enter_exit: $@";	2358	warn "ERROR in enter_exit: $@";
1958	$self->leave_link;	2359	$self->leave_link;
1959	}	2360	}
1960	})->prio (1);	2361	})->prio (1);
…		…
1973		2374
1974	sub cf::client::send_drawinfo {	2375	sub cf::client::send_drawinfo {
1975	my ($self, $text, $flags) = @_;	2376	my ($self, $text, $flags) = @_;
1976		2377
1977	utf8::encode $text;	2378	utf8::encode $text;
1978	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2379	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979	}	2380	}
1980		2381
		2382	=item $client->send_msg ($color, $type, $msg, [extra...])
		2383
		2384	Send a drawinfo or msg packet to the client, formatting the msg for the
		2385	client if neccessary. C<$type> should be a string identifying the type of
		2386	the message, with C<log> being the default. If C<$color> is negative, suppress
		2387	the message unless the client supports the msg packet.
		2388
		2389	=cut
		2390
		2391	sub cf::client::send_msg {
		2392	my ($self, $color, $type, $msg, @extra) = @_;
		2393
		2394	$msg = $self->pl->expand_cfpod ($msg);
		2395
		2396	if ($self->can_msg) {
		2397	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2398	} else {
		2399	# replace some tags by gcfclient-compatible ones
		2400	for ($msg) {
		2401	1 while
		2402	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2403	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2404	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2405	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2406	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2407	}
		2408
		2409	if ($color >= 0) {
		2410	if (0 && $msg =~ /\[/) {
		2411	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2412	} else {
		2413	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2414	$self->send_packet ("drawinfo $color $msg")
		2415	}
		2416	}
		2417	}
		2418	}
		2419
		2420	=item $client->ext_event ($type, %msg)
		2421
		2422	Sends an ext event to the client.
		2423
		2424	=cut
		2425
		2426	sub cf::client::ext_event($$%) {
		2427	my ($self, $type, %msg) = @_;
		2428
		2429	$msg{msgtype} = "event_$type";
		2430	$self->send_packet ("ext " . cf::to_json \%msg);
		2431	}
1981		2432
1982	=item $success = $client->query ($flags, "text", \&cb)	2433	=item $success = $client->query ($flags, "text", \&cb)
1983		2434
1984	Queues a query to the client, calling the given callback with	2435	Queues a query to the client, calling the given callback with
1985	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2436	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1986	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2437	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987		2438
1988	Queries can fail, so check the return code. Or don't, as queries will become	2439	Queries can fail, so check the return code. Or don't, as queries will
1989	reliable at some point in the future.	2440	become reliable at some point in the future.
1990		2441
1991	=cut	2442	=cut
1992		2443
1993	sub cf::client::query {	2444	sub cf::client::query {
1994	my ($self, $flags, $text, $cb) = @_;	2445	my ($self, $flags, $text, $cb) = @_;
…		…
2002	utf8::encode $text;	2453	utf8::encode $text;
2003	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2454	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004		2455
2005	$self->send_packet ($self->{query_queue}[0][0])	2456	$self->send_packet ($self->{query_queue}[0][0])
2006	if @{ $self->{query_queue} } == 1;	2457	if @{ $self->{query_queue} } == 1;
		2458
		2459	1
2007	}	2460	}
2008		2461
2009	cf::client->attach (	2462	cf::client->attach (
2010	on_reply => sub {	2463	on_reply => sub {
2011	my ($ns, $msg) = @_;	2464	my ($ns, $msg) = @_;
…		…
2026	} else {	2479	} else {
2027	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2480	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028	}	2481	}
2029	}	2482	}
2030	},	2483	},
		2484	on_exticmd => sub {
		2485	my ($ns, $buf) = @_;
		2486
		2487	my $msg = eval { from_json $buf };
		2488
		2489	if (ref $msg) {
		2490	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2491	if (my %reply = $cb->($ns, $msg)) {
		2492	$reply{msgid} = $msg->{msgid};
		2493	$ns->send ("ext " . cf::to_json \%reply);
		2494	}
		2495	}
		2496	} else {
		2497	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2498	}
		2499
		2500	cf::override;
		2501	},
2031	);	2502	);
2032		2503
2033	=item $client->async (\&cb)	2504	=item $client->async (\&cb)
2034		2505
2035	Create a new coroutine, running the specified callback. The coroutine will	2506	Create a new coroutine, running the specified callback. The coroutine will
…		…
2082		2553
2083	# here we export the classes and methods available to script code	2554	# here we export the classes and methods available to script code
2084		2555
2085	=pod	2556	=pod
2086		2557
2087	The following fucntions and emthods are available within a safe environment:	2558	The following functions and methods are available within a safe environment:
2088		2559
2089	cf::object contr pay_amount pay_player map	2560	cf::object contr pay_amount pay_player map
2090	cf::object::player player	2561	cf::object::player player
2091	cf::player peaceful	2562	cf::player peaceful
2092	cf::map trigger	2563	cf::map trigger
…		…
2173	=back	2644	=back
2174		2645
2175	=cut	2646	=cut
2176		2647
2177	#############################################################################	2648	#############################################################################
2178
2179	=head2 EXTENSION DATABASE SUPPORT
2180
2181	Crossfire maintains a very simple database for extension use. It can
2182	currently store anything that can be serialised using Storable, which
2183	excludes objects.
2184
2185	The parameter C<$family> should best start with the name of the extension
2186	using it, it should be unique.
2187
2188	=over 4
2189
2190	=item $value = cf::db_get $family => $key
2191
2192	Returns a single value from the database.
2193
2194	=item cf::db_put $family => $key => $value
2195
2196	Stores the given C<$value> in the family.
2197
2198	=cut
2199
2200	our $DB;
2201
2202	unless ($DB) {
2203	$DB = BDB::db_create $DB_ENV;
2204
2205	cf::sync_job {
2206	eval {
2207	$DB->set_flags (BDB::CHKSUM);
2208
2209	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2210	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2211	cf::cleanup "db_open(db): $!" if $!;
2212	};
2213	cf::cleanup "db_open(db): $@" if $@;
2214	};
2215
2216	my $path = cf::localdir . "/database.pst";
2217	if (stat $path) {
2218	cf::sync_job {
2219	my $pst = Storable::retrieve $path;
2220
2221	cf::db_put (board => data => $pst->{board});
2222	cf::db_put (guildrules => data => $pst->{guildrules});
2223	cf::db_put (rent => balance => $pst->{rent}{balance});
2224	BDB::db_env_txn_checkpoint $DB_ENV;
2225
2226	unlink $path;
2227	};
2228	}
2229	}
2230
2231	sub db_get($$) {
2232	my $key = "$_[0]/$_[1]";
2233
2234	cf::sync_job {
2235	BDB::db_get $DB, undef, $key, my $data;
2236
2237	$! ? ()
2238	: Compress::LZF::sthaw $data
2239	}
2240	}
2241
2242	sub db_put($$$) {
2243	BDB::dbreq_pri 4;
2244	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2245	}
2246
2247	#############################################################################
2248	# the server's init and main functions	2649	# the server's init and main functions
2249		2650
2250	sub load_resources {	2651	sub load_facedata($) {
2251	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2652	my ($path) = @_;
		2653
		2654	warn "loading facedata from $path\n";
		2655
		2656	my $facedata;
		2657	0 < aio_load $path, $facedata
		2658	or die "$path: $!";
		2659
		2660	$facedata = Coro::Storable::thaw $facedata;
		2661
		2662	$facedata->{version} == 2
		2663	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2664
		2665	{
		2666	my $faces = $facedata->{faceinfo};
		2667
		2668	while (my ($face, $info) = each %$faces) {
		2669	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2670	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2671	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2672	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2673	Coro::cede;
		2674	}
		2675
		2676	while (my ($face, $info) = each %$faces) {
		2677	next unless $info->{smooth};
		2678	my $idx = cf::face::find $face
		2679	or next;
		2680	if (my $smooth = cf::face::find $info->{smooth}) {
		2681	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2682	} else {
		2683	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2684	}
		2685	Coro::cede;
		2686	}
		2687	}
		2688
		2689	{
		2690	my $anims = $facedata->{animinfo};
		2691
		2692	while (my ($anim, $info) = each %$anims) {
		2693	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2694	Coro::cede;
		2695	}
		2696
		2697	cf::anim::invalidate_all; # d'oh
		2698	}
		2699
		2700	1
		2701	}
		2702
		2703	sub reload_regions {
		2704	load_resource_file "$MAPDIR/regions"
2252	or die "unable to load regions file\n";#d#	2705	or die "unable to load regions file\n";
		2706	}
		2707
		2708	sub reload_facedata {
		2709	load_facedata "$DATADIR/facedata"
		2710	or die "unable to load facedata\n";
		2711	}
		2712
		2713	sub reload_archetypes {
		2714	load_resource_file "$DATADIR/archetypes"
		2715	or die "unable to load archetypes\n";
		2716	}
		2717
		2718	sub reload_treasures {
		2719	load_resource_file "$DATADIR/treasures"
		2720	or die "unable to load treasurelists\n";
		2721	}
		2722
		2723	sub reload_resources {
		2724	warn "reloading resource files...\n";
		2725
		2726	reload_regions;
		2727	reload_facedata;
		2728	#reload_archetypes;#d#
		2729	reload_archetypes;
		2730	reload_treasures;
		2731
		2732	warn "finished reloading resource files\n";
		2733	}
		2734
		2735	sub init {
		2736	reload_resources;
2253	}	2737	}
2254		2738
2255	sub cfg_load {	2739	sub cfg_load {
2256	open my $fh, "<:utf8", cf::confdir . "/config"	2740	open my $fh, "<:utf8", "$CONFDIR/config"
2257	or return;	2741	or return;
2258		2742
2259	local $/;	2743	local $/;
2260	*CFG = YAML::Syck::Load <$fh>;	2744	*CFG = YAML::Syck::Load <$fh>;
2261		2745
…		…
2269	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2753	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2270	and die "WARNING: m(un)lockall failed: $!\n";	2754	and die "WARNING: m(un)lockall failed: $!\n";
2271	};	2755	};
2272	warn $@ if $@;	2756	warn $@ if $@;
2273	}	2757	}
2274	}
2275
2276	sub init {
2277	load_resources;
2278	}	2758	}
2279		2759
2280	sub main {	2760	sub main {
2281	# we must not ever block the main coroutine	2761	# we must not ever block the main coroutine
2282	local $Coro::idle = sub {	2762	local $Coro::idle = sub {
…		…
2285	Event::one_event;	2765	Event::one_event;
2286	})->prio (Coro::PRIO_MAX);	2766	})->prio (Coro::PRIO_MAX);
2287	};	2767	};
2288		2768
2289	cfg_load;	2769	cfg_load;
		2770	db_init;
2290	load_extensions;	2771	load_extensions;
2291		2772
2292	$TICK_WATCHER->start;	2773	$TICK_WATCHER->start;
2293	Event::loop;	2774	Event::loop;
2294	}	2775	}
…		…
2309	},	2790	},
2310	);	2791	);
2311	}	2792	}
2312	}	2793	}
2313		2794
		2795	sub write_runtime {
		2796	my $runtime = "$LOCALDIR/runtime";
		2797
		2798	# first touch the runtime file to show we are still running:
		2799	# the fsync below can take a very very long time.
		2800
		2801	IO::AIO::aio_utime $runtime, undef, undef;
		2802
		2803	my $guard = cf::lock_acquire "write_runtime";
		2804
		2805	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2806	or return;
		2807
		2808	my $value = $cf::RUNTIME + 90 + 10;
		2809	# 10 is the runtime save interval, for a monotonic clock
		2810	# 60 allows for the watchdog to kill the server.
		2811
		2812	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2813	and return;
		2814
		2815	# always fsync - this file is important
		2816	aio_fsync $fh
		2817	and return;
		2818
		2819	# touch it again to show we are up-to-date
		2820	aio_utime $fh, undef, undef;
		2821
		2822	close $fh
		2823	or return;
		2824
		2825	aio_rename "$runtime~", $runtime
		2826	and return;
		2827
		2828	warn "runtime file written.\n";
		2829
		2830	1
		2831	}
		2832
2314	sub emergency_save() {	2833	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	2834	my $freeze_guard = cf::freeze_mainloop;
2316		2835
2317	warn "enter emergency perl save\n";	2836	warn "enter emergency perl save\n";
2318		2837
…		…
2342	};	2861	};
2343		2862
2344	warn "leave emergency perl save\n";	2863	warn "leave emergency perl save\n";
2345	}	2864	}
2346		2865
		2866	sub post_cleanup {
		2867	my ($make_core) = @_;
		2868
		2869	warn Carp::longmess "post_cleanup backtrace"
		2870	if $make_core;
		2871	}
		2872
2347	sub reload() {	2873	sub do_reload_perl() {
2348	# can/must only be called in main	2874	# can/must only be called in main
2349	if ($Coro::current != $Coro::main) {	2875	if ($Coro::current != $Coro::main) {
2350	warn "can only reload from main coroutine";	2876	warn "can only reload from main coroutine";
2351	return;	2877	return;
2352	}	2878	}
2353		2879
2354	warn "reloading...";	2880	warn "reloading...";
2355		2881
2356	warn "cancelling server ticker";	2882	warn "entering sync_job";
2357	$TICK_WATCHER->cancel;
2358		2883
		2884	cf::sync_job {
		2885	cf::write_runtime; # external watchdog should not bark
2359	cf::emergency_save;	2886	cf::emergency_save;
		2887	cf::write_runtime; # external watchdog should not bark
2360		2888
2361	eval {	2889	warn "syncing database to disk";
		2890	BDB::db_env_txn_checkpoint $DB_ENV;
		2891
2362	# if anything goes wrong in here, we should simply crash as we already saved	2892	# if anything goes wrong in here, we should simply crash as we already saved
2363		2893
2364	warn "cancelling all WF_AUTOCANCEL watchers";	2894	warn "cancelling all WF_AUTOCANCEL watchers";
2365	for (Event::all_watchers) {	2895	for (Event::all_watchers) {
2366	$_->cancel if $_->data & WF_AUTOCANCEL;	2896	$_->cancel if $_->data & WF_AUTOCANCEL;
2367	}	2897	}
2368
2369	warn "syncing database to disk";
2370	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2371		2898
2372	warn "flushing outstanding aio requests";	2899	warn "flushing outstanding aio requests";
2373	for (;;) {	2900	for (;;) {
2374	BDB::flush;	2901	BDB::flush;
2375	IO::AIO::flush;	2902	IO::AIO::flush;
2376	Coro::cede;	2903	Coro::cede;
2377	last unless IO::AIO::nreqs || BDB::nreqs;	2904	last unless IO::AIO::nreqs || BDB::nreqs;
2378	warn "iterate...";	2905	warn "iterate...";
2379	}	2906	}
2380		2907
		2908	++$RELOAD;
		2909
2381	warn "cancelling all extension coros";	2910	warn "cancelling all extension coros";
2382	$_->cancel for values %EXT_CORO;	2911	$_->cancel for values %EXT_CORO;
2383	%EXT_CORO = ();	2912	%EXT_CORO = ();
2384		2913
2385	warn "removing commands";	2914	warn "removing commands";
2386	%COMMAND = ();	2915	%COMMAND = ();
2387		2916
2388	warn "removing ext commands";	2917	warn "removing ext/exti commands";
2389	%EXTCMD = ();	2918	%EXTCMD = ();
		2919	%EXTICMD = ();
2390		2920
2391	warn "unloading/nuking all extensions";	2921	warn "unloading/nuking all extensions";
2392	for my $pkg (@EXTS) {	2922	for my $pkg (@EXTS) {
2393	warn "... unloading $pkg";	2923	warn "... unloading $pkg";
2394		2924
…		…
2424	Symbol::delete_package "safe::$_"	2954	Symbol::delete_package "safe::$_"
2425	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2955	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2426		2956
2427	warn "unloading cf.pm \"a bit\"";	2957	warn "unloading cf.pm \"a bit\"";
2428	delete $INC{"cf.pm"};	2958	delete $INC{"cf.pm"};
		2959	delete $INC{"cf/pod.pm"};
2429		2960
2430	# don't, removes xs symbols, too,	2961	# don't, removes xs symbols, too,
2431	# and global variables created in xs	2962	# and global variables created in xs
2432	#Symbol::delete_package __PACKAGE__;	2963	#Symbol::delete_package __PACKAGE__;
2433		2964
…		…
2442		2973
2443	warn "loading extensions";	2974	warn "loading extensions";
2444	cf::load_extensions;	2975	cf::load_extensions;
2445		2976
2446	warn "reattaching attachments to objects/players";	2977	warn "reattaching attachments to objects/players";
2447	_global_reattach;	2978	_global_reattach; # objects, sockets
2448	warn "reattaching attachments to maps";	2979	warn "reattaching attachments to maps";
2449	reattach $_ for values %MAP;	2980	reattach $_ for values %MAP;
		2981	warn "reattaching attachments to players";
		2982	reattach $_ for values %PLAYER;
2450		2983
2451	warn "loading reloadable resources";	2984	warn "leaving sync_job";
2452	load_resources;
2453		2985
2454	warn "restarting server ticker";	2986	1
2455		2987	} or do {
2456	$TICK_WATCHER->start;
2457	};
2458
2459	if ($@) {
2460	warn $@;	2988	warn $@;
2461	warn "error while reloading, exiting.";	2989	warn "error while reloading, exiting.";
2462	exit 1;	2990	exit 1;
2463	}	2991	};
2464		2992
2465	warn "reloaded";	2993	warn "reloaded";
2466	};	2994	};
2467		2995
2468	our $RELOAD_WATCHER; # used only during reload	2996	our $RELOAD_WATCHER; # used only during reload
2469		2997
		2998	sub reload_perl() {
		2999	# doing reload synchronously and two reloads happen back-to-back,
		3000	# coro crashes during coro_state_free->destroy here.
		3001
		3002	$RELOAD_WATCHER ||= Event->timer (
		3003	reentrant => 0,
		3004	after => 0,
		3005	data => WF_AUTOCANCEL,
		3006	cb => sub {
		3007	do_reload_perl;
		3008	undef $RELOAD_WATCHER;
		3009	},
		3010	);
		3011	}
		3012
2470	register_command "reload" => sub {	3013	register_command "reload" => sub {
2471	my ($who, $arg) = @_;	3014	my ($who, $arg) = @_;
2472		3015
2473	if ($who->flag (FLAG_WIZ)) {	3016	if ($who->flag (FLAG_WIZ)) {
2474	$who->message ("reloading server.");	3017	$who->message ("reloading server.");
2475		3018	async { reload_perl };
2476	# doing reload synchronously and two reloads happen back-to-back,
2477	# coro crashes during coro_state_free->destroy here.
2478
2479	$RELOAD_WATCHER ||= Event->timer (
2480	reentrant => 0,
2481	after => 0,
2482	data => WF_AUTOCANCEL,
2483	cb => sub {
2484	reload;
2485	undef $RELOAD_WATCHER;
2486	},
2487	);
2488	}	3019	}
2489	};	3020	};
2490		3021
2491	unshift @INC, $LIBDIR;	3022	unshift @INC, $LIBDIR;
2492		3023
2493	my $bug_warning = 0;	3024	my $bug_warning = 0;
2494		3025
		3026	our @WAIT_FOR_TICK;
		3027	our @WAIT_FOR_TICK_BEGIN;
		3028
		3029	sub wait_for_tick {
		3030	return unless $TICK_WATCHER->is_active;
		3031	return if $Coro::current == $Coro::main;
		3032
		3033	my $signal = new Coro::Signal;
		3034	push @WAIT_FOR_TICK, $signal;
		3035	$signal->wait;
		3036	}
		3037
		3038	sub wait_for_tick_begin {
		3039	return unless $TICK_WATCHER->is_active;
		3040	return if $Coro::current == $Coro::main;
		3041
		3042	my $signal = new Coro::Signal;
		3043	push @WAIT_FOR_TICK_BEGIN, $signal;
		3044	$signal->wait;
		3045	}
		3046
		3047	my $min = 1e6;#d#
		3048	my $avg = 10;
2495	$TICK_WATCHER = Event->timer (	3049	$TICK_WATCHER = Event->timer (
2496	reentrant => 0,	3050	reentrant => 0,
2497	parked => 1,	3051	parked => 1,
2498	prio => 0,	3052	prio => 0,
2499	at => $NEXT_TICK || $TICK,	3053	at => $NEXT_TICK || $TICK,
…		…
2503	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3057	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2504	unless ++$bug_warning > 10;	3058	unless ++$bug_warning > 10;
2505	return;	3059	return;
2506	}	3060	}
2507		3061
2508	$NOW = Event::time;	3062	$NOW = $tick_start = Event::time;
2509		3063
2510	cf::server_tick; # one server iteration	3064	cf::server_tick; # one server iteration
		3065
		3066	0 && sync_job {#d#
		3067	for(1..10) {
		3068	my $t = Event::time;
		3069	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3070	or die;
		3071
		3072	$map->width (50);
		3073	$map->height (50);
		3074	$map->alloc;
		3075	$map->_load_objects ("/tmp/x.map", 1);
		3076	my $t = Event::time - $t;
		3077
		3078	#next unless $t < 0.0013;#d#
		3079	if ($t < $min) {
		3080	$min = $t;
		3081	}
		3082	$avg = $avg * 0.99 + $t * 0.01;
		3083	}
		3084	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3085	exit 0;
		3086	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3087	};
		3088
2511	$RUNTIME += $TICK;	3089	$RUNTIME += $TICK;
2512	$NEXT_TICK += $TICK;	3090	$NEXT_TICK += $TICK;
2513		3091
2514	$WAIT_FOR_TICK->broadcast;	3092	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2515	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3093	$NEXT_RUNTIME_WRITE = $NOW + 10;
2516		3094	Coro::async_pool {
2517	Event::sweep;	3095	write_runtime
2518	Coro::cede_notself;	3096	or warn "ERROR: unable to write runtime file: $!";
		3097	};
2519		3098	}
		3099
2520	# my $AFTER = Event::time;	3100	# my $AFTER = Event::time;
2521	# warn $AFTER - $NOW;#d#	3101	# warn $AFTER - $NOW;#d#
2522		3102
		3103	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3104	$sig->send;
		3105	}
		3106	while (my $sig = shift @WAIT_FOR_TICK) {
		3107	$sig->send;
		3108	}
		3109
		3110	$NOW = Event::time;
		3111
2523	# if we are delayed by four ticks or more, skip them all	3112	# if we are delayed by four ticks or more, skip them all
2524	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3113	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2525		3114
2526	$TICK_WATCHER->at ($NEXT_TICK);	3115	$TICK_WATCHER->at ($NEXT_TICK);
2527	$TICK_WATCHER->start;	3116	$TICK_WATCHER->start;
		3117
		3118	$LOAD = ($NOW - $tick_start) / $TICK;
		3119	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3120
		3121	_post_tick;
		3122
		3123
2528	},	3124	},
2529	);	3125	);
2530		3126
2531	{	3127	{
2532	BDB::max_poll_time $TICK * 0.1;	3128	BDB::max_poll_time $TICK * 0.1;
…		…
2560		3156
2561	cf::sync_job {	3157	cf::sync_job {
2562	eval {	3158	eval {
2563	BDB::db_env_open	3159	BDB::db_env_open
2564	$DB_ENV,	3160	$DB_ENV,
2565	$BDB_ENV_DIR,	3161	$BDBDIR,
2566	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3162	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2567	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3163	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2568	0666;	3164	0666;
2569		3165
2570	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3166	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2571		3167
2572	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3168	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2573	$DB_ENV->set_lk_detect;	3169	$DB_ENV->set_lk_detect;
2574	};	3170	};
2575		3171
…		…
2583		3179
2584	undef $Coro::AIO::WATCHER;	3180	undef $Coro::AIO::WATCHER;
2585	IO::AIO::max_poll_time $TICK * 0.1;	3181	IO::AIO::max_poll_time $TICK * 0.1;
2586	$AIO_POLL_WATCHER = Event->io (	3182	$AIO_POLL_WATCHER = Event->io (
2587	reentrant => 0,	3183	reentrant => 0,
		3184	data => WF_AUTOCANCEL,
2588	fd => IO::AIO::poll_fileno,	3185	fd => IO::AIO::poll_fileno,
2589	poll => 'r',	3186	poll => 'r',
2590	prio => 6,	3187	prio => 6,
2591	data => WF_AUTOCANCEL,
2592	cb => \&IO::AIO::poll_cb,	3188	cb => \&IO::AIO::poll_cb,
2593	);	3189	);
2594	}	3190	}
2595		3191
2596	$WRITE_RUNTIME_WATCHER = Event->timer (	3192	my $_log_backtrace;
2597	reentrant => 0,	3193
2598	data => WF_AUTOCANCEL,	3194	sub _log_backtrace {
2599	after => 1,	3195	my ($msg, @addr) = @_;
2600	interval => 10,	3196
2601	prio => 6, # keep it lowest so it acts like a watchdog	3197	$msg =~ s/\n//;
2602	cb => Coro::unblock_sub {	3198
2603	write_runtime	3199	# limit the # of concurrent backtraces
2604	or warn "ERROR: unable to write runtime file: $!";	3200	if ($_log_backtrace < 2) {
		3201	++$_log_backtrace;
		3202	async {
		3203	my @bt = fork_call {
		3204	@addr = map { sprintf "%x", $_ } @addr;
		3205	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3206	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3207	or die "addr2line: $!";
		3208
		3209	my @funcs;
		3210	my @res = <$fh>;
		3211	chomp for @res;
		3212	while (@res) {
		3213	my ($func, $line) = splice @res, 0, 2, ();
		3214	push @funcs, "[$func] $line";
		3215	}
		3216
		3217	@funcs
		3218	};
		3219
		3220	LOG llevInfo, "[ABT] $msg\n";
		3221	LOG llevInfo, "[ABT] $_\n" for @bt;
		3222	--$_log_backtrace;
		3223	};
		3224	} else {
		3225	LOG llevInfo, "[ABT] $msg\n";
		3226	LOG llevInfo, "[ABT] [suppressed]\n";
2605	},	3227	}
2606	);	3228	}
		3229
		3230	# load additional modules
		3231	use cf::pod;
2607		3232
2608	END { cf::emergency_save }	3233	END { cf::emergency_save }
2609		3234
2610	1	3235	1
2611		3236

Diff Legend

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