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.223 by root, Sun Mar 11 02:12:44 2007 UTC vs.
Revision 1.308 by root, Mon Jul 16 14:09:40 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 JSON::XS 1.4 ();
20	use BDB ();	26	use BDB ();
21	use Data::Dumper;	27	use Data::Dumper;
22	use Digest::MD5;	28	use Digest::MD5;
23	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
24	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	32	use Time::HiRes;
27	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
28		35
		36	# configure various modules to our taste
		37	#
		38	$Storable::canonical = 1; # reduce rsync transfers
		39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	40	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		41
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	42	$Event::Eval = 1; # no idea why this is required, but it is
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		43
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
37		46
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
40	our %COMMAND = ();	51	our %COMMAND = ();
41	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
42		53
43	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
47		59
48	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
49	our @EVENT;	61	our @EVENT;
50	our $LIBDIR = datadir . "/ext";
51		62
52	our $TICK = MAX_TIME * 1e-6;	63	our $CONFDIR = confdir;
		64	our $DATADIR = datadir;
		65	our $LIBDIR = "$DATADIR/ext";
		66	our $PODDIR = "$DATADIR/pod";
		67	our $MAPDIR = "$DATADIR/" . mapdir;
		68	our $LOCALDIR = localdir;
		69	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		70	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		71	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		72	our $RANDOMDIR = "$LOCALDIR/random";
		73	our $BDBDIR = "$LOCALDIR/db";
		74
		75	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
53	our $TICK_WATCHER;	76	our $TICK_WATCHER;
54	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
55	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
56	our $NEXT_TICK;	79	our $NEXT_TICK;
57	our $NOW;	80	our $NOW;
…		…
66	our $RUNTIME;	89	our $RUNTIME;
67		90
68	our %PLAYER; # all users	91	our %PLAYER; # all users
69	our %MAP; # all maps	92	our %MAP; # all maps
70	our $LINK_MAP; # the special {link} map, which is always available	93	our $LINK_MAP; # the special {link} map, which is always available
71	our $RANDOM_MAPS = cf::localdir . "/random";
72	our $BDB_ENV_DIR = cf::localdir . "/db";
73
74	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
75	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
76		94
77	# used to convert map paths into valid unix filenames by replacing / by ∕	95	# used to convert map paths into valid unix filenames by replacing / by ∕
78	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
79		97
		98	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		99	our $LOADAVG; # same thing, but with alpha-smoothing
		100	our $tick_start; # for load detecting purposes
		101
80	binmode STDOUT;	102	binmode STDOUT;
81	binmode STDERR;	103	binmode STDERR;
82		104
83	# read virtual server time, if available	105	# read virtual server time, if available
84	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
85	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
86	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
87	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
88	}	110	}
89		111
90	mkdir cf::localdir;	112	mkdir $_
91	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
92	mkdir cf::localdir . "/" . cf::tmpdir;
93	mkdir cf::localdir . "/" . cf::uniquedir;
94	mkdir $RANDOM_MAPS;
95	mkdir $BDB_ENV_DIR;
96		114
97	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
98		116
99	sub cf::map::normalise;	117	sub cf::map::normalise;
100		118
…		…
111	=item $cf::RUNTIME	129	=item $cf::RUNTIME
112		130
113	The time this server has run, starts at 0 and is increased by $cf::TICK on	131	The time this server has run, starts at 0 and is increased by $cf::TICK on
114	every server tick.	132	every server tick.
115		133
116	=item $cf::LIBDIR	134	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		135	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		136	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
117		137
118	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
119	be found. It will be added to C<@INC> automatically.	139	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		140	unique-items directory, player file directory, random maps directory and
		141	database environment.
120		142
121	=item $cf::NOW	143	=item $cf::NOW
122		144
123	The time of the last (current) server tick.	145	The time of the last (current) server tick.
124		146
125	=item $cf::TICK	147	=item $cf::TICK
126		148
127	The interval between server ticks, in seconds.	149	The interval between server ticks, in seconds.
		150
		151	=item $cf::LOADAVG
		152
		153	The current CPU load on the server (alpha-smoothed), as a value between 0
		154	(none) and 1 (overloaded), indicating how much time is spent on processing
		155	objects per tick. Healthy values are < 0.5.
		156
		157	=item $cf::LOAD
		158
		159	The raw value load value from the last tick.
