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.216 by root, Thu Feb 15 14:30:21 2007 UTC vs.
Revision 1.305 by root, Thu Jul 12 08:40:14 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
		60	our $RELOAD; # number of reloads so far
48	our @EVENT;	61	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		62
51	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(!)
52	our $TICK_WATCHER;	76	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	79	our $NEXT_TICK;
56	our $NOW;	80	our $NOW;
…		…
65	our $RUNTIME;	89	our $RUNTIME;
66		90
67	our %PLAYER; # all users	91	our %PLAYER; # all users
68	our %MAP; # all maps	92	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	93	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		94
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	102	binmode STDOUT;
80	binmode STDERR;	103	binmode STDERR;
81		104
82	# read virtual server time, if available	105	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
87	}	110	}
88		111
89	mkdir cf::localdir;	112	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	113	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		114
96	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
97		116
98	sub cf::map::normalise;	117	sub cf::map::normalise;
99		118
…		…
110	=item $cf::RUNTIME	129	=item $cf::RUNTIME
111		130
112	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
113	every server tick.	132	every server tick.
114		133
115	=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
116		137
117	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		142
120	=item $cf::NOW	143	=item $cf::NOW
121		144
122	The time of the last (current) server tick.	145	The time of the last (current) server tick.
123		146
124	=item $cf::TICK	147	=item $cf::TICK
125		148
126	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.
127		160
128	=item %cf::CFG	161	=item %cf::CFG
129		162
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	164	from wherever your confdir points to.
132		165
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		167
135	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
136	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
137	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.
138	window of cpu time available, or simply to synchronise to the server tick.
139		171
140	=back	172	=back
141		173
142	=cut	174	=cut
143		175
144	BEGIN {	176	BEGIN {
145	*CORE::GLOBAL::warn = sub {	177	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	178	my $msg = join "", @_;
147	utf8::encode $msg;
148		179
149	$msg .= "\n"	180	$msg .= "\n"
150	unless $msg =~ /\n$/;	181	unless $msg =~ /\n$/;
151		182
		183	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		184
		185	utf8::encode $msg;
152	LOG llevError, $msg;	186	LOG llevError, $msg;
153	};	187	};
154	}	188	}
155		189
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	190	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	191	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	192	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	193	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		197
163	# 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
164	# within the Safe compartment.	199	# within the Safe compartment.
165	for my $pkg (qw(	200	for my $pkg (qw(
166	cf::global cf::attachable	201	cf::global cf::attachable
…		…
174	}	209	}
175		210
176	$Event::DIED = sub {	211	$Event::DIED = sub {
177	warn "error in event callback: @_";	212	warn "error in event callback: @_";
178	};	213	};
		214
		215	#############################################################################
179		216
180	=head2 UTILITY FUNCTIONS	217	=head2 UTILITY FUNCTIONS
181		218
182	=over 4	219	=over 4
183		220
…		…
202	$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;
203	$d	240	$d
204	} || "[unable to dump $_[0]: '$@']";	241	} || "[unable to dump $_[0]: '$@']";
205	}	242	}
206		243
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
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->utf8->max_size (1e6); # accept ~1mb max
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($) {
…		…
266		298
267	Coro::guard {	299	Coro::guard {
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	}
		303	}
		304
		305	sub lock_active($) {
		306	my ($key) = @_;
		307
		308	! ! $LOCK{$key}
271	}	309	}
272		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
…		…
290		328
291	BEGIN { *async = \&Coro::async_pool }	329	BEGIN { *async = \&Coro::async_pool }
292		330
293	=item cf::sync_job { BLOCK }	331	=item cf::sync_job { BLOCK }
294		332
295	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)
296	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
297	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.
298		337
299	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
300	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
301	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
302	fast or be very important.	341	fast or be very important.
…		…
305		344
306	sub sync_job(&) {	345	sub sync_job(&) {
307	my ($job) = @_;	346	my ($job) = @_;
308		347
309	if ($Coro::current == $Coro::main) {	348	if ($Coro::current == $Coro::main) {
		349	my $time = Event::time;
		350
310	# this is the main coro, too bad, we have to block	351	# this is the main coro, too bad, we have to block
311	# till the operation succeeds, freezing the server :/	352	# till the operation succeeds, freezing the server :/
312		353
313	# TODO: use suspend/resume instead	354	# TODO: use suspend/resume instead
314	# (but this is cancel-safe)	355	# (but this is cancel-safe)
…		…
325		366
326	while ($busy) {	367	while ($busy) {
327	Coro::cede or Event::one_event;	368	Coro::cede or Event::one_event;
328	}	369	}
329		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
330	wantarray ? @res : $res[0]	378	wantarray ? @res : $res[0]
331	} else {	379	} else {
332	# we are in another coroutine, how wonderful, everything just works	380	# we are in another coroutine, how wonderful, everything just works
333		381
334	$job->()	382	$job->()
…		…
353	$EXT_CORO{$coro+0} = $coro;	401	$EXT_CORO{$coro+0} = $coro;
354		402
355	$coro	403	$coro
356	}	404	}
357		405
358	sub write_runtime {	406	=item fork_call { }, $args
359	my $runtime = cf::localdir . "/runtime";
360		407
361	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	408	Executes the given code block with the given arguments in a seperate
362	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.
363		412
364	my $value = $cf::RUNTIME + 90 + 10;	413	=cut
365	# 10 is the runtime save interval, for a monotonic clock
366	# 60 allows for the watchdog to kill the server.
367		414
368	(aio_write $fh, 0, (length $value), $value, 0) <= 0	415	sub _store_scalar {
369	and return;	416	open my $fh, ">", \my $buf
370		417	or die "fork_call: cannot open fh-to-buf in child : $!";
371	# always fsync - this file is important	418	Storable::store_fd $_[0], $fh;
372	aio_fsync $fh
373	and return;
374
375	close $fh	419	close $fh;
376	or return;
377		420
378	aio_rename "$runtime~", $runtime	421	$buf
379	and return;	422	}
380		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;
381	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 });
382	}	593	}
383		594
384	=back	595	=back
385		596
386	=cut	597	=cut
…		…
393	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")
394	to it. All such attachable objects support the following methods.	605	to it. All such attachable objects support the following methods.
395		606
396	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>
397	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
398	crossfire+).	609	Crossfire TRT).
399		610
400	=over 4	611	=over 4
401		612
402	=item $attachable->attach ($attachment, key => $value...)	613	=item $attachable->attach ($attachment, key => $value...)
403		614
…		…
566	$registry = $CB_TYPE[$object_type] ||= [];	777	$registry = $CB_TYPE[$object_type] ||= [];
567		778
568	} elsif ($type eq "subtype") {	779	} elsif ($type eq "subtype") {
569	defined $object_type or Carp::croak "subtype specified without type";	780	defined $object_type or Carp::croak "subtype specified without type";
570	my $object_subtype = shift @arg;	781	my $object_subtype = shift @arg;
571	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	782	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
572		783
573	} elsif ($type eq "package") {	784	} elsif ($type eq "package") {
574	my $pkg = shift @arg;	785	my $pkg = shift @arg;
575		786
576	while (my ($name, $id) = each %cb_id) {	787	while (my ($name, $id) = each %cb_id) {
…		…
605	_attach $registry, $klass, @attach;	816	_attach $registry, $klass, @attach;
606	}	817	}
607		818
608	$obj->{$name} = \%arg;	819	$obj->{$name} = \%arg;
609	} else {	820	} else {
610	warn "object uses attachment '$name' that is not available, postponing.\n";	821	warn "object uses attachment '$name' which is not available, postponing.\n";
611	}	822	}
612		823
613	$obj->{_attachment}{$name} = undef;	824	$obj->{_attachment}{$name} = undef;
614	}	825	}
615		826
…		…
617	if (ref $_[0]) {	828	if (ref $_[0]) {
618	_object_attach @_;	829	_object_attach @_;
619	} else {	830	} else {
620	_attach shift->_attach_registry, @_;	831	_attach shift->_attach_registry, @_;
621	}	832	}
		833	_recalc_want;