128		160
129	=item %cf::CFG	161	=item %cf::CFG
130		162
131	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
132	from wherever your confdir points to.	164	from wherever your confdir points to.
133		165
134	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
135		167
136	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
137	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	169	returns directly I<after> the tick processing (and consequently, can only wake one process
138	processing has been done. Call C<< ->wait >> on them to maximise the	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
139	window of cpu time available, or simply to synchronise to the server tick.
140		171
141	=back	172	=back
142		173
143	=cut	174	=cut
144		175
145	BEGIN {	176	BEGIN {
146	*CORE::GLOBAL::warn = sub {	177	*CORE::GLOBAL::warn = sub {
147	my $msg = join "", @_;	178	my $msg = join "", @_;
148	utf8::encode $msg;
149		179
150	$msg .= "\n"	180	$msg .= "\n"
151	unless $msg =~ /\n$/;	181	unless $msg =~ /\n$/;
152		182
		183	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		184
		185	utf8::encode $msg;
153	LOG llevError, $msg;	186	LOG llevError, $msg;
154	};	187	};
155	}	188	}
156		189
157	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	190	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
158	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	191	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
159	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	192	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
160	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	193	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
161	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	194	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		195	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
162	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	196	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
163		197
164	# we bless all objects into (empty) derived classes to force a method lookup	198	# we bless all objects into (empty) derived classes to force a method lookup
165	# within the Safe compartment.	199	# within the Safe compartment.
166	for my $pkg (qw(	200	for my $pkg (qw(
167	cf::global cf::attachable	201	cf::global cf::attachable
…		…
175	}	209	}
176		210
177	$Event::DIED = sub {	211	$Event::DIED = sub {
178	warn "error in event callback: @_";	212	warn "error in event callback: @_";
179	};	213	};
		214
		215	#############################################################################
180		216
181	=head2 UTILITY FUNCTIONS	217	=head2 UTILITY FUNCTIONS
182		218
183	=over 4	219	=over 4
184		220
…		…
203	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	239	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
204	$d	240	$d
205	} || "[unable to dump $_[0]: '$@']";	241	} || "[unable to dump $_[0]: '$@']";
206	}	242	}
207		243
208	use JSON::Syck (); # TODO# replace by JSON::PC once working
209
210	=item $ref = cf::from_json $json	244	=item $ref = cf::from_json $json
211		245
212	Converts a JSON string into the corresponding perl data structure.	246	Converts a JSON string into the corresponding perl data structure.
213		247
214	=cut
215
216	sub from_json($) {
217	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
218	JSON::Syck::Load $_[0]
219	}
220
221	=item $json = cf::to_json $ref	248	=item $json = cf::to_json $ref
222		249
223	Converts a perl data structure into its JSON representation.	250	Converts a perl data structure into its JSON representation.
224		251
225	=cut	252	=cut
226		253
227	sub to_json($) {	254	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
228	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	255
229	JSON::Syck::Dump $_[0]	256	sub to_json ($) { $json_coder->encode ($_[0]) }
230	}	257	sub from_json ($) { $json_coder->decode ($_[0]) }
231		258
232	=item cf::lock_wait $string	259	=item cf::lock_wait $string
233		260
234	Wait until the given lock is available. See cf::lock_acquire.	261	Wait until the given lock is available. See cf::lock_acquire.
235		262
…		…
241	returned.	268	returned.
242		269
243	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
244	uses map_find and cf::map::load uses map_load).	271	uses map_find and cf::map::load uses map_load).
245		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
246	=cut	277	=cut
247		278
248	our %LOCK;	279	our %LOCK;
249		280
250	sub lock_wait($) {	281	sub lock_wait($) {
…		…
267		298
268	Coro::guard {	299	Coro::guard {
269	# wake up all waiters, to be on the safe side	300	# wake up all waiters, to be on the safe side
270	$_->ready for @{ delete $LOCK{$key} };	301	$_->ready for @{ delete $LOCK{$key} };
271	}	302	}
		303	}
		304
		305	sub lock_active($) {
		306	my ($key) = @_;
		307
		308	! ! $LOCK{$key}
272	}	309	}
273		310
274	sub freeze_mainloop {	311	sub freeze_mainloop {
275	return unless $TICK_WATCHER->is_active;	312	return unless $TICK_WATCHER->is_active;
276		313
…		…
291		328
292	BEGIN { *async = \&Coro::async_pool }	329	BEGIN { *async = \&Coro::async_pool }
293		330
294	=item cf::sync_job { BLOCK }	331	=item cf::sync_job { BLOCK }
295		332
296	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)
297	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
298	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.
299		337
300	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
301	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
302	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
303	fast or be very important.	341	fast or be very important.
…		…
306		344
307	sub sync_job(&) {	345	sub sync_job(&) {
308	my ($job) = @_;	346	my ($job) = @_;
309		347
310	if ($Coro::current == $Coro::main) {	348	if ($Coro::current == $Coro::main) {
		349	my $time = Event::time;
		350
311	# this is the main coro, too bad, we have to block	351	# this is the main coro, too bad, we have to block
312	# till the operation succeeds, freezing the server :/	352	# till the operation succeeds, freezing the server :/
313		353
314	# TODO: use suspend/resume instead	354	# TODO: use suspend/resume instead
315	# (but this is cancel-safe)	355	# (but this is cancel-safe)
…		…
326		366
327	while ($busy) {	367	while ($busy) {
328	Coro::cede or Event::one_event;	368	Coro::cede or Event::one_event;
329	}	369	}
330		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
331	wantarray ? @res : $res[0]	378	wantarray ? @res : $res[0]
332	} else {	379	} else {
333	# we are in another coroutine, how wonderful, everything just works	380	# we are in another coroutine, how wonderful, everything just works
334		381
335	$job->()	382	$job->()
…		…
354	$EXT_CORO{$coro+0} = $coro;	401	$EXT_CORO{$coro+0} = $coro;
355		402
356	$coro	403	$coro
357	}	404	}
358		405
359	sub write_runtime {	406	=item fork_call { }, $args
360	my $guard = cf::lock_acquire "write_runtime";
361		407
362	my $runtime = cf::localdir . "/runtime";	408	Executes the given code block with the given arguments in a seperate
		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.
363		412
364	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	413	=cut
365	or return;
366		414
367	my $value = $cf::RUNTIME + 90 + 10;	415	sub _store_scalar {
368	# 10 is the runtime save interval, for a monotonic clock	416	open my $fh, ">", \my $buf
369	# 60 allows for the watchdog to kill the server.	417	or die "fork_call: cannot open fh-to-buf in child : $!";
370		418	Storable::store_fd $_[0], $fh;
371	(aio_write $fh, 0, (length $value), $value, 0) <= 0
372	and return;
373
374	# always fsync - this file is important
375	aio_fsync $fh
376	and return;
377
378	close $fh	419	close $fh;
379	or return;
380		420
381	aio_rename "$runtime~", $runtime	421	$buf
382	and return;	422	}
383		423
		424	sub fork_call(&@) {
		425	my ($cb, @args) = @_;
		426
		427	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		428	# or die "socketpair: $!";
		429	pipe my $fh1, my $fh2
		430	or die "pipe: $!";
		431
		432	if (my $pid = fork) {
		433	close $fh2;
		434
		435	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		436	warn "pst<$res>" unless $res =~ /^pst/;
		437	$res = Coro::Storable::thaw $res;
		438
		439	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		440
		441	Carp::confess $$res unless "ARRAY" eq ref $res;
		442
		443	return wantarray ? @$res : $res->[-1];
		444	} else {
		445	reset_signals;
		446	local $SIG{__WARN__};
		447	local $SIG{__DIE__};
		448	# just in case, this hack effectively disables event
		449	# in the child. cleaner and slower would be canceling all watchers,
		450	# but this works for the time being.
		451	local $Coro::idle;
		452	$Coro::current->prio (Coro::PRIO_MAX);
		453
		454	eval {
		455	close $fh1;
		456
		457	my @res = eval { $cb->(@args) };
		458
		459	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		460	close $fh2;
		461	};
		462
		463	warn $@ if $@;
		464	_exit 0;
384	1	465	}
		466	}
		467
		468	=item $value = cf::db_get $family => $key
		469
		470	Returns a single value from the environment database.
		471
		472	=item cf::db_put $family => $key => $value
		473
		474	Stores the given C<$value> in the family. It can currently store binary
		475	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		476
		477	=cut
		478
		479	our $DB;
		480
		481	sub db_init {
		482	unless ($DB) {
		483	$DB = BDB::db_create $DB_ENV;
		484
		485	cf::sync_job {
		486	eval {
		487	$DB->set_flags (BDB::CHKSUM);
		488
		489	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		490	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		491	cf::cleanup "db_open(db): $!" if $!;
		492	};
		493	cf::cleanup "db_open(db): $@" if $@;
		494	};
		495	}
		496	}
		497
		498	sub db_get($$) {
		499	my $key = "$_[0]/$_[1]";
		500
		501	cf::sync_job {
		502	BDB::db_get $DB, undef, $key, my $data;
		503
		504	$! ? ()
		505	: $data
		506	}
		507	}
		508
		509	sub db_put($$$) {
		510	BDB::dbreq_pri 4;
		511	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		512	}
		513
		514	=item cf::cache $id => [$paths...], $processversion => $process
		515
		516	Generic caching function that returns the value of the resource $id,
		517	caching and regenerating as required.
		518
		519	This function can block.
		520
		521	=cut
		522
		523	sub cache {
		524	my ($id, $src, $processversion, $process) = @_;
		525
		526	my $meta =
		527	join "\x00",
		528	$processversion,
		529	map {
		530	aio_stat $_
		531	and Carp::croak "$_: $!";
		532
		533	($_, (stat _)[7,9])
		534	} @$src;
		535
		536	my $dbmeta = db_get cache => "$id/meta";
		537	if ($dbmeta ne $meta) {
		538	# changed, we may need to process
		539
		540	my @data;
		541	my $md5;
		542
		543	for (0 .. $#$src) {
		544	0 <= aio_load $src->[$_], $data[$_]
		545	or Carp::croak "$src->[$_]: $!";
		546	}
		547
		548	# if processing is expensive, check
		549	# checksum first
		550	if (1) {
		551	$md5 =
		552	join "\x00",
		553	$processversion,
		554	map {
		555	Coro::cede;
		556	($src->[$_], Digest::MD5::md5_hex $data[$_])
		557	} 0.. $#$src;
		558
		559
		560	my $dbmd5 = db_get cache => "$id/md5";
		561	if ($dbmd5 eq $md5) {
		562	db_put cache => "$id/meta", $meta;
		563
		564	return db_get cache => "$id/data";
		565	}
		566	}
		567
		568	my $t1 = Time::HiRes::time;
		569	my $data = $process->(\@data);
		570	my $t2 = Time::HiRes::time;
		571
		572	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		573
		574	db_put cache => "$id/data", $data;
		575	db_put cache => "$id/md5" , $md5;
		576	db_put cache => "$id/meta", $meta;
		577
		578	return $data;
		579	}
		580
		581	db_get cache => "$id/data"
		582	}
		583
		584	=item cf::datalog type => key => value, ...
		585
		586	Log a datalog packet of the given type with the given key-value pairs.
		587
		588	=cut
		589
		590	sub datalog($@) {
		591	my ($type, %kv) = @_;
		592	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
385	}	593	}
386		594
387	=back	595	=back
388		596
389	=cut	597	=cut
…		…
396	attach callbacks/event handlers (a collection of which is called an "attachment")	604	attach callbacks/event handlers (a collection of which is called an "attachment")
397	to it. All such attachable objects support the following methods.	605	to it. All such attachable objects support the following methods.
398		606
399	In the following description, CLASS can be any of C<global>, C<object>	607	In the following description, CLASS can be any of C<global>, C<object>
400	C<player>, C<client> or C<map> (i.e. the attachable objects in	608	C<player>, C<client> or C<map> (i.e. the attachable objects in
401	crossfire+).	609	Crossfire TRT).
402		610
403	=over 4	611	=over 4
404		612
405	=item $attachable->attach ($attachment, key => $value...)	613	=item $attachable->attach ($attachment, key => $value...)
406		614
…		…
569	$registry = $CB_TYPE[$object_type] ||= [];	777	$registry = $CB_TYPE[$object_type] ||= [];
570		778
571	} elsif ($type eq "subtype") {	779	} elsif ($type eq "subtype") {
572	defined $object_type or Carp::croak "subtype specified without type";	780	defined $object_type or Carp::croak "subtype specified without type";
573	my $object_subtype = shift @arg;	781	my $object_subtype = shift @arg;
574	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	782	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575		783
576	} elsif ($type eq "package") {	784	} elsif ($type eq "package") {
577	my $pkg = shift @arg;	785	my $pkg = shift @arg;
578		786
579	while (my ($name, $id) = each %cb_id) {	787	while (my ($name, $id) = each %cb_id) {
…		…
608	_attach $registry, $klass, @attach;	816	_attach $registry, $klass, @attach;
609	}	817	}
610		818
611	$obj->{$name} = \%arg;	819	$obj->{$name} = \%arg;
612	} else {	820	} else {
613	warn "object uses attachment '$name' that is not available, postponing.\n";	821	warn "object uses attachment '$name' which is not available, postponing.\n";
614	}	822	}
615		823
616	$obj->{_attachment}{$name} = undef;	824	$obj->{_attachment}{$name} = undef;
617	}	825	}
618		826
…		…
620	if (ref $_[0]) {	828	if (ref $_[0]) {
621	_object_attach @_;	829	_object_attach @_;
622	} else {	830	} else {
623	_attach shift->_attach_registry, @_;	831	_attach shift->_attach_registry, @_;
624	}	832	}
		833	_recalc_want;
625	};	834	};
626		835
627	# all those should be optimised	836	# all those should be optimised
628	sub cf::attachable::detach {	837	sub cf::attachable::detach {
629	my ($obj, $name) = @_;	838	my ($obj, $name) = @_;
…		…
632	delete $obj->{_attachment}{$name};	841	delete $obj->{_attachment}{$name};
633	reattach ($obj);	842	reattach ($obj);
634	} else {	843	} else {
635	Carp::croak "cannot, currently, detach class attachments";	844	Carp::croak "cannot, currently, detach class attachments";
636	}	845	}
		846	_recalc_want;
637	};	847	};
638		848
639	sub cf::attachable::attached {	849	sub cf::attachable::attached {
640	my ($obj, $name) = @_;	850	my ($obj, $name) = @_;
641		851
…		…
814	or return;	1024	or return;
815	$av = eval { (Storable::thaw $av)->{objs} };	1025	$av = eval { (Storable::thaw $av)->{objs} };
816	}	1026	}
817		1027
818	warn sprintf "loading %s (%d)\n",	1028	warn sprintf "loading %s (%d)\n",
819	$filename, length $data, scalar @{$av || []};#d#	1029	$filename, length $data, scalar @{$av || []};
820	return ($data, $av);	1030	return ($data, $av);
821	}	1031	}
		1032
		1033	=head2 COMMAND CALLBACKS
		1034
		1035	=over 4
		1036
		1037	=cut
822		1038
823	#############################################################################	1039	#############################################################################
824	# command handling &c	1040	# command handling &c
825		1041
826	=item cf::register_command $name => \&callback($ob,$args);	1042	=item cf::register_command $name => \&callback($ob,$args);
…		…
839	push @{ $COMMAND{$name} }, [$caller, $cb];	1055	push @{ $COMMAND{$name} }, [$caller, $cb];
840	}	1056	}
841		1057
842	=item cf::register_extcmd $name => \&callback($pl,$packet);	1058	=item cf::register_extcmd $name => \&callback($pl,$packet);
843		1059
844	Register a callbackf ro execution when the client sends an extcmd packet.	1060	Register a callback for execution when the client sends an (synchronous)
		1061	extcmd packet. Ext commands will be processed in the order they are
		1062	received by the server, like other user commands. The first argument is
		1063	the logged-in player. Ext commands can only be processed after a player
		1064	has logged in successfully.
845		1065
846	If the callback returns something, it is sent back as if reply was being	1066	If the callback returns something, it is sent back as if reply was being
847	called.	1067	called.
848		1068
		1069	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1070
		1071	Register a callback for execution when the client sends an (asynchronous)
		1072	exticmd packet. Exti commands are processed by the server as soon as they
		1073	are received, i.e. out of order w.r.t. other commands. The first argument
		1074	is a client socket. Exti commands can be received anytime, even before
		1075	log-in.
		1076
		1077	If the callback returns something, it is sent back as if reply was being
		1078	called.
		1079
849	=cut	1080	=cut
850		1081
851	sub register_extcmd {	1082	sub register_extcmd {
852	my ($name, $cb) = @_;	1083	my ($name, $cb) = @_;
853		1084
854	$EXTCMD{$name} = $cb;	1085	$EXTCMD{$name} = $cb;
		1086	}
		1087
		1088	sub register_exticmd {
		1089	my ($name, $cb) = @_;
		1090
		1091	$EXTICMD{$name} = $cb;
855	}	1092	}
856		1093
857	cf::player->attach (	1094	cf::player->attach (
858	on_command => sub {	1095	on_command => sub {
859	my ($pl, $name, $params) = @_;	1096	my ($pl, $name, $params) = @_;
…		…
868	cf::override;	1105	cf::override;
869	},	1106	},
870	on_extcmd => sub {	1107	on_extcmd => sub {
871	my ($pl, $buf) = @_;	1108	my ($pl, $buf) = @_;
872		1109
873	my $msg = eval { from_json $buf };	1110	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874		1111
875	if (ref $msg) {	1112	if (ref $msg) {
876	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1113	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
877	if (my %reply = $cb->($pl, $msg)) {	1114	if (my %reply = $cb->($pl, $msg)) {
878	$pl->ext_reply ($msg->{msgid}, %reply);	1115	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
884		1121
885	cf::override;	1122	cf::override;
886	},	1123	},
887	);	1124	);
888		1125
889	sub load_extension {
890	my ($path) = @_;
891
892	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
893	my $base = $1;
894	my $pkg = $1;
895	$pkg =~ s/[^[:word:]]/_/g;
896	$pkg = "ext::$pkg";
897
898	warn "... loading '$path' into '$pkg'\n";
899
900	open my $fh, "<:utf8", $path
901	or die "$path: $!";
902
903	my $source =
904	"package $pkg; use strict; use utf8;\n"
905	. "#line 1 \"$path\"\n{\n"
906	. (do { local $/; <$fh> })
907	. "\n};\n1";
908
909	unless (eval $source) {
910	my $msg = $@ ? "$path: $@\n"
911	: "extension disabled.\n";
912	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
913	warn $@;
914	warn "mandatory extension failed to load, exiting.\n";
915	exit 1;
916	}
917	die $@;
918	}
919
920	push @EXTS, $pkg;
921	}
922
923	sub load_extensions {	1126	sub load_extensions {
		1127	cf::sync_job {
		1128	my %todo;
		1129
924	for my $ext (<$LIBDIR/*.ext>) {	1130	for my $path (<$LIBDIR/*.ext>) {
925	next unless -r $ext;	1131	next unless -r $path;
926	eval {	1132
927	load_extension $ext;	1133	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1134	my $base = $1;
		1135	my $pkg = $1;
		1136	$pkg =~ s/[^[:word:]]/_/g;
		1137	$pkg = "ext::$pkg";
		1138
		1139	open my $fh, "<:utf8", $path
		1140	or die "$path: $!";
		1141
		1142	my $source = do { local $/; <$fh> };
		1143
		1144	my %ext = (
		1145	path => $path,
		1146	base => $base,
		1147	pkg => $pkg,
		1148	);
		1149
		1150	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1151	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1152
		1153	$ext{source} =
		1154	"package $pkg; use strict; use utf8;\n"
		1155	. "#line 1 \"$path\"\n{\n"
		1156	. $source
		1157	. "\n};\n1";
		1158
		1159	$todo{$base} = \%ext;
		1160	}
		1161
		1162	my %done;
		1163	while (%todo) {
		1164	my $progress;
		1165
		1166	while (my ($k, $v) = each %todo) {
		1167	for (split /,\s*/, $v->{meta}{depends}) {
		1168	goto skip
		1169	unless exists $done{$_};
		1170	}
		1171
		1172	warn "... loading '$k' into '$v->{pkg}'\n";
		1173
		1174	unless (eval $v->{source}) {
		1175	my $msg = $@ ? "$v->{path}: $@\n"
		1176	: "$v->{base}: extension inactive.\n";
		1177
		1178	if (exists $v->{meta}{mandatory}) {
		1179	warn $msg;
		1180	warn "mandatory extension failed to load, exiting.\n";
		1181	exit 1;
		1182	}
		1183
		1184	warn $msg;
		1185	}
		1186
		1187	$done{$k} = delete $todo{$k};
		1188	push @EXTS, $v->{pkg};
		1189	$progress = 1;
928	1	1190	}
929	} or warn "$ext not loaded: $@";	1191
		1192	skip:
		1193	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1194	unless $progress;
		1195	}
930	}	1196	};
931	}	1197	}
932		1198
933	#############################################################################	1199	#############################################################################
934		1200
		1201	=back
		1202
935	=head2 CORE EXTENSIONS	1203	=head2 CORE EXTENSIONS
936		1204
937	Functions and methods that extend core crossfire objects.	1205	Functions and methods that extend core crossfire objects.
938		1206
939	=cut	1207	=cut
…		…
951	Returns the given player object, loading it if necessary (might block).	1219	Returns the given player object, loading it if necessary (might block).
952		1220
953	=cut	1221	=cut
954		1222
955	sub playerdir($) {	1223	sub playerdir($) {
956	cf::localdir	1224	"$PLAYERDIR/"
957	. "/"
958	. cf::playerdir
959	. "/"
960	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1225	. (ref $_[0] ? $_[0]->ob->name : $_[0])
961	}	1226	}
962		1227
963	sub path($) {	1228	sub path($) {
964	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1229	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
965		1230
966	(playerdir $login) . "/$login.pl"	1231	(playerdir $login) . "/playerdata"
967	}	1232	}
968		1233
969	sub find_active($) {	1234	sub find_active($) {
970	$cf::PLAYER{$_[0]}	1235	$cf::PLAYER{$_[0]}
971	and $cf::PLAYER{$_[0]}->active	1236	and $cf::PLAYER{$_[0]}->active
…		…
984	my $login = $_[0];	1249	my $login = $_[0];
985		1250
986	my $guard = cf::lock_acquire "user_find:$login";	1251	my $guard = cf::lock_acquire "user_find:$login";
987		1252
988	$cf::PLAYER{$_[0]} || do {	1253	$cf::PLAYER{$_[0]} || do {
		1254	# rename old playerfiles to new ones
		1255	#TODO: remove when no longer required
		1256	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1257	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1258	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1259	aio_unlink +(playerdir $login) . "/$login.pl";
		1260
989	my $pl = load_pl path $login	1261	my $pl = load_pl path $login
990	or return;	1262	or return;
991	$cf::PLAYER{$login} = $pl	1263	$cf::PLAYER{$login} = $pl
992	}	1264	}
993	}	1265	}
…		…
1077	while and may block, so not sync_job-capable, ever.	1349	while and may block, so not sync_job-capable, ever.
1078		1350
1079	=cut	1351	=cut
1080		1352
1081	sub list_logins {	1353	sub list_logins {
1082	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1354	my $dirs = aio_readdir $PLAYERDIR
1083	or return [];	1355	or return [];
1084		1356
1085	my @logins;	1357	my @logins;
1086		1358
1087	for my $login (@$dirs) {	1359	for my $login (@$dirs) {
…		…
1122	}	1394	}
1123		1395
1124	\@paths	1396	\@paths
1125	}	1397	}
1126		1398
		1399	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1400
		1401	Expand crossfire pod fragments into protocol xml.
		1402
		1403	=cut
		1404
		1405	sub expand_cfpod {
		1406	((my $self), (local $_)) = @_;
		1407
		1408	# escape & and <
		1409	s/&/&amp;/g;
		1410	s/(?<![BIUGH])</&lt;/g;
		1411
		1412	# this is buggy, it needs to properly take care of nested <'s
		1413
		1414	1 while
		1415	# replace B<>, I<>, U<> etc.
		1416	s/B<([^\>]*)>/<b>$1<\/b>/
		1417	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1418	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1419	# replace G<male|female> tags
		1420	|| s{G<([^>|]*)\|([^>]*)>}{
		1421	$self->gender ? $2 : $1
		1422	}ge
		1423	# replace H<hint text>
		1424	|| s{H<([^\>]*)>}
		1425	{
		1426	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1427	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1428	"")
		1429	[$self->{hintmode}]
		1430	}ge;
		1431
		1432	# create single paragraphs (very hackish)
		1433	s/(?<=\S)\n(?=\w)/ /g;
		1434
		1435	# compress some whitespace
		1436	s/\s+\n/\n/g; # ws line-ends
		1437	s/\n\n+/\n/g; # double lines
		1438	s/^\n+//; # beginning lines
		1439	s/\n+$//; # ending lines
		1440
		1441	$_
		1442	}
		1443
		1444	sub hintmode {
		1445	$_[0]{hintmode} = $_[1] if @_ > 1;
		1446	$_[0]{hintmode}
		1447	}
		1448