622	};	834	};
623		835
624	# all those should be optimised	836	# all those should be optimised
625	sub cf::attachable::detach {	837	sub cf::attachable::detach {
626	my ($obj, $name) = @_;	838	my ($obj, $name) = @_;
…		…
629	delete $obj->{_attachment}{$name};	841	delete $obj->{_attachment}{$name};
630	reattach ($obj);	842	reattach ($obj);
631	} else {	843	} else {
632	Carp::croak "cannot, currently, detach class attachments";	844	Carp::croak "cannot, currently, detach class attachments";
633	}	845	}
		846	_recalc_want;
634	};	847	};
635		848
636	sub cf::attachable::attached {	849	sub cf::attachable::attached {
637	my ($obj, $name) = @_;	850	my ($obj, $name) = @_;
638		851
…		…
811	or return;	1024	or return;
812	$av = eval { (Storable::thaw $av)->{objs} };	1025	$av = eval { (Storable::thaw $av)->{objs} };
813	}	1026	}
814		1027
815	warn sprintf "loading %s (%d)\n",	1028	warn sprintf "loading %s (%d)\n",
816	$filename, length $data, scalar @{$av || []};#d#	1029	$filename, length $data, scalar @{$av || []};
817	return ($data, $av);	1030	return ($data, $av);
818	}	1031	}
		1032
		1033	=head2 COMMAND CALLBACKS
		1034
		1035	=over 4
		1036
		1037	=cut