1127	=item $player->ext_reply ($msgid, $msgtype, %msg)	1449	=item $player->ext_reply ($msgid, %msg)
1128		1450
1129	Sends an ext reply to the player.	1451	Sends an ext reply to the player.
1130		1452
1131	=cut	1453	=cut
1132		1454
1133	sub ext_reply($$$%) {	1455	sub ext_reply($$%) {
1134	my ($self, $id, %msg) = @_;	1456	my ($self, $id, %msg) = @_;
1135		1457
1136	$msg{msgid} = $id;	1458	$msg{msgid} = $id;
1137		1459	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1138	$self->send ("ext " . cf::to_json \%msg);
1139	}	1460	}
1140		1461
1141	package cf;	1462	=item $player->ext_event ($type, %msg)
		1463
		1464	Sends an ext event to the client.
		1465
		1466	=cut
		1467
		1468	sub ext_event($$%) {
		1469	my ($self, $type, %msg) = @_;
		1470
		1471	$self->ns->ext_event ($type, %msg);
		1472	}
		1473
		1474	=head3 cf::region
		1475
		1476	=over 4
		1477
		1478	=cut
		1479
		1480	package cf::region;
		1481
		1482	=item cf::region::find_by_path $path
		1483
		1484	Tries to decuce the likely region for a map knowing only its path.
		1485
		1486	=cut
		1487
		1488	sub find_by_path($) {
		1489	my ($path) = @_;
		1490
		1491	my ($match, $specificity);
		1492
		1493	for my $region (list) {
		1494	if ($region->{match} && $path =~ $region->{match}) {
		1495	($match, $specificity) = ($region, $region->specificity)
		1496	if $region->specificity > $specificity;
		1497	}
		1498	}
		1499
		1500	$match
		1501	}
1142		1502
1143	=back	1503	=back
1144
1145		1504
1146	=head3 cf::map	1505	=head3 cf::map
1147		1506
1148	=over 4	1507	=over 4
1149		1508
…		…
1204	my ($self, $merge) = @_;	1563	my ($self, $merge) = @_;
1205		1564
1206	# we have to keep some variables in memory intact	1565	# we have to keep some variables in memory intact
1207	local $self->{path};	1566	local $self->{path};
1208	local $self->{load_path};	1567	local $self->{load_path};
1209	local $self->{deny_save};
1210	local $self->{deny_reset};
1211		1568
1212	$self->SUPER::thawer_merge ($merge);	1569	$self->SUPER::thawer_merge ($merge);
1213	}	1570	}
1214		1571
1215	sub normalise {	1572	sub normalise {
…		…
1262	$self->init; # pass $1 etc.	1619	$self->init; # pass $1 etc.
1263	return $self;	1620	return $self;
1264	}	1621	}
1265	}	1622	}
1266		1623
1267	Carp::carp "unable to resolve path '$path' (base '$base').";	1624	Carp::cluck "unable to resolve path '$path' (base '$base').";
1268	()	1625	()
1269	}	1626	}
1270		1627
1271	sub init {	1628	sub init {
1272	my ($self) = @_;	1629	my ($self) = @_;
…		…
1287		1644
1288	# the original (read-only) location	1645	# the original (read-only) location
1289	sub load_path {	1646	sub load_path {
1290	my ($self) = @_;	1647	my ($self) = @_;
1291		1648
1292	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1649	"$MAPDIR/$self->{path}.map"
1293	}	1650	}
1294		1651
1295	# the temporary/swap location	1652	# the temporary/swap location
1296	sub save_path {	1653	sub save_path {
1297	my ($self) = @_;	1654	my ($self) = @_;
1298		1655
1299	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1656	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1300	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1657	"$TMPDIR/$path.map"
1301	}	1658	}
1302		1659
1303	# the unique path, undef == no special unique path	1660	# the unique path, undef == no special unique path
1304	sub uniq_path {	1661	sub uniq_path {
1305	my ($self) = @_;	1662	my ($self) = @_;
1306		1663
1307	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1664	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1308	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1665	"$UNIQUEDIR/$path"
1309	}	1666	}
1310		1667
1311	# and all this just because we cannot iterate over	1668	# and all this just because we cannot iterate over
1312	# all maps in C++...	1669	# all maps in C++...
1313	sub change_all_map_light {	1670	sub change_all_map_light {
1314	my ($change) = @_;	1671	my ($change) = @_;
1315		1672
1316	$_->change_map_light ($change)	1673	$_->change_map_light ($change)
1317	for grep $_->outdoor, values %cf::MAP;	1674	for grep $_->outdoor, values %cf::MAP;
		1675	}
		1676
		1677	sub decay_objects {
		1678	my ($self) = @_;
		1679
		1680	return if $self->{deny_reset};
		1681
		1682	$self->do_decay_objects;
1318	}	1683	}
1319		1684
1320	sub unlink_save {	1685	sub unlink_save {
1321	my ($self) = @_;	1686	my ($self) = @_;
1322		1687
…		…
1380	$self->load_header_orig	1745	$self->load_header_orig
1381	or return;	1746	or return;
1382	$self->prepare_orig;	1747	$self->prepare_orig;
1383	}	1748	}
1384		1749
		1750	$self->{deny_reset} = 1
		1751	if $self->no_reset;
		1752
		1753	$self->default_region (cf::region::find_by_path $self->{path})
		1754	unless $self->default_region;
		1755
1385	1	1756	1
1386	}	1757	}
1387		1758
1388	sub find;	1759	sub find;
1389	sub find {	1760	sub find {
…		…
1401	$map->{last_save} = $cf::RUNTIME;	1772	$map->{last_save} = $cf::RUNTIME;
1402		1773
1403	$map->load_header	1774	$map->load_header
1404	or return;	1775	or return;
1405		1776
1406	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1777	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1407	# doing this can freeze the server in a sync job, obviously	1778	# doing this can freeze the server in a sync job, obviously
1408	#$cf::WAIT_FOR_TICK->wait;	1779	#$cf::WAIT_FOR_TICK->wait;
1409	$map->reset;	1780	$map->reset;
1410	undef $guard;	1781	undef $guard;
1411	return find $path;	1782	return find $path;
…		…
1422	my ($self) = @_;	1793	my ($self) = @_;
1423		1794
1424	local $self->{deny_reset} = 1; # loading can take a long time	1795	local $self->{deny_reset} = 1; # loading can take a long time
1425		1796
1426	my $path = $self->{path};	1797	my $path = $self->{path};
		1798
		1799	{
1427	my $guard = cf::lock_acquire "map_load:$path";	1800	my $guard = cf::lock_acquire "map_load:$path";
1428		1801
1429	return if $self->in_memory != cf::MAP_SWAPPED;	1802	return if $self->in_memory != cf::MAP_SWAPPED;
1430		1803
1431	$self->in_memory (cf::MAP_LOADING);	1804	$self->in_memory (cf::MAP_LOADING);
1432		1805
1433	$self->alloc;	1806	$self->alloc;
1434		1807
1435	$self->pre_load;	1808	$self->pre_load;
1436
1437	$self->_load_objects ($self->{load_path}, 1)
1438	or return;
1439
1440	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1441	if delete $self->{load_original};
1442
1443	if (my $uniq = $self->uniq_path) {
1444	utf8::encode $uniq;
1445	if (aio_open $uniq, O_RDONLY, 0) {
1446	$self->clear_unique_items;
1447	$self->_load_objects ($uniq, 0);
1448	}
1449	}
1450
1451	Coro::cede;
1452
1453	# now do the right thing for maps
1454	$self->link_multipart_objects;
1455
1456	unless ($self->{deny_activate}) {
1457	$self->decay_objects;
1458	$self->fix_auto_apply;
1459	$self->update_buttons;
1460	Coro::cede;	1809	Coro::cede;
1461	$self->set_darkness_map;	1810
		1811	$self->_load_objects ($self->{load_path}, 1)
		1812	or return;
		1813
		1814	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1815	if delete $self->{load_original};
		1816
		1817	if (my $uniq = $self->uniq_path) {
		1818	utf8::encode $uniq;
		1819	if (aio_open $uniq, O_RDONLY, 0) {
		1820	$self->clear_unique_items;
		1821	$self->_load_objects ($uniq, 0);
		1822	}
		1823	}
		1824
		1825	Coro::cede;
		1826	# now do the right thing for maps
		1827	$self->link_multipart_objects;
1462	$self->difficulty ($self->estimate_difficulty)	1828	$self->difficulty ($self->estimate_difficulty)
1463	unless $self->difficulty;	1829	unless $self->difficulty;
1464	Coro::cede;	1830	Coro::cede;
		1831
		1832	unless ($self->{deny_activate}) {
		1833	$self->decay_objects;
		1834	$self->fix_auto_apply;
		1835	$self->update_buttons;
		1836	Coro::cede;
		1837	$self->set_darkness_map;
		1838	Coro::cede;
1465	$self->activate;	1839	$self->activate;
		1840	}
		1841
		1842	$self->in_memory (cf::MAP_IN_MEMORY);
1466	}	1843	}
1467		1844
1468	$self->post_load;	1845	$self->post_load;
1469
1470	$self->in_memory (cf::MAP_IN_MEMORY);
1471	}	1846	}
1472		1847
1473	sub customise_for {	1848	sub customise_for {
1474	my ($self, $ob) = @_;	1849	my ($self, $ob) = @_;
1475		1850
1476	return find "~" . $ob->name . "/" . $self->{path}	1851	return find "~" . $ob->name . "/" . $self->{path}
1477	if $self->per_player;	1852	if $self->per_player;
		1853
		1854	# return find "?party/" . $ob->name . "/" . $self->{path}
		1855	# if $self->per_party;
1478		1856
1479	$self	1857	$self
1480	}	1858	}
1481		1859
1482	# find and load all maps in the 3x3 area around a map	1860	# find and load all maps in the 3x3 area around a map
…		…
1529		1907
1530	undef $MAP_PREFETCH{$path};	1908	undef $MAP_PREFETCH{$path};
1531	$MAP_PREFETCHER ||= cf::async {	1909	$MAP_PREFETCHER ||= cf::async {
1532	while (%MAP_PREFETCH) {	1910	while (%MAP_PREFETCH) {
1533	for my $path (keys %MAP_PREFETCH) {	1911	for my $path (keys %MAP_PREFETCH) {
1534	my $map = find $path	1912	if (my $map = find $path) {
1535	or next;
1536	$map->load;	1913	$map->load;
		1914	}
1537		1915
1538	delete $MAP_PREFETCH{$path};	1916	delete $MAP_PREFETCH{$path};
1539	}	1917	}
1540	}	1918	}
1541	undef $MAP_PREFETCHER;	1919	undef $MAP_PREFETCHER;
…		…
1593		1971
1594	sub reset_at {	1972	sub reset_at {
1595	my ($self) = @_;	1973	my ($self) = @_;
1596		1974
1597	# TODO: safety, remove and allow resettable per-player maps	1975	# TODO: safety, remove and allow resettable per-player maps
1598	return 1e99 if $self->isa ("ext::map_per_player");#d#
1599	return 1e99 if $self->{deny_reset};	1976	return 1e99 if $self->{deny_reset};
1600		1977
1601	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1978	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1602	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1979	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1603		1980
…		…
1614	my ($self) = @_;	1991	my ($self) = @_;
1615		1992
1616	my $lock = cf::lock_acquire "map_data:$self->{path}";	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1617		1994
1618	return if $self->players;	1995	return if $self->players;
1619	return if $self->isa ("ext::map_per_player");#d#
1620		1996
1621	warn "resetting map ", $self->path;#d#	1997	warn "resetting map ", $self->path;
1622		1998
1623	$self->in_memory (cf::MAP_SWAPPED);	1999	$self->in_memory (cf::MAP_SWAPPED);
1624		2000
1625	# need to save uniques path	2001	# need to save uniques path
1626	unless ($self->{deny_save}) {	2002	unless ($self->{deny_save}) {
…		…
1658	$cf::MAP{$self->path} = $self;	2034	$cf::MAP{$self->path} = $self;
1659		2035
1660	$self->reset; # polite request, might not happen	2036	$self->reset; # polite request, might not happen
1661	}	2037	}
1662		2038
		2039	=item $maps = cf::map::tmp_maps
		2040
		2041	Returns an arrayref with all map paths of currently instantiated and saved
		2042	maps. May block.
		2043
		2044	=cut
		2045
		2046	sub tmp_maps() {
		2047	[
		2048	map {
		2049	utf8::decode $_;
		2050	/\.map$/
		2051	? normalise $_
		2052	: ()
		2053	} @{ aio_readdir $TMPDIR or [] }
		2054	]
		2055	}
		2056
		2057	=item $maps = cf::map::random_maps
		2058
		2059	Returns an arrayref with all map paths of currently instantiated and saved
		2060	random maps. May block.
		2061
		2062	=cut
		2063
		2064	sub random_maps() {
		2065	[
		2066	map {
		2067	utf8::decode $_;
		2068	/\.map$/
		2069	? normalise "?random/$_"
		2070	: ()
		2071	} @{ aio_readdir $RANDOMDIR or [] }
		2072	]
		2073	}
		2074
1663	=item cf::map::unique_maps	2075	=item cf::map::unique_maps
1664		2076
1665	Returns an arrayref of paths of all shared maps that have	2077	Returns an arrayref of paths of all shared maps that have
1666	instantiated unique items. May block.	2078	instantiated unique items. May block.
1667		2079
1668	=cut	2080	=cut
1669		2081
1670	sub unique_maps() {	2082	sub unique_maps() {
1671	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2083	[
1672	or return;	2084	map {
1673
1674	my @paths;
1675
1676	for (@$files) {
1677	utf8::decode $_;	2085	utf8::decode $_;
1678	next if /\.pst$/;	2086	/\.map$/
1679	next unless /^$PATH_SEP/o;	2087	? normalise $_
1680		2088	: ()
1681	push @paths, cf::map::normalise $_;	2089	} @{ aio_readdir $UNIQUEDIR or [] }
1682	}	2090	]
1683
1684	\@paths
1685	}	2091	}
1686		2092
1687	package cf;	2093	package cf;
1688		2094
1689	=back	2095	=back
…		…
1735		2141
1736	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2142	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1737		2143
1738	if ($self->{record_replies}) {	2144	if ($self->{record_replies}) {
1739	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2145	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2146
1740	} else {	2147	} else {
		2148	my $pl = $self->contr;
		2149
		2150	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2151	my $diag = $pl->{npc_dialog};
		2152	$diag->{pl}->ext_reply (
		2153	$diag->{id},
		2154	msgtype => "reply",
		2155	msg => $diag->{pl}->expand_cfpod ($msg),
		2156	add_topics => []
		2157	);
		2158
		2159	} else {
1741	$msg = $npc->name . " says: $msg" if $npc;	2160	$msg = $npc->name . " says: $msg" if $npc;
1742	$self->message ($msg, $flags);	2161	$self->message ($msg, $flags);
		2162	}
1743	}	2163	}
1744	}	2164	}
1745		2165
1746	=item $player_object->may ("access")	2166	=item $player_object->may ("access")
1747		2167
…		…
1795	$self->deactivate_recursive;	2215	$self->deactivate_recursive;
1796		2216
1797	return if UNIVERSAL::isa $self->map, "ext::map_link";	2217	return if UNIVERSAL::isa $self->map, "ext::map_link";
1798		2218
1799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2219	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1800	if $self->map;	2220	if $self->map && $self->map->{path} ne "{link}";
1801		2221
1802	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2222	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1803	}	2223	}
1804		2224
1805	sub cf::object::player::leave_link {	2225	sub cf::object::player::leave_link {
1806	my ($self, $map, $x, $y) = @_;	2226	my ($self, $map, $x, $y) = @_;
		2227
		2228	return unless $self->contr->active;
1807		2229
1808	my $link_pos = delete $self->{_link_pos};	2230	my $link_pos = delete $self->{_link_pos};
1809		2231
1810	unless ($map) {	2232	unless ($map) {
1811	# restore original map position	2233	# restore original map position
…		…
1834		2256
1835	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2257	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1836	$self->enter_map ($map, $x, $y);	2258	$self->enter_map ($map, $x, $y);
1837	}	2259	}
1838		2260
1839	cf::player->attach (	2261	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1840	on_logout => sub {
1841	my ($pl) = @_;
1842		2262
1843	# abort map switching before logout	2263	Moves the player to the given map-path and coordinates by first freezing
1844	if ($pl->ob->{_link_pos}) {	2264	her, loading and preparing them map, calling the provided $check callback
1845	cf::sync_job {	2265	that has to return the map if sucecssful, and then unfreezes the player on
1846	$pl->ob->leave_link	2266	the new (success) or old (failed) map position. In either case, $done will
1847	};	2267	be called at the end of this process.
1848	}
1849	},
1850	on_login => sub {
1851	my ($pl) = @_;
1852		2268
1853	# try to abort aborted map switching on player login :)
1854	# should happen only on crashes
1855	if ($pl->ob->{_link_pos}) {
1856	$pl->ob->enter_link;
1857	(async {
1858	$pl->ob->reply (undef,
1859	"There was an internal problem at your last logout, "
1860	. "the server will try to bring you to your intended destination in a second.",
1861	cf::NDI_RED);
1862	# we need this sleep as the login has a concurrent enter_exit running
1863	# and this sleep increases chances of the player not ending up in scorn
1864	Coro::Timer::sleep 1;
1865	$pl->ob->leave_link;
1866	})->prio (2);
1867	}
1868	},
1869	);
1870
1871	=item $player_object->goto ($path, $x, $y)
1872
1873	=cut	2269	=cut
		2270
		2271	our $GOTOGEN;
1874		2272
1875	sub cf::object::player::goto {	2273	sub cf::object::player::goto {
1876	my ($self, $path, $x, $y) = @_;	2274	my ($self, $path, $x, $y, $check, $done) = @_;
		2275
		2276	# do generation counting so two concurrent goto's will be executed in-order
		2277	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1877		2278
1878	$self->enter_link;	2279	$self->enter_link;
1879		2280
1880	(async {	2281	(async {
1881	my $map = eval {	2282	my $map = eval {
1882	my $map = cf::map::find $path;	2283	my $map = cf::map::find $path;
		2284
		2285	if ($map) {
1883	$map = $map->customise_for ($self) if $map;	2286	$map = $map->customise_for ($self);
		2287	$map = $check->($map) if $check && $map;
		2288	} else {
		2289	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2290	}
		2291
1884	$map	2292	$map
		2293	};
		2294
		2295	if ($@) {
		2296	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2297	LOG llevError | logBacktrace, Carp::longmess $@;
1885	} or	2298	}
1886	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1887		2299
		2300	if ($gen == $self->{_goto_generation}) {
		2301	delete $self->{_goto_generation};
1888	$self->leave_link ($map, $x, $y);	2302	$self->leave_link ($map, $x, $y);
		2303	}
		2304
		2305	$done->() if $done;
1889	})->prio (1);	2306	})->prio (1);
1890	}	2307	}
1891		2308
1892	=item $player_object->enter_exit ($exit_object)	2309	=item $player_object->enter_exit ($exit_object)
1893		2310
…		…
1932		2349
1933	$rmp->{random_seed} ||= $exit->random_seed;	2350	$rmp->{random_seed} ||= $exit->random_seed;
1934		2351
1935	my $data = cf::to_json $rmp;	2352	my $data = cf::to_json $rmp;
1936	my $md5 = Digest::MD5::md5_hex $data;	2353	my $md5 = Digest::MD5::md5_hex $data;
1937	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2354	my $meta = "$RANDOMDIR/$md5.meta";
1938		2355
1939	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2356	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1940	aio_write $fh, 0, (length $data), $data, 0;	2357	aio_write $fh, 0, (length $data), $data, 0;
1941	undef $fh;	2358	undef $fh;
1942	aio_rename "$meta~", $meta;	2359	aio_rename "$meta~", $meta;
…		…
1951		2368
1952	return unless $self->type == cf::PLAYER;	2369	return unless $self->type == cf::PLAYER;
1953		2370
1954	if ($exit->slaying eq "/!") {	2371	if ($exit->slaying eq "/!") {
1955	#TODO: this should de-fi-ni-te-ly not be a sync-job	2372	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2373	# the problem is that $exit might not survive long enough
		2374	# so it needs to be done right now, right here
1956	cf::sync_job { prepare_random_map $exit };	2375	cf::sync_job { prepare_random_map $exit };
1957	}	2376	}
1958		2377
1959	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2378	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1960	my $hp = $exit->stats->hp;	2379	my $hp = $exit->stats->hp;
1961	my $sp = $exit->stats->sp;	2380	my $sp = $exit->stats->sp;
1962		2381
1963	$self->enter_link;	2382	$self->enter_link;
		2383
		2384	# if exit is damned, update players death & WoR home-position
		2385	$self->contr->savebed ($slaying, $hp, $sp)
		2386	if $exit->flag (FLAG_DAMNED);
1964		2387
1965	(async {	2388	(async {
1966	$self->deactivate_recursive; # just to be sure	2389	$self->deactivate_recursive; # just to be sure
1967	unless (eval {	2390	unless (eval {
1968	$self->goto ($slaying, $hp, $sp);	2391	$self->goto ($slaying, $hp, $sp);
1969		2392
1970	1;	2393	1;
1971	}) {	2394	}) {
1972	$self->message ("Something went wrong deep within the crossfire server. "	2395	$self->message ("Something went wrong deep within the crossfire server. "
1973	. "I'll try to bring you back to the map you were before. "	2396	. "I'll try to bring you back to the map you were before. "
1974	. "Please report this to the dungeon master!",	2397	. "Please report this to the dungeon master!",
1975	cf::NDI_UNIQUE | cf::NDI_RED);	2398	cf::NDI_UNIQUE | cf::NDI_RED);
1976		2399
1977	warn "ERROR in enter_exit: $@";	2400	warn "ERROR in enter_exit: $@";
1978	$self->leave_link;	2401	$self->leave_link;
1979	}	2402	}
1980	})->prio (1);	2403	})->prio (1);
…		…
1993		2416
1994	sub cf::client::send_drawinfo {	2417	sub cf::client::send_drawinfo {
1995	my ($self, $text, $flags) = @_;	2418	my ($self, $text, $flags) = @_;
1996		2419
1997	utf8::encode $text;	2420	utf8::encode $text;
1998	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2421	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1999	}	2422	}
2000		2423
		2424	=item $client->send_msg ($color, $type, $msg, [extra...])
		2425
		2426	Send a drawinfo or msg packet to the client, formatting the msg for the
		2427	client if neccessary. C<$type> should be a string identifying the type of
		2428	the message, with C<log> being the default. If C<$color> is negative, suppress
		2429	the message unless the client supports the msg packet.
		2430
		2431	=cut
		2432
		2433	sub cf::client::send_msg {
		2434	my ($self, $color, $type, $msg, @extra) = @_;
		2435
		2436	$msg = $self->pl->expand_cfpod ($msg);
		2437
		2438	return unless @extra || length $msg;
		2439
		2440	if ($self->can_msg) {
		2441	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2442	} else {
		2443	# replace some tags by gcfclient-compatible ones
		2444	for ($msg) {
		2445	1 while
		2446	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2447	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2448	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2449	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2450	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2451	}
		2452
		2453	if ($color >= 0) {
		2454	if (0 && $msg =~ /\[/) {
		2455	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2456	} else {
		2457	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2458	$self->send_packet ("drawinfo $color $msg")
		2459	}
		2460	}
		2461	}
		2462	}
		2463
		2464	=item $client->ext_event ($type, %msg)
		2465
		2466	Sends an ext event to the client.
		2467
		2468	=cut
		2469
		2470	sub cf::client::ext_event($$%) {
		2471	my ($self, $type, %msg) = @_;
		2472
		2473	return unless $self->extcmd;
		2474
		2475	$msg{msgtype} = "event_$type";
		2476	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2477	}
2001		2478
2002	=item $success = $client->query ($flags, "text", \&cb)	2479	=item $success = $client->query ($flags, "text", \&cb)
2003		2480
2004	Queues a query to the client, calling the given callback with	2481	Queues a query to the client, calling the given callback with
2005	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2482	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2006	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2483	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2007		2484
2008	Queries can fail, so check the return code. Or don't, as queries will become	2485	Queries can fail, so check the return code. Or don't, as queries will
2009	reliable at some point in the future.	2486	become reliable at some point in the future.
2010		2487
2011	=cut	2488	=cut
2012		2489
2013	sub cf::client::query {	2490	sub cf::client::query {
2014	my ($self, $flags, $text, $cb) = @_;	2491	my ($self, $flags, $text, $cb) = @_;
…		…
2022	utf8::encode $text;	2499	utf8::encode $text;
2023	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2500	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2024		2501
2025	$self->send_packet ($self->{query_queue}[0][0])	2502	$self->send_packet ($self->{query_queue}[0][0])
2026	if @{ $self->{query_queue} } == 1;	2503	if @{ $self->{query_queue} } == 1;
		2504
		2505	1
2027	}	2506	}
2028		2507
2029	cf::client->attach (	2508	cf::client->attach (
		2509	on_connect => sub {
		2510	my ($ns) = @_;
		2511
		2512	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2513	},
2030	on_reply => sub {	2514	on_reply => sub {
2031	my ($ns, $msg) = @_;	2515	my ($ns, $msg) = @_;
2032		2516
2033	# this weird shuffling is so that direct followup queries	2517	# this weird shuffling is so that direct followup queries
2034	# get handled first	2518	# get handled first
…		…
2046	} else {	2530	} else {
2047	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2531	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2048	}	2532	}
2049	}	2533	}
2050	},	2534	},
		2535	on_exticmd => sub {
		2536	my ($ns, $buf) = @_;
		2537
		2538	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2539
		2540	if (ref $msg) {
		2541	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2542	if (my %reply = $cb->($ns, $msg)) {
		2543	$reply{msgid} = $msg->{msgid};
		2544	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2545	}
		2546	}
		2547	} else {
		2548	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2549	}
		2550
		2551	cf::override;
		2552	},