819		1038
820	#############################################################################	1039	#############################################################################
821	# command handling &c	1040	# command handling &c
822		1041
823	=item cf::register_command $name => \&callback($ob,$args);	1042	=item cf::register_command $name => \&callback($ob,$args);
…		…
836	push @{ $COMMAND{$name} }, [$caller, $cb];	1055	push @{ $COMMAND{$name} }, [$caller, $cb];
837	}	1056	}
838		1057
839	=item cf::register_extcmd $name => \&callback($pl,$packet);	1058	=item cf::register_extcmd $name => \&callback($pl,$packet);
840		1059
841	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.
842		1065
843	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
844	called.	1067	called.
845		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
846	=cut	1080	=cut
847		1081
848	sub register_extcmd {	1082	sub register_extcmd {
849	my ($name, $cb) = @_;	1083	my ($name, $cb) = @_;
850		1084
851	$EXTCMD{$name} = $cb;	1085	$EXTCMD{$name} = $cb;
		1086	}
		1087
		1088	sub register_exticmd {
		1089	my ($name, $cb) = @_;
		1090
		1091	$EXTICMD{$name} = $cb;
852	}	1092	}
853		1093
854	cf::player->attach (	1094	cf::player->attach (
855	on_command => sub {	1095	on_command => sub {
856	my ($pl, $name, $params) = @_;	1096	my ($pl, $name, $params) = @_;
…		…
865	cf::override;	1105	cf::override;
866	},	1106	},
867	on_extcmd => sub {	1107	on_extcmd => sub {
868	my ($pl, $buf) = @_;	1108	my ($pl, $buf) = @_;
869		1109
870	my $msg = eval { from_json $buf };	1110	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871		1111
872	if (ref $msg) {	1112	if (ref $msg) {
873	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1113	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
874	if (my %reply = $cb->($pl, $msg)) {	1114	if (my %reply = $cb->($pl, $msg)) {
875	$pl->ext_reply ($msg->{msgid}, %reply);	1115	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
881		1121
882	cf::override;	1122	cf::override;
883	},	1123	},
884	);	1124	);
885		1125
886	sub load_extension {
887	my ($path) = @_;
888
889	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
890	my $base = $1;
891	my $pkg = $1;
892	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "ext::$pkg";
894
895	warn "... loading '$path' into '$pkg'\n";
896
897	open my $fh, "<:utf8", $path
898	or die "$path: $!";
899
900	my $source =
901	"package $pkg; use strict; use utf8;\n"
902	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })
904	. "\n};\n1";
905
906	unless (eval $source) {
907	my $msg = $@ ? "$path: $@\n"
908	: "extension disabled.\n";
909	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910	warn $@;
911	warn "mandatory extension failed to load, exiting.\n";
912	exit 1;
913	}
914	die $@;
915	}
916
917	push @EXTS, $pkg;
918	}
919
920	sub load_extensions {	1126	sub load_extensions {
		1127	cf::sync_job {
		1128	my %todo;
		1129
921	for my $ext (<$LIBDIR/*.ext>) {	1130	for my $path (<$LIBDIR/*.ext>) {
922	next unless -r $ext;	1131	next unless -r $path;
923	eval {	1132
924	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;
925	1	1190	}
926	} or warn "$ext not loaded: $@";	1191
		1192	skip:
		1193	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1194	unless $progress;
		1195	}
927	}	1196	};
928	}	1197	}
929		1198
930	#############################################################################	1199	#############################################################################
931		1200
		1201	=back
		1202
932	=head2 CORE EXTENSIONS	1203	=head2 CORE EXTENSIONS
933		1204
934	Functions and methods that extend core crossfire objects.	1205	Functions and methods that extend core crossfire objects.
935		1206
936	=cut	1207	=cut
…		…
948	Returns the given player object, loading it if necessary (might block).	1219	Returns the given player object, loading it if necessary (might block).
949		1220
950	=cut	1221	=cut
951		1222
952	sub playerdir($) {	1223	sub playerdir($) {
953	cf::localdir	1224	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1225	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1226	}
959		1227
960	sub path($) {	1228	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1229	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1230
963	(playerdir $login) . "/$login.pl"	1231	(playerdir $login) . "/playerdata"
964	}	1232	}
965		1233
966	sub find_active($) {	1234	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1235	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1236	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1249	my $login = $_[0];
982		1250
983	my $guard = cf::lock_acquire "user_find:$login";	1251	my $guard = cf::lock_acquire "user_find:$login";
984		1252
985	$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
986	my $pl = load_pl path $login	1261	my $pl = load_pl path $login
987	or return;	1262	or return;
988	$cf::PLAYER{$login} = $pl	1263	$cf::PLAYER{$login} = $pl
989	}	1264	}
990	}	1265	}
…		…
1027		1302
1028	=cut	1303	=cut
1029		1304
1030	sub quit_character {	1305	sub quit_character {
1031	my ($pl) = @_;	1306	my ($pl) = @_;
		1307
		1308	my $name = $pl->ob->name;
1032		1309
1033	$pl->{deny_save} = 1;	1310	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1311	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1312
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1313	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1318	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1319	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1320	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1321	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1322	$pl->destroy;
		1323
		1324	my $prefix = qr<^~\Q$name\E/>;
		1325
		1326	# nuke player maps
		1327	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1328
1046	IO::AIO::aio_rmtree $temp;	1329	IO::AIO::aio_rmtree $temp;
		1330	}
		1331
		1332	=item $pl->kick
		1333
		1334	Kicks a player out of the game. This destroys the connection.
		1335
		1336	=cut
		1337
		1338	sub kick {
		1339	my ($pl, $kicker) = @_;
		1340
		1341	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1342	$pl->killer ("kicked");
		1343	$pl->ns->destroy;
1047	}	1344	}
1048		1345
1049	=item cf::player::list_logins	1346	=item cf::player::list_logins
1050		1347
1051	Returns am arrayref of all valid playernames in the system, can take a	1348	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1349	while and may block, so not sync_job-capable, ever.
1053		1350
1054	=cut	1351	=cut
1055		1352
1056	sub list_logins {	1353	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1354	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1355	or return [];
1059		1356
1060	my @logins;	1357	my @logins;
1061		1358
1062	for my $login (@$dirs) {	1359	for my $login (@$dirs) {
…		…
1097	}	1394	}
1098		1395
1099	\@paths	1396	\@paths
1100	}	1397	}
1101		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
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1449	=item $player->ext_reply ($msgid, %msg)
1103		1450
1104	Sends an ext reply to the player.	1451	Sends an ext reply to the player.
1105		1452
1106	=cut	1453	=cut
1107		1454
1108	sub ext_reply($$$%) {	1455	sub ext_reply($$%) {
1109	my ($self, $id, %msg) = @_;	1456	my ($self, $id, %msg) = @_;
1110		1457
1111	$msg{msgid} = $id;	1458	$msg{msgid} = $id;
1112		1459	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1113	$self->send ("ext " . cf::to_json \%msg);
1114	}	1460	}
1115		1461
1116	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	}
1117		1502
1118	=back	1503	=back
1119
1120		1504
1121	=head3 cf::map	1505	=head3 cf::map
1122		1506
1123	=over 4	1507	=over 4
1124		1508
…		…
1179	my ($self, $merge) = @_;	1563	my ($self, $merge) = @_;
1180		1564
1181	# we have to keep some variables in memory intact	1565	# we have to keep some variables in memory intact
1182	local $self->{path};	1566	local $self->{path};
1183	local $self->{load_path};	1567	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1568
1187	$self->SUPER::thawer_merge ($merge);	1569	$self->SUPER::thawer_merge ($merge);
1188	}	1570	}
1189		1571
1190	sub normalise {	1572	sub normalise {
…		…
1262		1644
1263	# the original (read-only) location	1645	# the original (read-only) location
1264	sub load_path {	1646	sub load_path {
1265	my ($self) = @_;	1647	my ($self) = @_;
1266		1648
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1649	"$MAPDIR/$self->{path}.map"
1268	}	1650	}
1269		1651
1270	# the temporary/swap location	1652	# the temporary/swap location
1271	sub save_path {	1653	sub save_path {
1272	my ($self) = @_;	1654	my ($self) = @_;
1273		1655
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1656	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1657	"$TMPDIR/$path.map"
1276	}	1658	}
1277		1659
1278	# the unique path, undef == no special unique path	1660	# the unique path, undef == no special unique path
1279	sub uniq_path {	1661	sub uniq_path {
1280	my ($self) = @_;	1662	my ($self) = @_;
1281		1663
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1664	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1665	"$UNIQUEDIR/$path"
1284	}	1666	}
1285		1667
1286	# and all this just because we cannot iterate over	1668	# and all this just because we cannot iterate over
1287	# all maps in C++...	1669	# all maps in C++...
1288	sub change_all_map_light {	1670	sub change_all_map_light {
1289	my ($change) = @_;	1671	my ($change) = @_;
1290		1672
1291	$_->change_map_light ($change)	1673	$_->change_map_light ($change)
1292	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;
1293	}	1683	}
1294		1684
1295	sub unlink_save {	1685	sub unlink_save {
1296	my ($self) = @_;	1686	my ($self) = @_;
1297		1687
…		…
1355	$self->load_header_orig	1745	$self->load_header_orig
1356	or return;	1746	or return;
1357	$self->prepare_orig;	1747	$self->prepare_orig;
1358	}	1748	}
1359		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
1360	1	1756	1
1361	}	1757	}
1362		1758
1363	sub find;	1759	sub find;
1364	sub find {	1760	sub find {
…		…
1376	$map->{last_save} = $cf::RUNTIME;	1772	$map->{last_save} = $cf::RUNTIME;
1377		1773
1378	$map->load_header	1774	$map->load_header
1379	or return;	1775	or return;
1380		1776
1381	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1777	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1382	# doing this can freeze the server in a sync job, obviously	1778	# doing this can freeze the server in a sync job, obviously
1383	#$cf::WAIT_FOR_TICK->wait;	1779	#$cf::WAIT_FOR_TICK->wait;
1384	$map->reset;	1780	$map->reset;
1385	undef $guard;	1781	undef $guard;
1386	return find $path;	1782	return find $path;
…		…
1397	my ($self) = @_;	1793	my ($self) = @_;
1398		1794
1399	local $self->{deny_reset} = 1; # loading can take a long time	1795	local $self->{deny_reset} = 1; # loading can take a long time
1400		1796
1401	my $path = $self->{path};	1797	my $path = $self->{path};
		1798
		1799	{
1402	my $guard = cf::lock_acquire "map_load:$path";	1800	my $guard = cf::lock_acquire "map_load:$path";
1403		1801
1404	return if $self->in_memory != cf::MAP_SWAPPED;	1802	return if $self->in_memory != cf::MAP_SWAPPED;
1405		1803
1406	$self->in_memory (cf::MAP_LOADING);	1804	$self->in_memory (cf::MAP_LOADING);
1407		1805
1408	$self->alloc;	1806	$self->alloc;
1409		1807
1410	$self->pre_load;	1808	$self->pre_load;
1411
1412	$self->_load_objects ($self->{load_path}, 1)
1413	or return;
1414
1415	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1416	if delete $self->{load_original};
1417
1418	if (my $uniq = $self->uniq_path) {
1419	utf8::encode $uniq;
1420	if (aio_open $uniq, O_RDONLY, 0) {
1421	$self->clear_unique_items;
1422	$self->_load_objects ($uniq, 0);
1423	}
1424	}
1425
1426	Coro::cede;
1427
1428	# now do the right thing for maps
1429	$self->link_multipart_objects;
1430
1431	unless ($self->{deny_activate}) {
1432	$self->decay_objects;
1433	$self->fix_auto_apply;
1434	$self->update_buttons;
1435	Coro::cede;	1809	Coro::cede;
1436	$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;
1437	$self->difficulty ($self->estimate_difficulty)	1828	$self->difficulty ($self->estimate_difficulty)
1438	unless $self->difficulty;	1829	unless $self->difficulty;
1439	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;
1440	$self->activate;	1839	$self->activate;
		1840	}
		1841
		1842	$self->in_memory (cf::MAP_IN_MEMORY);
1441	}	1843	}
1442		1844
1443	$self->post_load;	1845	$self->post_load;
1444
1445	$self->in_memory (cf::MAP_IN_MEMORY);
1446	}	1846	}
1447		1847
1448	sub customise_for {	1848	sub customise_for {
1449	my ($self, $ob) = @_;	1849	my ($self, $ob) = @_;
1450		1850
1451	return find "~" . $ob->name . "/" . $self->{path}	1851	return find "~" . $ob->name . "/" . $self->{path}
1452	if $self->per_player;	1852	if $self->per_player;
		1853
		1854	# return find "?party/" . $ob->name . "/" . $self->{path}
		1855	# if $self->per_party;
1453		1856
1454	$self	1857	$self
1455	}	1858	}
1456		1859
1457	# 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
…		…
1568		1971
1569	sub reset_at {	1972	sub reset_at {
1570	my ($self) = @_;	1973	my ($self) = @_;
1571		1974
1572	# TODO: safety, remove and allow resettable per-player maps	1975	# TODO: safety, remove and allow resettable per-player maps
1573	return 1e99 if $self->isa ("ext::map_per_player");#d#
1574	return 1e99 if $self->{deny_reset};	1976	return 1e99 if $self->{deny_reset};
1575		1977
1576	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1978	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1577	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;
1578		1980
…		…
1589	my ($self) = @_;	1991	my ($self) = @_;
1590		1992
1591	my $lock = cf::lock_acquire "map_data:$self->{path}";	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1592		1994
1593	return if $self->players;	1995	return if $self->players;
1594	return if $self->isa ("ext::map_per_player");#d#
1595		1996
1596	warn "resetting map ", $self->path;#d#	1997	warn "resetting map ", $self->path;
1597		1998
1598	$self->in_memory (cf::MAP_SWAPPED);	1999	$self->in_memory (cf::MAP_SWAPPED);
1599		2000
1600	# need to save uniques path	2001	# need to save uniques path
1601	unless ($self->{deny_save}) {	2002	unless ($self->{deny_save}) {
…		…
1633	$cf::MAP{$self->path} = $self;	2034	$cf::MAP{$self->path} = $self;
1634		2035
1635	$self->reset; # polite request, might not happen	2036	$self->reset; # polite request, might not happen
1636	}	2037	}
1637		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
1638	=item cf::map::unique_maps	2075	=item cf::map::unique_maps
1639		2076
1640	Returns an arrayref of paths of all shared maps that have	2077	Returns an arrayref of paths of all shared maps that have
1641	instantiated unique items. May block.	2078	instantiated unique items. May block.
1642		2079
1643	=cut	2080	=cut
1644		2081
1645	sub unique_maps() {	2082	sub unique_maps() {
1646	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2083	[
1647	or return;	2084	map {
1648
1649	my @paths;
1650
1651	for (@$files) {
1652	utf8::decode $_;	2085	utf8::decode $_;
1653	next if /\.pst$/;	2086	/\.map$/
1654	next unless /^$PATH_SEP/o;	2087	? normalise $_
1655		2088	: ()
1656	push @paths, cf::map::normalise $_;	2089	} @{ aio_readdir $UNIQUEDIR or [] }
1657	}	2090	]
1658
1659	\@paths
1660	}	2091	}
1661		2092
1662	package cf;	2093	package cf;
1663		2094
1664	=back	2095	=back
…		…
1710		2141
1711	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2142	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1712		2143
1713	if ($self->{record_replies}) {	2144	if ($self->{record_replies}) {
1714	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2145	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2146
1715	} 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 {
1716	$msg = $npc->name . " says: $msg" if $npc;	2160	$msg = $npc->name . " says: $msg" if $npc;
1717	$self->message ($msg, $flags);	2161	$self->message ($msg, $flags);
		2162	}
1718	}	2163	}
1719	}	2164	}
1720		2165
1721	=item $player_object->may ("access")	2166	=item $player_object->may ("access")
1722		2167
…		…
1770	$self->deactivate_recursive;	2215	$self->deactivate_recursive;
1771		2216
1772	return if UNIVERSAL::isa $self->map, "ext::map_link";	2217	return if UNIVERSAL::isa $self->map, "ext::map_link";
1773		2218
1774	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2219	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1775	if $self->map;	2220	if $self->map && $self->map->{path} ne "{link}";
1776		2221
1777	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2222	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1778	}	2223	}
1779		2224
1780	sub cf::object::player::leave_link {	2225	sub cf::object::player::leave_link {
1781	my ($self, $map, $x, $y) = @_;	2226	my ($self, $map, $x, $y) = @_;
		2227
		2228	return unless $self->contr->active;
1782		2229
1783	my $link_pos = delete $self->{_link_pos};	2230	my $link_pos = delete $self->{_link_pos};
1784		2231
1785	unless ($map) {	2232	unless ($map) {
1786	# restore original map position	2233	# restore original map position
…		…
1809		2256
1810	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2257	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1811	$self->enter_map ($map, $x, $y);	2258	$self->enter_map ($map, $x, $y);
1812	}	2259	}
1813		2260
1814	cf::player->attach (
1815	on_logout => sub {
1816	my ($pl) = @_;
1817
1818	# abort map switching before logout
1819	if ($pl->ob->{_link_pos}) {
1820	cf::sync_job {
1821	$pl->ob->leave_link
1822	};
1823	}
1824	},
1825	on_login => sub {
1826	my ($pl) = @_;
1827
1828	# try to abort aborted map switching on player login :)
1829	# should happen only on crashes
1830	if ($pl->ob->{_link_pos}) {
1831	$pl->ob->enter_link;
1832	(async {
1833	$pl->ob->reply (undef,
1834	"There was an internal problem at your last logout, "
1835	. "the server will try to bring you to your intended destination in a second.",
1836	cf::NDI_RED);
1837	# we need this sleep as the login has a concurrent enter_exit running
1838	# and this sleep increases chances of the player not ending up in scorn
1839	Coro::Timer::sleep 1;
1840	$pl->ob->leave_link;
1841	})->prio (2);
1842	}
1843	},
1844	);
1845
1846	=item $player_object->goto ($path, $x, $y)	2261	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1847		2262
		2263	Moves the player to the given map-path and coordinates by first freezing
		2264	her, loading and preparing them map, calling the provided $check callback
		2265	that has to return the map if sucecssful, and then unfreezes the player on
		2266	the new (success) or old (failed) map position.
		2267
1848	=cut	2268	=cut
		2269
		2270	our $GOTOGEN;
1849		2271
1850	sub cf::object::player::goto {	2272	sub cf::object::player::goto {
1851	my ($self, $path, $x, $y) = @_;	2273	my ($self, $path, $x, $y, $check) = @_;
		2274
		2275	# do generation counting so two concurrent goto's will be executed in-order
		2276	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1852		2277
1853	$self->enter_link;	2278	$self->enter_link;
1854		2279
1855	(async {	2280	(async {
1856	my $map = eval {	2281	my $map = eval {
1857	my $map = cf::map::find $path;	2282	my $map = cf::map::find $path;
		2283
		2284	if ($map) {
1858	$map = $map->customise_for ($self) if $map;	2285	$map = $map->customise_for ($self);
		2286	$map = $check->($map) if $check && $map;
		2287	} else {
		2288	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2289	}
		2290
1859	$map	2291	$map
		2292	};
		2293
		2294	if ($@) {
		2295	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2296	LOG llevError | logBacktrace, Carp::longmess $@;
1860	} or	2297	}
1861	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1862		2298
		2299	if ($gen == $self->{_goto_generation}) {
		2300	delete $self->{_goto_generation};
1863	$self->leave_link ($map, $x, $y);	2301	$self->leave_link ($map, $x, $y);
		2302	}
1864	})->prio (1);	2303	})->prio (1);
1865	}	2304	}
1866		2305
1867	=item $player_object->enter_exit ($exit_object)	2306	=item $player_object->enter_exit ($exit_object)
1868		2307
…		…
1907		2346
1908	$rmp->{random_seed} ||= $exit->random_seed;	2347	$rmp->{random_seed} ||= $exit->random_seed;
1909		2348
1910	my $data = cf::to_json $rmp;	2349	my $data = cf::to_json $rmp;
1911	my $md5 = Digest::MD5::md5_hex $data;	2350	my $md5 = Digest::MD5::md5_hex $data;
1912	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2351	my $meta = "$RANDOMDIR/$md5.meta";
1913		2352
1914	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2353	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1915	aio_write $fh, 0, (length $data), $data, 0;	2354	aio_write $fh, 0, (length $data), $data, 0;
1916	undef $fh;	2355	undef $fh;
1917	aio_rename "$meta~", $meta;	2356	aio_rename "$meta~", $meta;
…		…
1926		2365
1927	return unless $self->type == cf::PLAYER;	2366	return unless $self->type == cf::PLAYER;
1928		2367
1929	if ($exit->slaying eq "/!") {	2368	if ($exit->slaying eq "/!") {
1930	#TODO: this should de-fi-ni-te-ly not be a sync-job	2369	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2370	# the problem is that $exit might not survive long enough
		2371	# so it needs to be done right now, right here
1931	cf::sync_job { prepare_random_map $exit };	2372	cf::sync_job { prepare_random_map $exit };
1932	}	2373	}
1933		2374
1934	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2375	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1935	my $hp = $exit->stats->hp;	2376	my $hp = $exit->stats->hp;
1936	my $sp = $exit->stats->sp;	2377	my $sp = $exit->stats->sp;
1937		2378
1938	$self->enter_link;	2379	$self->enter_link;
		2380
		2381	# if exit is damned, update players death & WoR home-position
		2382	$self->contr->savebed ($slaying, $hp, $sp)
		2383	if $exit->flag (FLAG_DAMNED);
1939		2384
1940	(async {	2385	(async {
1941	$self->deactivate_recursive; # just to be sure	2386	$self->deactivate_recursive; # just to be sure
1942	unless (eval {	2387	unless (eval {
1943	$self->goto ($slaying, $hp, $sp);	2388	$self->goto ($slaying, $hp, $sp);
1944		2389
1945	1;	2390	1;
1946	}) {	2391	}) {
1947	$self->message ("Something went wrong deep within the crossfire server. "	2392	$self->message ("Something went wrong deep within the crossfire server. "
1948	. "I'll try to bring you back to the map you were before. "	2393	. "I'll try to bring you back to the map you were before. "
1949	. "Please report this to the dungeon master!",	2394	. "Please report this to the dungeon master!",
1950	cf::NDI_UNIQUE | cf::NDI_RED);	2395	cf::NDI_UNIQUE | cf::NDI_RED);
1951		2396
1952	warn "ERROR in enter_exit: $@";	2397	warn "ERROR in enter_exit: $@";
1953	$self->leave_link;	2398	$self->leave_link;
1954	}	2399	}
1955	})->prio (1);	2400	})->prio (1);
…		…
1968		2413
1969	sub cf::client::send_drawinfo {	2414	sub cf::client::send_drawinfo {
1970	my ($self, $text, $flags) = @_;	2415	my ($self, $text, $flags) = @_;
1971		2416
1972	utf8::encode $text;	2417	utf8::encode $text;
1973	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2418	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1974	}	2419	}
1975		2420
		2421	=item $client->send_msg ($color, $type, $msg, [extra...])
		2422
		2423	Send a drawinfo or msg packet to the client, formatting the msg for the
		2424	client if neccessary. C<$type> should be a string identifying the type of
		2425	the message, with C<log> being the default. If C<$color> is negative, suppress
		2426	the message unless the client supports the msg packet.
		2427
		2428	=cut
		2429
		2430	sub cf::client::send_msg {
		2431	my ($self, $color, $type, $msg, @extra) = @_;
		2432
		2433	$msg = $self->pl->expand_cfpod ($msg);
		2434
		2435	return unless @extra || length $msg;
		2436
		2437	if ($self->can_msg) {
		2438	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2439	} else {
		2440	# replace some tags by gcfclient-compatible ones
		2441	for ($msg) {
		2442	1 while
		2443	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2444	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2445	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2446	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2447	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2448	}
		2449
		2450	if ($color >= 0) {
		2451	if (0 && $msg =~ /\[/) {
		2452	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2453	} else {
		2454	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2455	$self->send_packet ("drawinfo $color $msg")
		2456	}
		2457	}
		2458	}
		2459	}
		2460
		2461	=item $client->ext_event ($type, %msg)
		2462
		2463	Sends an ext event to the client.
		2464
		2465	=cut
		2466
		2467	sub cf::client::ext_event($$%) {
		2468	my ($self, $type, %msg) = @_;
		2469
		2470	return unless $self->extcmd;
		2471
		2472	$msg{msgtype} = "event_$type";
		2473	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2474	}
1976		2475
1977	=item $success = $client->query ($flags, "text", \&cb)	2476	=item $success = $client->query ($flags, "text", \&cb)
1978		2477
1979	Queues a query to the client, calling the given callback with	2478	Queues a query to the client, calling the given callback with
1980	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2479	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1981	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2480	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1982		2481
1983	Queries can fail, so check the return code. Or don't, as queries will become	2482	Queries can fail, so check the return code. Or don't, as queries will
1984	reliable at some point in the future.	2483	become reliable at some point in the future.
1985		2484
1986	=cut	2485	=cut
1987		2486
1988	sub cf::client::query {	2487	sub cf::client::query {
1989	my ($self, $flags, $text, $cb) = @_;	2488	my ($self, $flags, $text, $cb) = @_;
…		…
1997	utf8::encode $text;	2496	utf8::encode $text;
1998	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2497	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1999		2498
2000	$self->send_packet ($self->{query_queue}[0][0])	2499	$self->send_packet ($self->{query_queue}[0][0])
2001	if @{ $self->{query_queue} } == 1;	2500	if @{ $self->{query_queue} } == 1;
		2501
		2502	1
2002	}	2503	}
2003		2504
2004	cf::client->attach (	2505	cf::client->attach (
		2506	on_connect => sub {
		2507	my ($ns) = @_;
		2508
		2509	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2510	},
2005	on_reply => sub {	2511	on_reply => sub {
2006	my ($ns, $msg) = @_;	2512	my ($ns, $msg) = @_;
2007		2513
2008	# this weird shuffling is so that direct followup queries	2514	# this weird shuffling is so that direct followup queries
2009	# get handled first	2515	# get handled first
…		…
2021	} else {	2527	} else {
2022	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2528	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2023	}	2529	}
2024	}	2530	}
2025	},	2531	},
		2532	on_exticmd => sub {
		2533	my ($ns, $buf) = @_;
		2534
		2535	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2536
		2537	if (ref $msg) {
		2538	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2539	if (my %reply = $cb->($ns, $msg)) {
		2540	$reply{msgid} = $msg->{msgid};
		2541	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2542	}
		2543	}
		2544	} else {
		2545	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2546	}
		2547
		2548	cf::override;
		2549	},
2026	);	2550	);
2027		2551
2028	=item $client->async (\&cb)	2552	=item $client->async (\&cb)
2029		2553
2030	Create a new coroutine, running the specified callback. The coroutine will	2554	Create a new coroutine, running the specified callback. The coroutine will
…		…
2077		2601
2078	# here we export the classes and methods available to script code	2602	# here we export the classes and methods available to script code
2079		2603
2080	=pod	2604	=pod
2081		2605
2082	The following fucntions and emthods are available within a safe environment:	2606	The following functions and methods are available within a safe environment:
2083		2607
2084	cf::object contr pay_amount pay_player map	2608	cf::object
		2609	contr pay_amount pay_player map x y force_find force_add
		2610	insert remove
		2611
2085	cf::object::player player	2612	cf::object::player
2086	cf::player peaceful	2613	player
2087	cf::map trigger	2614
		2615	cf::player
		2616	peaceful
		2617
		2618	cf::map
		2619	trigger
2088		2620
2089	=cut	2621	=cut
2090		2622
2091	for (	2623	for (
2092	["cf::object" => qw(contr pay_amount pay_player map)],	2624	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2625	insert remove)],
2093	["cf::object::player" => qw(player)],	2626	["cf::object::player" => qw(player)],
2094	["cf::player" => qw(peaceful)],	2627	["cf::player" => qw(peaceful)],
2095	["cf::map" => qw(trigger)],	2628	["cf::map" => qw(trigger)],
2096	) {	2629	) {
2097	no strict 'refs';	2630	no strict 'refs';
…		…
2168	=back	2701	=back
2169		2702
2170	=cut	2703	=cut
2171		2704
2172	#############################################################################	2705	#############################################################################
2173
2174	=head2 EXTENSION DATABASE SUPPORT
2175
2176	Crossfire maintains a very simple database for extension use. It can
2177	currently store anything that can be serialised using Storable, which
2178	excludes objects.
2179
2180	The parameter C<$family> should best start with the name of the extension
2181	using it, it should be unique.
2182
2183	=over 4
2184
2185	=item $value = cf::db_get $family => $key
2186
2187	Returns a single value from the database.
2188
2189	=item cf::db_put $family => $key => $value
2190
2191	Stores the given C<$value> in the family.
2192
2193	=cut
2194
2195	our $DB;
2196
2197	sub db_init {
2198	unless ($DB) {
2199	$DB = BDB::db_create $DB_ENV;
2200
2201	cf::sync_job {
2202	eval {
2203	$DB->set_flags (BDB::CHKSUM);
2204
2205	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2206	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2207	cf::cleanup "db_open(db): $!" if $!;
2208	};
2209	cf::cleanup "db_open(db): $@" if $@;
2210	};
2211
2212	my $path = cf::localdir . "/database.pst";
2213	if (stat $path) {
2214	cf::sync_job {
2215	my $pst = Storable::retrieve $path;
2216
2217	cf::db_put (board => data => $pst->{board});
2218	cf::db_put (guildrules => data => $pst->{guildrules});
2219	cf::db_put (rent => balance => $pst->{rent}{balance});
2220	BDB::db_env_txn_checkpoint $DB_ENV;
2221
2222	unlink $path;
2223	};
2224	}
2225	}
2226	}
2227
2228	sub db_get($$) {
2229	my $key = "$_[0]/$_[1]";
2230
2231	cf::sync_job {
2232	BDB::db_get $DB, undef, $key, my $data;
2233
2234	$! ? ()
2235	: Compress::LZF::sthaw $data
2236	}
2237	}
2238
2239	sub db_put($$$) {
2240	BDB::dbreq_pri 4;
2241	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2242	}
2243
2244	#############################################################################
2245	# the server's init and main functions	2706	# the server's init and main functions
2246		2707
2247	sub load_resources {	2708	sub load_facedata($) {
2248	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2709	my ($path) = @_;
		2710
		2711	warn "loading facedata from $path\n";
		2712
		2713	my $facedata;
		2714	0 < aio_load $path, $facedata
		2715	or die "$path: $!";
		2716
		2717	$facedata = Coro::Storable::thaw $facedata;
		2718
		2719	$facedata->{version} == 2
		2720	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2721
		2722	{
		2723	my $faces = $facedata->{faceinfo};
		2724
		2725	while (my ($face, $info) = each %$faces) {
		2726	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2727	cf::face::set_visibility $idx, $info->{visibility};
		2728	cf::face::set_magicmap $idx, $info->{magicmap};
		2729	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2730	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2731
		2732	cf::cede_to_tick;
		2733	}
		2734
		2735	while (my ($face, $info) = each %$faces) {
		2736	next unless $info->{smooth};
		2737	my $idx = cf::face::find $face
		2738	or next;
		2739	if (my $smooth = cf::face::find $info->{smooth}) {
		2740	cf::face::set_smooth $idx, $smooth;
		2741	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2742	} else {
		2743	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2744	}
		2745
		2746	cf::cede_to_tick;
		2747	}
		2748	}
		2749
		2750	{
		2751	my $anims = $facedata->{animinfo};
		2752
		2753	while (my ($anim, $info) = each %$anims) {
		2754	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2755	cf::cede_to_tick;
		2756	}
		2757
		2758	cf::anim::invalidate_all; # d'oh
		2759	}
		2760
		2761	{
		2762	# TODO: for gcfclient pleasure, we should give resources
		2763	# that gcfclient doesn't grok a >10000 face index.
		2764	my $res = $facedata->{resource};
		2765	my $enc = JSON::XS->new->utf8->canonical;
		2766
		2767	while (my ($name, $info) = each %$res) {
		2768	my $meta = $enc->encode ({
		2769	name => $name,
		2770	type => $info->{type},
		2771	copyright => $info->{copyright}, #TODO#
		2772	});
		2773	my $data = pack "(w/a*)*", $meta, $info->{data};
		2774	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2775
		2776	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2777	cf::face::set_type $idx, 1;
		2778	cf::face::set_data $idx, 0, $data, $chk;
		2779
		2780	cf::cede_to_tick;
		2781	}
		2782	}
		2783
		2784	1
		2785	}
		2786
		2787	sub reload_regions {
		2788	load_resource_file "$MAPDIR/regions"
2249	or die "unable to load regions file\n";#d#	2789	or die "unable to load regions file\n";
		2790
		2791	for (cf::region::list) {
		2792	$_->{match} = qr/$_->{match}/
		2793	if exists $_->{match};
		2794	}
		2795	}
		2796
		2797	sub reload_facedata {
		2798	load_facedata "$DATADIR/facedata"
		2799	or die "unable to load facedata\n";
		2800	}
		2801
		2802	sub reload_archetypes {
		2803	load_resource_file "$DATADIR/archetypes"
		2804	or die "unable to load archetypes\n";
		2805	#d# NEED to laod twice to resolve forward references
		2806	# this really needs to be done in an extra post-pass
		2807	# (which needs to be synchronous, so solve it differently)
		2808	load_resource_file "$DATADIR/archetypes"
		2809	or die "unable to load archetypes\n";
		2810	}
		2811
		2812	sub reload_treasures {
		2813	load_resource_file "$DATADIR/treasures"
		2814	or die "unable to load treasurelists\n";
		2815	}
		2816
		2817	sub reload_resources {
		2818	warn "reloading resource files...\n";
		2819
		2820	reload_regions;
		2821	reload_facedata;
		2822	#reload_archetypes;#d#
		2823	reload_archetypes;
		2824	reload_treasures;
		2825
		2826	warn "finished reloading resource files\n";
		2827	}
		2828
		2829	sub init {
		2830	reload_resources;
2250	}	2831	}
2251		2832
2252	sub cfg_load {	2833	sub cfg_load {
2253	open my $fh, "<:utf8", cf::confdir . "/config"	2834	open my $fh, "<:utf8", "$CONFDIR/config"
2254	or return;	2835	or return;
2255		2836
2256	local $/;	2837	local $/;
2257	*CFG = YAML::Syck::Load <$fh>;	2838	*CFG = YAML::Syck::Load <$fh>;
2258		2839
…		…
2266	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2847	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2267	and die "WARNING: m(un)lockall failed: $!\n";	2848	and die "WARNING: m(un)lockall failed: $!\n";
2268	};	2849	};
2269	warn $@ if $@;	2850	warn $@ if $@;
2270	}	2851	}
2271	}
2272
2273	sub init {
2274	load_resources;
2275	}	2852	}
2276		2853
2277	sub main {	2854	sub main {
2278	# we must not ever block the main coroutine	2855	# we must not ever block the main coroutine
2279	local $Coro::idle = sub {	2856	local $Coro::idle = sub {
…		…
2307	},	2884	},
2308	);	2885	);
2309	}	2886	}
2310	}	2887	}
2311		2888
		2889	sub write_runtime {
		2890	my $runtime = "$LOCALDIR/runtime";
		2891
		2892	# first touch the runtime file to show we are still running:
		2893	# the fsync below can take a very very long time.
		2894
		2895	IO::AIO::aio_utime $runtime, undef, undef;
		2896
		2897	my $guard = cf::lock_acquire "write_runtime";
		2898
		2899	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2900	or return;
		2901
		2902	my $value = $cf::RUNTIME + 90 + 10;
		2903	# 10 is the runtime save interval, for a monotonic clock
		2904	# 60 allows for the watchdog to kill the server.
		2905
		2906	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2907	and return;
		2908
		2909	# always fsync - this file is important
		2910	aio_fsync $fh
		2911	and return;
		2912
		2913	# touch it again to show we are up-to-date
		2914	aio_utime $fh, undef, undef;
		2915
		2916	close $fh
		2917	or return;
		2918
		2919	aio_rename "$runtime~", $runtime
		2920	and return;
		2921
		2922	warn "runtime file written.\n";
		2923
		2924	1
		2925	}
		2926
2312	sub emergency_save() {	2927	sub emergency_save() {
2313	my $freeze_guard = cf::freeze_mainloop;	2928	my $freeze_guard = cf::freeze_mainloop;
2314		2929
2315	warn "enter emergency perl save\n";	2930	warn "enter emergency perl save\n";
2316		2931
…		…
2347		2962
2348	warn Carp::longmess "post_cleanup backtrace"	2963	warn Carp::longmess "post_cleanup backtrace"
2349	if $make_core;	2964	if $make_core;
2350	}	2965	}
2351		2966
2352	sub reload() {	2967	sub do_reload_perl() {
2353	# can/must only be called in main	2968	# can/must only be called in main
2354	if ($Coro::current != $Coro::main) {	2969	if ($Coro::current != $Coro::main) {
2355	warn "can only reload from main coroutine";	2970	warn "can only reload from main coroutine";
2356	return;	2971	return;
2357	}	2972	}
…		…
2382	Coro::cede;	2997	Coro::cede;
2383	last unless IO::AIO::nreqs || BDB::nreqs;	2998	last unless IO::AIO::nreqs || BDB::nreqs;
2384	warn "iterate...";	2999	warn "iterate...";
2385	}	3000	}
2386		3001
		3002	++$RELOAD;
		3003
2387	warn "cancelling all extension coros";	3004	warn "cancelling all extension coros";
2388	$_->cancel for values %EXT_CORO;	3005	$_->cancel for values %EXT_CORO;
2389	%EXT_CORO = ();	3006	%EXT_CORO = ();
2390		3007
2391	warn "removing commands";	3008	warn "removing commands";
2392	%COMMAND = ();	3009	%COMMAND = ();
2393		3010
2394	warn "removing ext commands";	3011	warn "removing ext/exti commands";
2395	%EXTCMD = ();	3012	%EXTCMD = ();
		3013	%EXTICMD = ();
2396		3014
2397	warn "unloading/nuking all extensions";	3015	warn "unloading/nuking all extensions";
2398	for my $pkg (@EXTS) {	3016	for my $pkg (@EXTS) {
2399	warn "... unloading $pkg";	3017	warn "... unloading $pkg";
2400		3018
…		…
2430	Symbol::delete_package "safe::$_"	3048	Symbol::delete_package "safe::$_"
2431	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3049	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2432		3050
2433	warn "unloading cf.pm \"a bit\"";	3051	warn "unloading cf.pm \"a bit\"";
2434	delete $INC{"cf.pm"};	3052	delete $INC{"cf.pm"};
		3053	delete $INC{"cf/pod.pm"};
2435		3054
2436	# don't, removes xs symbols, too,	3055	# don't, removes xs symbols, too,
2437	# and global variables created in xs	3056	# and global variables created in xs
2438	#Symbol::delete_package __PACKAGE__;	3057	#Symbol::delete_package __PACKAGE__;
2439		3058
…		…
2448		3067
2449	warn "loading extensions";	3068	warn "loading extensions";
2450	cf::load_extensions;	3069	cf::load_extensions;
2451		3070
2452	warn "reattaching attachments to objects/players";	3071	warn "reattaching attachments to objects/players";
2453	_global_reattach;	3072	_global_reattach; # objects, sockets
2454	warn "reattaching attachments to maps";	3073	warn "reattaching attachments to maps";
2455	reattach $_ for values %MAP;	3074	reattach $_ for values %MAP;
2456		3075	warn "reattaching attachments to players";
2457	warn "loading reloadable resources";	3076	reattach $_ for values %PLAYER;
2458	load_resources;
2459		3077
2460	warn "leaving sync_job";	3078	warn "leaving sync_job";
2461		3079
2462	1	3080	1
2463	} or do {	3081	} or do {
…		…
2469	warn "reloaded";	3087	warn "reloaded";
2470	};	3088	};
2471		3089
2472	our $RELOAD_WATCHER; # used only during reload	3090	our $RELOAD_WATCHER; # used only during reload
2473		3091
		3092	sub reload_perl() {
		3093	# doing reload synchronously and two reloads happen back-to-back,
		3094	# coro crashes during coro_state_free->destroy here.
		3095
		3096	$RELOAD_WATCHER ||= Event->timer (
		3097	reentrant => 0,
		3098	after => 0,
		3099	data => WF_AUTOCANCEL,
		3100	cb => sub {
		3101	do_reload_perl;
		3102	undef $RELOAD_WATCHER;
		3103	},
		3104	);
		3105	}
		3106
2474	register_command "reload" => sub {	3107	register_command "reload" => sub {
2475	my ($who, $arg) = @_;	3108	my ($who, $arg) = @_;
2476		3109
2477	if ($who->flag (FLAG_WIZ)) {	3110	if ($who->flag (FLAG_WIZ)) {
2478	$who->message ("reloading server.");	3111	$who->message ("reloading server.");
2479		3112	async { reload_perl };
2480	# doing reload synchronously and two reloads happen back-to-back,
2481	# coro crashes during coro_state_free->destroy here.
2482
2483	$RELOAD_WATCHER ||= Event->timer (
2484	reentrant => 0,
2485	after => 0,
2486	data => WF_AUTOCANCEL,
2487	cb => sub {
2488	reload;
2489	undef $RELOAD_WATCHER;
2490	},
2491	);
2492	}	3113	}
2493	};	3114	};
2494		3115
2495	unshift @INC, $LIBDIR;	3116	unshift @INC, $LIBDIR;
2496		3117
2497	my $bug_warning = 0;	3118	my $bug_warning = 0;
2498		3119
		3120	our @WAIT_FOR_TICK;
		3121	our @WAIT_FOR_TICK_BEGIN;
		3122
		3123	sub wait_for_tick {
		3124	return unless $TICK_WATCHER->is_active;
		3125	return if $Coro::current == $Coro::main;
		3126
		3127	my $signal = new Coro::Signal;
		3128	push @WAIT_FOR_TICK, $signal;
		3129	$signal->wait;
		3130	}
		3131
		3132	sub wait_for_tick_begin {
		3133	return unless $TICK_WATCHER->is_active;
		3134	return if $Coro::current == $Coro::main;
		3135
		3136	my $signal = new Coro::Signal;
		3137	push @WAIT_FOR_TICK_BEGIN, $signal;
		3138	$signal->wait;
		3139	}
		3140
		3141	my $min = 1e6;#d#
		3142	my $avg = 10;
2499	$TICK_WATCHER = Event->timer (	3143	$TICK_WATCHER = Event->timer (
2500	reentrant => 0,	3144	reentrant => 0,
2501	parked => 1,	3145	parked => 1,
2502	prio => 0,	3146	prio => 0,
2503	at => $NEXT_TICK || $TICK,	3147	at => $NEXT_TICK || $TICK,
…		…
2507	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3151	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508	unless ++$bug_warning > 10;	3152	unless ++$bug_warning > 10;
2509	return;	3153	return;
2510	}	3154	}
2511		3155
2512	$NOW = Event::time;	3156	$NOW = $tick_start = Event::time;
2513		3157
2514	cf::server_tick; # one server iteration	3158	cf::server_tick; # one server iteration
		3159
		3160	0 && sync_job {#d#
		3161	for(1..10) {
		3162	my $t = Event::time;
		3163	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3164	or die;
		3165
		3166	$map->width (50);
		3167	$map->height (50);
		3168	$map->alloc;
		3169	$map->_load_objects ("/tmp/x.map", 1);
		3170	my $t = Event::time - $t;
		3171
		3172	#next unless $t < 0.0013;#d#
		3173	if ($t < $min) {
		3174	$min = $t;
		3175	}
		3176	$avg = $avg * 0.99 + $t * 0.01;
		3177	}
		3178	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3179	exit 0;
		3180	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3181	};
		3182
2515	$RUNTIME += $TICK;	3183	$RUNTIME += $TICK;
2516	$NEXT_TICK += $TICK;	3184	$NEXT_TICK += $TICK;
2517		3185
2518	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3186	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519	$NEXT_RUNTIME_WRITE = $NOW + 10;	3187	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2521	write_runtime	3189	write_runtime
2522	or warn "ERROR: unable to write runtime file: $!";	3190	or warn "ERROR: unable to write runtime file: $!";
2523	};	3191	};
2524	}	3192	}
2525		3193
2526
2527	$WAIT_FOR_TICK->broadcast;
2528	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2529
2530	# my $AFTER = Event::time;	3194	# my $AFTER = Event::time;
2531	# warn $AFTER - $NOW;#d#	3195	# warn $AFTER - $NOW;#d#
2532		3196
		3197	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3198	$sig->send;
		3199	}
		3200	while (my $sig = shift @WAIT_FOR_TICK) {
		3201	$sig->send;
		3202	}
		3203
		3204	$NOW = Event::time;
		3205
2533	# if we are delayed by four ticks or more, skip them all	3206	# if we are delayed by four ticks or more, skip them all
2534	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3207	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2535		3208
2536	$TICK_WATCHER->at ($NEXT_TICK);	3209	$TICK_WATCHER->at ($NEXT_TICK);
2537	$TICK_WATCHER->start;	3210	$TICK_WATCHER->start;
		3211
		3212	$LOAD = ($NOW - $tick_start) / $TICK;
		3213	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3214
		3215	_post_tick;
		3216
		3217
2538	},	3218	},
2539	);	3219	);
2540		3220
2541	{	3221	{
2542	BDB::max_poll_time $TICK * 0.1;	3222	BDB::max_poll_time $TICK * 0.1;
…		…
2570		3250
2571	cf::sync_job {	3251	cf::sync_job {
2572	eval {	3252	eval {
2573	BDB::db_env_open	3253	BDB::db_env_open
2574	$DB_ENV,	3254	$DB_ENV,
2575	$BDB_ENV_DIR,	3255	$BDBDIR,
2576	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3256	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2577	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3257	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2578	0666;	3258	0666;
2579		3259
2580	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3260	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2581		3261
2582	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3262	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2583	$DB_ENV->set_lk_detect;	3263	$DB_ENV->set_lk_detect;
2584	};	3264	};
2585		3265
…		…
2601	prio => 6,	3281	prio => 6,
2602	cb => \&IO::AIO::poll_cb,	3282	cb => \&IO::AIO::poll_cb,
2603	);	3283	);
2604	}	3284	}
2605		3285
		3286	my $_log_backtrace;
		3287
		3288	sub _log_backtrace {
		3289	my ($msg, @addr) = @_;
		3290
		3291	$msg =~ s/\n//;
		3292
		3293	# limit the # of concurrent backtraces
		3294	if ($_log_backtrace < 2) {
		3295	++$_log_backtrace;
		3296	async {
		3297	my @bt = fork_call {
		3298	@addr = map { sprintf "%x", $_ } @addr;
		3299	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3300	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3301	or die "addr2line: $!";
		3302
		3303	my @funcs;
		3304	my @res = <$fh>;
		3305	chomp for @res;
		3306	while (@res) {
		3307	my ($func, $line) = splice @res, 0, 2, ();
		3308	push @funcs, "[$func] $line";
		3309	}
		3310
		3311	@funcs
		3312	};
		3313
		3314	LOG llevInfo, "[ABT] $msg\n";
		3315	LOG llevInfo, "[ABT] $_\n" for @bt;
		3316	--$_log_backtrace;
		3317	};
		3318	} else {
		3319	LOG llevInfo, "[ABT] $msg\n";
		3320	LOG llevInfo, "[ABT] [suppressed]\n";
		3321	}
		3322	}
		3323
		3324	# load additional modules
		3325	use cf::pod;
		3326
2606	END { cf::emergency_save }	3327	END { cf::emergency_save }
2607		3328
2608	1	3329	1
2609		3330

Diff Legend

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