2051	);	2553	);
2052		2554
2053	=item $client->async (\&cb)	2555	=item $client->async (\&cb)
2054		2556
2055	Create a new coroutine, running the specified callback. The coroutine will	2557	Create a new coroutine, running the specified callback. The coroutine will
…		…
2102		2604
2103	# here we export the classes and methods available to script code	2605	# here we export the classes and methods available to script code
2104		2606
2105	=pod	2607	=pod
2106		2608
2107	The following fucntions and emthods are available within a safe environment:	2609	The following functions and methods are available within a safe environment:
2108		2610
2109	cf::object contr pay_amount pay_player map	2611	cf::object
		2612	contr pay_amount pay_player map x y force_find force_add
		2613	insert remove
		2614
2110	cf::object::player player	2615	cf::object::player
2111	cf::player peaceful	2616	player
2112	cf::map trigger	2617
		2618	cf::player
		2619	peaceful
		2620
		2621	cf::map
		2622	trigger
2113		2623
2114	=cut	2624	=cut
2115		2625
2116	for (	2626	for (
2117	["cf::object" => qw(contr pay_amount pay_player map)],	2627	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2628	insert remove)],
2118	["cf::object::player" => qw(player)],	2629	["cf::object::player" => qw(player)],
2119	["cf::player" => qw(peaceful)],	2630	["cf::player" => qw(peaceful)],
2120	["cf::map" => qw(trigger)],	2631	["cf::map" => qw(trigger)],
2121	) {	2632	) {
2122	no strict 'refs';	2633	no strict 'refs';
…		…
2193	=back	2704	=back
2194		2705
2195	=cut	2706	=cut
2196		2707
2197	#############################################################################	2708	#############################################################################
2198
2199	=head2 EXTENSION DATABASE SUPPORT
2200
2201	Crossfire maintains a very simple database for extension use. It can
2202	currently store anything that can be serialised using Storable, which
2203	excludes objects.
2204
2205	The parameter C<$family> should best start with the name of the extension
2206	using it, it should be unique.
2207
2208	=over 4
2209
2210	=item $value = cf::db_get $family => $key
2211
2212	Returns a single value from the database.
2213
2214	=item cf::db_put $family => $key => $value
2215
2216	Stores the given C<$value> in the family.
2217
2218	=cut
2219
2220	our $DB;
2221
2222	sub db_init {
2223	unless ($DB) {
2224	$DB = BDB::db_create $DB_ENV;
2225
2226	cf::sync_job {
2227	eval {
2228	$DB->set_flags (BDB::CHKSUM);
2229
2230	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2231	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2232	cf::cleanup "db_open(db): $!" if $!;
2233	};
2234	cf::cleanup "db_open(db): $@" if $@;
2235	};
2236
2237	my $path = cf::localdir . "/database.pst";
2238	if (stat $path) {
2239	cf::sync_job {
2240	my $pst = Storable::retrieve $path;
2241
2242	cf::db_put (board => data => $pst->{board});
2243	cf::db_put (guildrules => data => $pst->{guildrules});
2244	cf::db_put (rent => balance => $pst->{rent}{balance});
2245	BDB::db_env_txn_checkpoint $DB_ENV;
2246
2247	unlink $path;
2248	};
2249	}
2250	}
2251	}
2252
2253	sub db_get($$) {
2254	my $key = "$_[0]/$_[1]";
2255
2256	cf::sync_job {
2257	BDB::db_get $DB, undef, $key, my $data;
2258
2259	$! ? ()
2260	: Compress::LZF::sthaw $data
2261	}
2262	}
2263
2264	sub db_put($$$) {
2265	BDB::dbreq_pri 4;
2266	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2267	}
2268
2269	#############################################################################
2270	# the server's init and main functions	2709	# the server's init and main functions
2271		2710
2272	sub load_faces {	2711	sub load_facedata($) {
2273	my $path = sprintf "%s/faces", cf::datadir;	2712	my ($path) = @_;
2274		2713
2275	warn "loading faces from $path\n";	2714	warn "loading facedata from $path\n";
2276		2715
2277	my $faces;	2716	my $facedata;
2278	0 < aio_load $path, $faces	2717	0 < aio_load $path, $facedata
2279	or die "$path: $!";	2718	or die "$path: $!";
2280		2719
2281	Coro::cede;
2282	$faces = Storable::thaw $faces;	2720	$facedata = Coro::Storable::thaw $facedata;
2283	Coro::cede;
2284		2721
		2722	$facedata->{version} == 2
		2723	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2724
		2725	{
		2726	my $faces = $facedata->{faceinfo};
		2727
2285	while (my ($face, $info) = each %$faces) {	2728	while (my ($face, $info) = each %$faces) {
2286	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2729	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2287	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2730	cf::face::set_visibility $idx, $info->{visibility};
		2731	cf::face::set_magicmap $idx, $info->{magicmap};
2288	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2732	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2289	Coro::cede;	2733	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2734
		2735	cf::cede_to_tick;
		2736	}
		2737
		2738	while (my ($face, $info) = each %$faces) {
		2739	next unless $info->{smooth};
		2740	my $idx = cf::face::find $face
		2741	or next;
		2742	if (my $smooth = cf::face::find $info->{smooth}) {
		2743	cf::face::set_smooth $idx, $smooth;
		2744	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2745	} else {
		2746	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2747	}
		2748
		2749	cf::cede_to_tick;
		2750	}
		2751	}
		2752
		2753	{
		2754	my $anims = $facedata->{animinfo};
		2755
		2756	while (my ($anim, $info) = each %$anims) {
		2757	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2758	cf::cede_to_tick;
		2759	}
		2760
		2761	cf::anim::invalidate_all; # d'oh
		2762	}
		2763
		2764	{
		2765	# TODO: for gcfclient pleasure, we should give resources
		2766	# that gcfclient doesn't grok a >10000 face index.
		2767	my $res = $facedata->{resource};
		2768	my $enc = JSON::XS->new->utf8->canonical;
		2769
		2770	while (my ($name, $info) = each %$res) {
		2771	my $meta = $enc->encode ({
		2772	name => $name,
		2773	type => $info->{type},
		2774	copyright => $info->{copyright}, #TODO#
		2775	});
		2776
		2777	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2778
		2779	if ($name =~ /\.jpg$/) {
		2780	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2781	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2782	} else {
		2783	my $data = pack "(w/a*)*", $meta, $info->{data};
		2784	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2785
		2786	cf::face::set_type $idx, 1;
		2787	cf::face::set_data $idx, 0, $data, $chk;
		2788	}
		2789
		2790	cf::cede_to_tick;
		2791	}
2290	}	2792	}
2291		2793
2292	1	2794	1
2293	}	2795	}
2294		2796
		2797	sub reload_regions {
		2798	load_resource_file "$MAPDIR/regions"
		2799	or die "unable to load regions file\n";
		2800
		2801	for (cf::region::list) {
		2802	$_->{match} = qr/$_->{match}/
		2803	if exists $_->{match};
		2804	}
		2805	}
		2806
		2807	sub reload_facedata {
		2808	load_facedata "$DATADIR/facedata"
		2809	or die "unable to load facedata\n";
		2810	}
		2811
		2812	sub reload_archetypes {
		2813	load_resource_file "$DATADIR/archetypes"
		2814	or die "unable to load archetypes\n";
		2815	#d# NEED to laod twice to resolve forward references
		2816	# this really needs to be done in an extra post-pass
		2817	# (which needs to be synchronous, so solve it differently)
		2818	load_resource_file "$DATADIR/archetypes"
		2819	or die "unable to load archetypes\n";
		2820	}
		2821
		2822	sub reload_treasures {
		2823	load_resource_file "$DATADIR/treasures"
		2824	or die "unable to load treasurelists\n";
		2825	}
		2826
2295	sub reload_resources {	2827	sub reload_resources {
2296	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2828	warn "reloading resource files...\n";
2297	or die "unable to load regions file\n";#d#	2829
		2830	reload_regions;
2298	load_faces	2831	reload_facedata;
2299	or die "unable to load faces\n";#d#	2832	#reload_archetypes;#d#
		2833	reload_archetypes;
		2834	reload_treasures;
		2835
		2836	warn "finished reloading resource files\n";
2300	}	2837	}
2301		2838
2302	sub init {	2839	sub init {
2303	reload_resources;	2840	reload_resources;
2304	}	2841	}
2305		2842
2306	sub cfg_load {	2843	sub cfg_load {
2307	open my $fh, "<:utf8", cf::confdir . "/config"	2844	open my $fh, "<:utf8", "$CONFDIR/config"
2308	or return;	2845	or return;
2309		2846
2310	local $/;	2847	local $/;
2311	*CFG = YAML::Syck::Load <$fh>;	2848	*CFG = YAML::Syck::Load <$fh>;
2312		2849
…		…
2357	},	2894	},
2358	);	2895	);
2359	}	2896	}
2360	}	2897	}
2361		2898
		2899	sub write_runtime {
		2900	my $runtime = "$LOCALDIR/runtime";
		2901
		2902	# first touch the runtime file to show we are still running:
		2903	# the fsync below can take a very very long time.
		2904
		2905	IO::AIO::aio_utime $runtime, undef, undef;
		2906
		2907	my $guard = cf::lock_acquire "write_runtime";
		2908
		2909	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2910	or return;
		2911
		2912	my $value = $cf::RUNTIME + 90 + 10;
		2913	# 10 is the runtime save interval, for a monotonic clock
		2914	# 60 allows for the watchdog to kill the server.
		2915
		2916	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2917	and return;
		2918
		2919	# always fsync - this file is important
		2920	aio_fsync $fh
		2921	and return;
		2922
		2923	# touch it again to show we are up-to-date
		2924	aio_utime $fh, undef, undef;
		2925
		2926	close $fh
		2927	or return;
		2928
		2929	aio_rename "$runtime~", $runtime
		2930	and return;
		2931
		2932	warn "runtime file written.\n";
		2933
		2934	1
		2935	}
		2936
2362	sub emergency_save() {	2937	sub emergency_save() {
2363	my $freeze_guard = cf::freeze_mainloop;	2938	my $freeze_guard = cf::freeze_mainloop;
2364		2939
2365	warn "enter emergency perl save\n";	2940	warn "enter emergency perl save\n";
2366		2941
…		…
2397		2972
2398	warn Carp::longmess "post_cleanup backtrace"	2973	warn Carp::longmess "post_cleanup backtrace"
2399	if $make_core;	2974	if $make_core;
2400	}	2975	}
2401		2976
2402	sub reload() {	2977	sub do_reload_perl() {
2403	# can/must only be called in main	2978	# can/must only be called in main
2404	if ($Coro::current != $Coro::main) {	2979	if ($Coro::current != $Coro::main) {
2405	warn "can only reload from main coroutine";	2980	warn "can only reload from main coroutine";
2406	return;	2981	return;
2407	}	2982	}
…		…
2441	%EXT_CORO = ();	3016	%EXT_CORO = ();
2442		3017
2443	warn "removing commands";	3018	warn "removing commands";
2444	%COMMAND = ();	3019	%COMMAND = ();
2445		3020
2446	warn "removing ext commands";	3021	warn "removing ext/exti commands";
2447	%EXTCMD = ();	3022	%EXTCMD = ();
		3023	%EXTICMD = ();
2448		3024
2449	warn "unloading/nuking all extensions";	3025	warn "unloading/nuking all extensions";
2450	for my $pkg (@EXTS) {	3026	for my $pkg (@EXTS) {
2451	warn "... unloading $pkg";	3027	warn "... unloading $pkg";
2452		3028
…		…
2482	Symbol::delete_package "safe::$_"	3058	Symbol::delete_package "safe::$_"
2483	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3059	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2484		3060
2485	warn "unloading cf.pm \"a bit\"";	3061	warn "unloading cf.pm \"a bit\"";
2486	delete $INC{"cf.pm"};	3062	delete $INC{"cf.pm"};
		3063	delete $INC{"cf/pod.pm"};
2487		3064
2488	# don't, removes xs symbols, too,	3065	# don't, removes xs symbols, too,
2489	# and global variables created in xs	3066	# and global variables created in xs
2490	#Symbol::delete_package __PACKAGE__;	3067	#Symbol::delete_package __PACKAGE__;
2491		3068
…		…
2506	warn "reattaching attachments to maps";	3083	warn "reattaching attachments to maps";
2507	reattach $_ for values %MAP;	3084	reattach $_ for values %MAP;
2508	warn "reattaching attachments to players";	3085	warn "reattaching attachments to players";
2509	reattach $_ for values %PLAYER;	3086	reattach $_ for values %PLAYER;
2510		3087
2511	warn "loading reloadable resources";
2512	reload_resources;
2513
2514	warn "leaving sync_job";	3088	warn "leaving sync_job";
2515		3089
2516	1	3090	1
2517	} or do {	3091	} or do {
2518	warn $@;	3092	warn $@;
…		…
2523	warn "reloaded";	3097	warn "reloaded";
2524	};	3098	};
2525		3099
2526	our $RELOAD_WATCHER; # used only during reload	3100	our $RELOAD_WATCHER; # used only during reload
2527		3101
		3102	sub reload_perl() {
		3103	# doing reload synchronously and two reloads happen back-to-back,
		3104	# coro crashes during coro_state_free->destroy here.
		3105
		3106	$RELOAD_WATCHER ||= Event->timer (
		3107	reentrant => 0,
		3108	after => 0,
		3109	data => WF_AUTOCANCEL,
		3110	cb => sub {
		3111	do_reload_perl;
		3112	undef $RELOAD_WATCHER;
		3113	},
		3114	);
		3115	}
		3116
2528	register_command "reload" => sub {	3117	register_command "reload" => sub {
2529	my ($who, $arg) = @_;	3118	my ($who, $arg) = @_;
2530		3119
2531	if ($who->flag (FLAG_WIZ)) {	3120	if ($who->flag (FLAG_WIZ)) {
2532	$who->message ("reloading server.");	3121	$who->message ("reloading server.");
2533		3122	async { reload_perl };
2534	# doing reload synchronously and two reloads happen back-to-back,
2535	# coro crashes during coro_state_free->destroy here.
2536
2537	$RELOAD_WATCHER ||= Event->timer (
2538	reentrant => 0,
2539	after => 0,
2540	data => WF_AUTOCANCEL,
2541	cb => sub {
2542	reload;
2543	undef $RELOAD_WATCHER;
2544	},
2545	);
2546	}	3123	}
2547	};	3124	};
2548		3125
2549	unshift @INC, $LIBDIR;	3126	unshift @INC, $LIBDIR;
2550		3127
2551	my $bug_warning = 0;	3128	my $bug_warning = 0;
2552		3129
		3130	our @WAIT_FOR_TICK;
		3131	our @WAIT_FOR_TICK_BEGIN;
		3132
		3133	sub wait_for_tick {
		3134	return unless $TICK_WATCHER->is_active;
		3135	return if $Coro::current == $Coro::main;
		3136
		3137	my $signal = new Coro::Signal;
		3138	push @WAIT_FOR_TICK, $signal;
		3139	$signal->wait;
		3140	}
		3141
		3142	sub wait_for_tick_begin {
		3143	return unless $TICK_WATCHER->is_active;
		3144	return if $Coro::current == $Coro::main;
		3145
		3146	my $signal = new Coro::Signal;
		3147	push @WAIT_FOR_TICK_BEGIN, $signal;
		3148	$signal->wait;
		3149	}
		3150
		3151	my $min = 1e6;#d#
		3152	my $avg = 10;
2553	$TICK_WATCHER = Event->timer (	3153	$TICK_WATCHER = Event->timer (
2554	reentrant => 0,	3154	reentrant => 0,
2555	parked => 1,	3155	parked => 1,
2556	prio => 0,	3156	prio => 0,
2557	at => $NEXT_TICK || $TICK,	3157	at => $NEXT_TICK || $TICK,
…		…
2561	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3161	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2562	unless ++$bug_warning > 10;	3162	unless ++$bug_warning > 10;
2563	return;	3163	return;
2564	}	3164	}
2565		3165
2566	$NOW = Event::time;	3166	$NOW = $tick_start = Event::time;
2567		3167
2568	cf::server_tick; # one server iteration	3168	cf::server_tick; # one server iteration
		3169
		3170	0 && sync_job {#d#
		3171	for(1..10) {
		3172	my $t = Event::time;
		3173	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3174	or die;
		3175
		3176	$map->width (50);
		3177	$map->height (50);
		3178	$map->alloc;
		3179	$map->_load_objects ("/tmp/x.map", 1);
		3180	my $t = Event::time - $t;
		3181
		3182	#next unless $t < 0.0013;#d#
		3183	if ($t < $min) {
		3184	$min = $t;
		3185	}
		3186	$avg = $avg * 0.99 + $t * 0.01;
		3187	}
		3188	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3189	exit 0;
		3190	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3191	};
		3192
2569	$RUNTIME += $TICK;	3193	$RUNTIME += $TICK;
2570	$NEXT_TICK += $TICK;	3194	$NEXT_TICK += $TICK;
2571		3195
2572	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3196	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2573	$NEXT_RUNTIME_WRITE = $NOW + 10;	3197	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2575	write_runtime	3199	write_runtime
2576	or warn "ERROR: unable to write runtime file: $!";	3200	or warn "ERROR: unable to write runtime file: $!";
2577	};	3201	};
2578	}	3202	}
2579		3203
2580	$WAIT_FOR_TICK->broadcast;
2581	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2582
2583	# my $AFTER = Event::time;	3204	# my $AFTER = Event::time;
2584	# warn $AFTER - $NOW;#d#	3205	# warn $AFTER - $NOW;#d#
2585		3206
		3207	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3208	$sig->send;
		3209	}
		3210	while (my $sig = shift @WAIT_FOR_TICK) {
		3211	$sig->send;
		3212	}
		3213
		3214	$NOW = Event::time;
		3215
2586	# if we are delayed by four ticks or more, skip them all	3216	# if we are delayed by four ticks or more, skip them all
2587	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2588		3218
2589	$TICK_WATCHER->at ($NEXT_TICK);	3219	$TICK_WATCHER->at ($NEXT_TICK);
2590	$TICK_WATCHER->start;	3220	$TICK_WATCHER->start;
		3221
		3222	$LOAD = ($NOW - $tick_start) / $TICK;
		3223	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3224
		3225	_post_tick;
		3226
		3227
2591	},	3228	},
2592	);	3229	);
2593		3230
2594	{	3231	{
2595	BDB::max_poll_time $TICK * 0.1;	3232	BDB::max_poll_time $TICK * 0.1;
…		…
2623		3260
2624	cf::sync_job {	3261	cf::sync_job {
2625	eval {	3262	eval {
2626	BDB::db_env_open	3263	BDB::db_env_open
2627	$DB_ENV,	3264	$DB_ENV,
2628	$BDB_ENV_DIR,	3265	$BDBDIR,
2629	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3266	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2630	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3267	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2631	0666;	3268	0666;
2632		3269
2633	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3270	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2634		3271
2635	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3272	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2636	$DB_ENV->set_lk_detect;	3273	$DB_ENV->set_lk_detect;
2637	};	3274	};
2638		3275
…		…
2654	prio => 6,	3291	prio => 6,
2655	cb => \&IO::AIO::poll_cb,	3292	cb => \&IO::AIO::poll_cb,
2656	);	3293	);
2657	}	3294	}
2658		3295
		3296	my $_log_backtrace;
		3297
		3298	sub _log_backtrace {
		3299	my ($msg, @addr) = @_;
		3300
		3301	$msg =~ s/\n//;
		3302
		3303	# limit the # of concurrent backtraces
		3304	if ($_log_backtrace < 2) {
		3305	++$_log_backtrace;
		3306	async {
		3307	my @bt = fork_call {
		3308	@addr = map { sprintf "%x", $_ } @addr;
		3309	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3310	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3311	or die "addr2line: $!";
		3312
		3313	my @funcs;
		3314	my @res = <$fh>;
		3315	chomp for @res;
		3316	while (@res) {
		3317	my ($func, $line) = splice @res, 0, 2, ();
		3318	push @funcs, "[$func] $line";
		3319	}
		3320
		3321	@funcs
		3322	};
		3323
		3324	LOG llevInfo, "[ABT] $msg\n";
		3325	LOG llevInfo, "[ABT] $_\n" for @bt;
		3326	--$_log_backtrace;
		3327	};
		3328	} else {
		3329	LOG llevInfo, "[ABT] $msg\n";
		3330	LOG llevInfo, "[ABT] [suppressed]\n";
		3331	}
		3332	}
		3333
		3334	# load additional modules
		3335	use cf::pod;
		3336
2659	END { cf::emergency_save }	3337	END { cf::emergency_save }
2660		3338
2661	1	3339	1
2662		3340

Diff Legend

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