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.219 by root, Sat Feb 17 03:19:44 2007 UTC vs.
Revision 1.303 by root, Wed Jul 11 15:57:31 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 $guard = cf::lock_acquire "write_runtime";
360		407
361	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.
362		412
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	413	=cut
364	or return;
365		414
366	my $value = $cf::RUNTIME + 90 + 10;	415	sub _store_scalar {
367	# 10 is the runtime save interval, for a monotonic clock	416	open my $fh, ">", \my $buf
368	# 60 allows for the watchdog to kill the server.	417	or die "fork_call: cannot open fh-to-buf in child : $!";
369		418	Storable::store_fd $_[0], $fh;
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
371	and return;
372
373	# always fsync - this file is important
374	aio_fsync $fh
375	and return;
376
377	close $fh	419	close $fh;
378	or return;
379		420
380	aio_rename "$runtime~", $runtime	421	$buf
381	and return;	422	}
382		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;
383	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 });
384	}	593	}
385		594
386	=back	595	=back
387		596
388	=cut	597	=cut
…		…
395	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")
396	to it. All such attachable objects support the following methods.	605	to it. All such attachable objects support the following methods.
397		606
398	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>
399	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
400	crossfire+).	609	Crossfire TRT).
401		610
402	=over 4	611	=over 4
403		612
404	=item $attachable->attach ($attachment, key => $value...)	613	=item $attachable->attach ($attachment, key => $value...)
405		614
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	777	$registry = $CB_TYPE[$object_type] ||= [];
569		778
570	} elsif ($type eq "subtype") {	779	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	780	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	781	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	782	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		783
575	} elsif ($type eq "package") {	784	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	785	my $pkg = shift @arg;
577		786
578	while (my ($name, $id) = each %cb_id) {	787	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	816	_attach $registry, $klass, @attach;
608	}	817	}
609		818
610	$obj->{$name} = \%arg;	819	$obj->{$name} = \%arg;
611	} else {	820	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	821	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	822	}
614		823
615	$obj->{_attachment}{$name} = undef;	824	$obj->{_attachment}{$name} = undef;
616	}	825	}
617		826
…		…
619	if (ref $_[0]) {	828	if (ref $_[0]) {
620	_object_attach @_;	829	_object_attach @_;
621	} else {	830	} else {
622	_attach shift->_attach_registry, @_;	831	_attach shift->_attach_registry, @_;
623	}	832	}
		833	_recalc_want;
624	};	834	};
625		835
626	# all those should be optimised	836	# all those should be optimised
627	sub cf::attachable::detach {	837	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	838	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	841	delete $obj->{_attachment}{$name};
632	reattach ($obj);	842	reattach ($obj);
633	} else {	843	} else {
634	Carp::croak "cannot, currently, detach class attachments";	844	Carp::croak "cannot, currently, detach class attachments";
635	}	845	}
		846	_recalc_want;
636	};	847	};
637		848
638	sub cf::attachable::attached {	849	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	850	my ($obj, $name) = @_;
640		851
…		…
813	or return;	1024	or return;
814	$av = eval { (Storable::thaw $av)->{objs} };	1025	$av = eval { (Storable::thaw $av)->{objs} };
815	}	1026	}
816		1027
817	warn sprintf "loading %s (%d)\n",	1028	warn sprintf "loading %s (%d)\n",
818	$filename, length $data, scalar @{$av || []};#d#	1029	$filename, length $data, scalar @{$av || []};
819	return ($data, $av);	1030	return ($data, $av);
820	}	1031	}
		1032
		1033	=head2 COMMAND CALLBACKS
		1034
		1035	=over 4
		1036
		1037	=cut
821		1038
822	#############################################################################	1039	#############################################################################
823	# command handling &c	1040	# command handling &c
824		1041
825	=item cf::register_command $name => \&callback($ob,$args);	1042	=item cf::register_command $name => \&callback($ob,$args);
…		…
838	push @{ $COMMAND{$name} }, [$caller, $cb];	1055	push @{ $COMMAND{$name} }, [$caller, $cb];
839	}	1056	}
840		1057
841	=item cf::register_extcmd $name => \&callback($pl,$packet);	1058	=item cf::register_extcmd $name => \&callback($pl,$packet);
842		1059
843	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.
844		1065
845	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
846	called.	1067	called.
847		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
848	=cut	1080	=cut
849		1081
850	sub register_extcmd {	1082	sub register_extcmd {
851	my ($name, $cb) = @_;	1083	my ($name, $cb) = @_;
852		1084
853	$EXTCMD{$name} = $cb;	1085	$EXTCMD{$name} = $cb;
		1086	}
		1087
		1088	sub register_exticmd {
		1089	my ($name, $cb) = @_;
		1090
		1091	$EXTICMD{$name} = $cb;
854	}	1092	}
855		1093
856	cf::player->attach (	1094	cf::player->attach (
857	on_command => sub {	1095	on_command => sub {
858	my ($pl, $name, $params) = @_;	1096	my ($pl, $name, $params) = @_;
…		…
867	cf::override;	1105	cf::override;
868	},	1106	},
869	on_extcmd => sub {	1107	on_extcmd => sub {
870	my ($pl, $buf) = @_;	1108	my ($pl, $buf) = @_;
871		1109
872	my $msg = eval { from_json $buf };	1110	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873		1111
874	if (ref $msg) {	1112	if (ref $msg) {
875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1113	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876	if (my %reply = $cb->($pl, $msg)) {	1114	if (my %reply = $cb->($pl, $msg)) {
877	$pl->ext_reply ($msg->{msgid}, %reply);	1115	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
883		1121
884	cf::override;	1122	cf::override;
885	},	1123	},
886	);	1124	);
887		1125
888	sub load_extension {
889	my ($path) = @_;
890
891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
892	my $base = $1;
893	my $pkg = $1;
894	$pkg =~ s/[^[:word:]]/_/g;
895	$pkg = "ext::$pkg";
896
897	warn "... loading '$path' into '$pkg'\n";
898
899	open my $fh, "<:utf8", $path
900	or die "$path: $!";
901
902	my $source =
903	"package $pkg; use strict; use utf8;\n"
904	. "#line 1 \"$path\"\n{\n"
905	. (do { local $/; <$fh> })
906	. "\n};\n1";
907
908	unless (eval $source) {
909	my $msg = $@ ? "$path: $@\n"
910	: "extension disabled.\n";
911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912	warn $@;
913	warn "mandatory extension failed to load, exiting.\n";
914	exit 1;
915	}
916	die $@;
917	}
918
919	push @EXTS, $pkg;
920	}
921
922	sub load_extensions {	1126	sub load_extensions {
		1127	cf::sync_job {
		1128	my %todo;
		1129
923	for my $ext (<$LIBDIR/*.ext>) {	1130	for my $path (<$LIBDIR/*.ext>) {
924	next unless -r $ext;	1131	next unless -r $path;
925	eval {	1132
926	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;
927	1	1190	}
928	} or warn "$ext not loaded: $@";	1191
		1192	skip:
		1193	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1194	unless $progress;
		1195	}
929	}	1196	};
930	}	1197	}
931		1198
932	#############################################################################	1199	#############################################################################
933		1200
		1201	=back
		1202
934	=head2 CORE EXTENSIONS	1203	=head2 CORE EXTENSIONS
935		1204
936	Functions and methods that extend core crossfire objects.	1205	Functions and methods that extend core crossfire objects.
937		1206
938	=cut	1207	=cut
…		…
950	Returns the given player object, loading it if necessary (might block).	1219	Returns the given player object, loading it if necessary (might block).
951		1220
952	=cut	1221	=cut
953		1222
954	sub playerdir($) {	1223	sub playerdir($) {
955	cf::localdir	1224	"$PLAYERDIR/"
956	. "/"
957	. cf::playerdir
958	. "/"
959	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1225	. (ref $_[0] ? $_[0]->ob->name : $_[0])
960	}	1226	}
961		1227
962	sub path($) {	1228	sub path($) {
963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1229	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964		1230
965	(playerdir $login) . "/$login.pl"	1231	(playerdir $login) . "/playerdata"
966	}	1232	}
967		1233
968	sub find_active($) {	1234	sub find_active($) {
969	$cf::PLAYER{$_[0]}	1235	$cf::PLAYER{$_[0]}
970	and $cf::PLAYER{$_[0]}->active	1236	and $cf::PLAYER{$_[0]}->active
…		…
983	my $login = $_[0];	1249	my $login = $_[0];
984		1250
985	my $guard = cf::lock_acquire "user_find:$login";	1251	my $guard = cf::lock_acquire "user_find:$login";
986		1252
987	$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
988	my $pl = load_pl path $login	1261	my $pl = load_pl path $login
989	or return;	1262	or return;
990	$cf::PLAYER{$login} = $pl	1263	$cf::PLAYER{$login} = $pl
991	}	1264	}
992	}	1265	}
…		…
1029		1302
1030	=cut	1303	=cut
1031		1304
1032	sub quit_character {	1305	sub quit_character {
1033	my ($pl) = @_;	1306	my ($pl) = @_;
		1307
		1308	my $name = $pl->ob->name;
1034		1309
1035	$pl->{deny_save} = 1;	1310	$pl->{deny_save} = 1;
1036	$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
1037		1312
1038	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1313	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1043	my $path = playerdir $pl;	1318	my $path = playerdir $pl;
1044	my $temp = "$path~$cf::RUNTIME~deleting~";	1319	my $temp = "$path~$cf::RUNTIME~deleting~";
1045	aio_rename $path, $temp;	1320	aio_rename $path, $temp;
1046	delete $cf::PLAYER{$pl->ob->name};	1321	delete $cf::PLAYER{$pl->ob->name};
1047	$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
1048	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;
1049	}	1344	}
1050		1345
1051	=item cf::player::list_logins	1346	=item cf::player::list_logins
1052		1347
1053	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
1054	while and may block, so not sync_job-capable, ever.	1349	while and may block, so not sync_job-capable, ever.
1055		1350
1056	=cut	1351	=cut
1057		1352
1058	sub list_logins {	1353	sub list_logins {
1059	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1354	my $dirs = aio_readdir $PLAYERDIR
1060	or return [];	1355	or return [];
1061		1356
1062	my @logins;	1357	my @logins;
1063		1358
1064	for my $login (@$dirs) {	1359	for my $login (@$dirs) {
…		…
1099	}	1394	}
1100		1395
1101	\@paths	1396	\@paths
1102	}	1397	}
1103		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
1104	=item $player->ext_reply ($msgid, $msgtype, %msg)	1449	=item $player->ext_reply ($msgid, %msg)
1105		1450
1106	Sends an ext reply to the player.	1451	Sends an ext reply to the player.
1107		1452
1108	=cut	1453	=cut
1109		1454
1110	sub ext_reply($$$%) {	1455	sub ext_reply($$%) {
1111	my ($self, $id, %msg) = @_;	1456	my ($self, $id, %msg) = @_;
1112		1457
1113	$msg{msgid} = $id;	1458	$msg{msgid} = $id;
1114		1459	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1115	$self->send ("ext " . cf::to_json \%msg);
1116	}	1460	}
1117		1461
1118	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	}
1119		1502
1120	=back	1503	=back
1121
1122		1504
1123	=head3 cf::map	1505	=head3 cf::map
1124		1506
1125	=over 4	1507	=over 4
1126		1508
…		…
1181	my ($self, $merge) = @_;	1563	my ($self, $merge) = @_;
1182		1564
1183	# we have to keep some variables in memory intact	1565	# we have to keep some variables in memory intact
1184	local $self->{path};	1566	local $self->{path};
1185	local $self->{load_path};	1567	local $self->{load_path};
1186	local $self->{deny_save};
1187	local $self->{deny_reset};
1188		1568
1189	$self->SUPER::thawer_merge ($merge);	1569	$self->SUPER::thawer_merge ($merge);
1190	}	1570	}
1191		1571
1192	sub normalise {	1572	sub normalise {
…		…
1264		1644
1265	# the original (read-only) location	1645	# the original (read-only) location
1266	sub load_path {	1646	sub load_path {
1267	my ($self) = @_;	1647	my ($self) = @_;
1268		1648
1269	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1649	"$MAPDIR/$self->{path}.map"
1270	}	1650	}
1271		1651
1272	# the temporary/swap location	1652	# the temporary/swap location
1273	sub save_path {	1653	sub save_path {
1274	my ($self) = @_;	1654	my ($self) = @_;
1275		1655
1276	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1656	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1657	"$TMPDIR/$path.map"
1278	}	1658	}
1279		1659
1280	# the unique path, undef == no special unique path	1660	# the unique path, undef == no special unique path
1281	sub uniq_path {	1661	sub uniq_path {
1282	my ($self) = @_;	1662	my ($self) = @_;
1283		1663
1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1664	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1665	"$UNIQUEDIR/$path"
1286	}	1666	}
1287		1667
1288	# and all this just because we cannot iterate over	1668	# and all this just because we cannot iterate over
1289	# all maps in C++...	1669	# all maps in C++...
1290	sub change_all_map_light {	1670	sub change_all_map_light {
1291	my ($change) = @_;	1671	my ($change) = @_;
1292		1672
1293	$_->change_map_light ($change)	1673	$_->change_map_light ($change)
1294	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;
1295	}	1683	}
1296		1684
1297	sub unlink_save {	1685	sub unlink_save {
1298	my ($self) = @_;	1686	my ($self) = @_;
1299		1687
…		…
1357	$self->load_header_orig	1745	$self->load_header_orig
1358	or return;	1746	or return;
1359	$self->prepare_orig;	1747	$self->prepare_orig;
1360	}	1748	}
1361		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
1362	1	1756	1
1363	}	1757	}
1364		1758
1365	sub find;	1759	sub find;
1366	sub find {	1760	sub find {
…		…
1378	$map->{last_save} = $cf::RUNTIME;	1772	$map->{last_save} = $cf::RUNTIME;
1379		1773
1380	$map->load_header	1774	$map->load_header
1381	or return;	1775	or return;
1382		1776
1383	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1777	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1384	# doing this can freeze the server in a sync job, obviously	1778	# doing this can freeze the server in a sync job, obviously
1385	#$cf::WAIT_FOR_TICK->wait;	1779	#$cf::WAIT_FOR_TICK->wait;
1386	$map->reset;	1780	$map->reset;
1387	undef $guard;	1781	undef $guard;
1388	return find $path;	1782	return find $path;
…		…
1399	my ($self) = @_;	1793	my ($self) = @_;
1400		1794
1401	local $self->{deny_reset} = 1; # loading can take a long time	1795	local $self->{deny_reset} = 1; # loading can take a long time
1402		1796
1403	my $path = $self->{path};	1797	my $path = $self->{path};
		1798
		1799	{
1404	my $guard = cf::lock_acquire "map_load:$path";	1800	my $guard = cf::lock_acquire "map_load:$path";
1405		1801
1406	return if $self->in_memory != cf::MAP_SWAPPED;	1802	return if $self->in_memory != cf::MAP_SWAPPED;
1407		1803
1408	$self->in_memory (cf::MAP_LOADING);	1804	$self->in_memory (cf::MAP_LOADING);
1409		1805
1410	$self->alloc;	1806	$self->alloc;
1411		1807
1412	$self->pre_load;	1808	$self->pre_load;
1413
1414	$self->_load_objects ($self->{load_path}, 1)
1415	or return;
1416
1417	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1418	if delete $self->{load_original};
1419
1420	if (my $uniq = $self->uniq_path) {
1421	utf8::encode $uniq;
1422	if (aio_open $uniq, O_RDONLY, 0) {
1423	$self->clear_unique_items;
1424	$self->_load_objects ($uniq, 0);
1425	}
1426	}
1427
1428	Coro::cede;
1429
1430	# now do the right thing for maps
1431	$self->link_multipart_objects;
1432
1433	unless ($self->{deny_activate}) {
1434	$self->decay_objects;
1435	$self->fix_auto_apply;
1436	$self->update_buttons;
1437	Coro::cede;	1809	Coro::cede;
1438	$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;
1439	$self->difficulty ($self->estimate_difficulty)	1828	$self->difficulty ($self->estimate_difficulty)
1440	unless $self->difficulty;	1829	unless $self->difficulty;
1441	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;
1442	$self->activate;	1839	$self->activate;
		1840	}
		1841
		1842	$self->in_memory (cf::MAP_IN_MEMORY);
1443	}	1843	}
1444		1844
1445	$self->post_load;	1845	$self->post_load;
1446
1447	$self->in_memory (cf::MAP_IN_MEMORY);
1448	}	1846	}
1449		1847
1450	sub customise_for {	1848	sub customise_for {
1451	my ($self, $ob) = @_;	1849	my ($self, $ob) = @_;
1452		1850
1453	return find "~" . $ob->name . "/" . $self->{path}	1851	return find "~" . $ob->name . "/" . $self->{path}
1454	if $self->per_player;	1852	if $self->per_player;
		1853
		1854	# return find "?party/" . $ob->name . "/" . $self->{path}
		1855	# if $self->per_party;
1455		1856
1456	$self	1857	$self
1457	}	1858	}
1458		1859
1459	# 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
…		…
1570		1971
1571	sub reset_at {	1972	sub reset_at {
1572	my ($self) = @_;	1973	my ($self) = @_;
1573		1974
1574	# TODO: safety, remove and allow resettable per-player maps	1975	# TODO: safety, remove and allow resettable per-player maps
1575	return 1e99 if $self->isa ("ext::map_per_player");#d#
1576	return 1e99 if $self->{deny_reset};	1976	return 1e99 if $self->{deny_reset};
1577		1977
1578	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1978	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1579	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;
1580		1980
…		…
1591	my ($self) = @_;	1991	my ($self) = @_;
1592		1992
1593	my $lock = cf::lock_acquire "map_data:$self->{path}";	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1594		1994
1595	return if $self->players;	1995	return if $self->players;
1596	return if $self->isa ("ext::map_per_player");#d#
1597		1996
1598	warn "resetting map ", $self->path;#d#	1997	warn "resetting map ", $self->path;
1599		1998
1600	$self->in_memory (cf::MAP_SWAPPED);	1999	$self->in_memory (cf::MAP_SWAPPED);
1601		2000
1602	# need to save uniques path	2001	# need to save uniques path
1603	unless ($self->{deny_save}) {	2002	unless ($self->{deny_save}) {
…		…
1635	$cf::MAP{$self->path} = $self;	2034	$cf::MAP{$self->path} = $self;
1636		2035
1637	$self->reset; # polite request, might not happen	2036	$self->reset; # polite request, might not happen
1638	}	2037	}
1639		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
1640	=item cf::map::unique_maps	2075	=item cf::map::unique_maps
1641		2076
1642	Returns an arrayref of paths of all shared maps that have	2077	Returns an arrayref of paths of all shared maps that have
1643	instantiated unique items. May block.	2078	instantiated unique items. May block.
1644		2079
1645	=cut	2080	=cut
1646		2081
1647	sub unique_maps() {	2082	sub unique_maps() {
1648	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2083	[
1649	or return;	2084	map {
1650
1651	my @paths;
1652
1653	for (@$files) {
1654	utf8::decode $_;	2085	utf8::decode $_;
1655	next if /\.pst$/;	2086	/\.map$/
1656	next unless /^$PATH_SEP/o;	2087	? normalise $_
1657		2088	: ()
1658	push @paths, cf::map::normalise $_;	2089	} @{ aio_readdir $UNIQUEDIR or [] }
1659	}	2090	]
1660
1661	\@paths
1662	}	2091	}
1663		2092
1664	package cf;	2093	package cf;
1665		2094
1666	=back	2095	=back
…		…
1712		2141
1713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2142	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1714		2143
1715	if ($self->{record_replies}) {	2144	if ($self->{record_replies}) {
1716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2145	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2146
1717	} 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 {
1718	$msg = $npc->name . " says: $msg" if $npc;	2160	$msg = $npc->name . " says: $msg" if $npc;
1719	$self->message ($msg, $flags);	2161	$self->message ($msg, $flags);
		2162	}
1720	}	2163	}
1721	}	2164	}
1722		2165
1723	=item $player_object->may ("access")	2166	=item $player_object->may ("access")
1724		2167
…		…
1772	$self->deactivate_recursive;	2215	$self->deactivate_recursive;
1773		2216
1774	return if UNIVERSAL::isa $self->map, "ext::map_link";	2217	return if UNIVERSAL::isa $self->map, "ext::map_link";
1775		2218
1776	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2219	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1777	if $self->map;	2220	if $self->map && $self->map->{path} ne "{link}";
1778		2221
1779	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2222	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1780	}	2223	}
1781		2224
1782	sub cf::object::player::leave_link {	2225	sub cf::object::player::leave_link {
1783	my ($self, $map, $x, $y) = @_;	2226	my ($self, $map, $x, $y) = @_;
		2227
		2228	return unless $self->contr->active;
1784		2229
1785	my $link_pos = delete $self->{_link_pos};	2230	my $link_pos = delete $self->{_link_pos};
1786		2231
1787	unless ($map) {	2232	unless ($map) {
1788	# restore original map position	2233	# restore original map position
…		…
1811		2256
1812	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2257	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813	$self->enter_map ($map, $x, $y);	2258	$self->enter_map ($map, $x, $y);
1814	}	2259	}
1815		2260
1816	cf::player->attach (
1817	on_logout => sub {
1818	my ($pl) = @_;
1819
1820	# abort map switching before logout
1821	if ($pl->ob->{_link_pos}) {
1822	cf::sync_job {
1823	$pl->ob->leave_link
1824	};
1825	}
1826	},
1827	on_login => sub {
1828	my ($pl) = @_;
1829
1830	# try to abort aborted map switching on player login :)
1831	# should happen only on crashes
1832	if ($pl->ob->{_link_pos}) {
1833	$pl->ob->enter_link;
1834	(async {
1835	$pl->ob->reply (undef,
1836	"There was an internal problem at your last logout, "
1837	. "the server will try to bring you to your intended destination in a second.",
1838	cf::NDI_RED);
1839	# we need this sleep as the login has a concurrent enter_exit running
1840	# and this sleep increases chances of the player not ending up in scorn
1841	Coro::Timer::sleep 1;
1842	$pl->ob->leave_link;
1843	})->prio (2);
1844	}
1845	},
1846	);
1847
1848	=item $player_object->goto ($path, $x, $y)	2261	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1849		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
1850	=cut	2268	=cut
		2269
		2270	our $GOTOGEN;
1851		2271
1852	sub cf::object::player::goto {	2272	sub cf::object::player::goto {
1853	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;
1854		2277
1855	$self->enter_link;	2278	$self->enter_link;
1856		2279
1857	(async {	2280	(async {
1858	my $map = eval {	2281	my $map = eval {
1859	my $map = cf::map::find $path;	2282	my $map = cf::map::find $path;
		2283
		2284	if ($map) {
1860	$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
1861	$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 $@;
1862	} or	2297	}
1863	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864		2298
		2299	if ($gen == $self->{_goto_generation}) {
		2300	delete $self->{_goto_generation};
1865	$self->leave_link ($map, $x, $y);	2301	$self->leave_link ($map, $x, $y);
		2302	}
1866	})->prio (1);	2303	})->prio (1);
1867	}	2304	}
1868		2305
1869	=item $player_object->enter_exit ($exit_object)	2306	=item $player_object->enter_exit ($exit_object)
1870		2307
…		…
1909		2346
1910	$rmp->{random_seed} ||= $exit->random_seed;	2347	$rmp->{random_seed} ||= $exit->random_seed;
1911		2348
1912	my $data = cf::to_json $rmp;	2349	my $data = cf::to_json $rmp;
1913	my $md5 = Digest::MD5::md5_hex $data;	2350	my $md5 = Digest::MD5::md5_hex $data;
1914	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2351	my $meta = "$RANDOMDIR/$md5.meta";
1915		2352
1916	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2353	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917	aio_write $fh, 0, (length $data), $data, 0;	2354	aio_write $fh, 0, (length $data), $data, 0;
1918	undef $fh;	2355	undef $fh;
1919	aio_rename "$meta~", $meta;	2356	aio_rename "$meta~", $meta;
…		…
1928		2365
1929	return unless $self->type == cf::PLAYER;	2366	return unless $self->type == cf::PLAYER;
1930		2367
1931	if ($exit->slaying eq "/!") {	2368	if ($exit->slaying eq "/!") {
1932	#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
1933	cf::sync_job { prepare_random_map $exit };	2372	cf::sync_job { prepare_random_map $exit };
1934	}	2373	}
1935		2374
1936	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;
1937	my $hp = $exit->stats->hp;	2376	my $hp = $exit->stats->hp;
1938	my $sp = $exit->stats->sp;	2377	my $sp = $exit->stats->sp;
1939		2378
1940	$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);
1941		2384
1942	(async {	2385	(async {
1943	$self->deactivate_recursive; # just to be sure	2386	$self->deactivate_recursive; # just to be sure
1944	unless (eval {	2387	unless (eval {
1945	$self->goto ($slaying, $hp, $sp);	2388	$self->goto ($slaying, $hp, $sp);
1946		2389
1947	1;	2390	1;
1948	}) {	2391	}) {
1949	$self->message ("Something went wrong deep within the crossfire server. "	2392	$self->message ("Something went wrong deep within the crossfire server. "
1950	. "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. "
1951	. "Please report this to the dungeon master!",	2394	. "Please report this to the dungeon master!",
1952	cf::NDI_UNIQUE | cf::NDI_RED);	2395	cf::NDI_UNIQUE | cf::NDI_RED);
1953		2396
1954	warn "ERROR in enter_exit: $@";	2397	warn "ERROR in enter_exit: $@";
1955	$self->leave_link;	2398	$self->leave_link;
1956	}	2399	}
1957	})->prio (1);	2400	})->prio (1);
…		…
1970		2413
1971	sub cf::client::send_drawinfo {	2414	sub cf::client::send_drawinfo {
1972	my ($self, $text, $flags) = @_;	2415	my ($self, $text, $flags) = @_;
1973		2416
1974	utf8::encode $text;	2417	utf8::encode $text;
1975	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2418	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976	}	2419	}
1977		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	$msg{msgtype} = "event_$type";
		2471	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2472	}
1978		2473
1979	=item $success = $client->query ($flags, "text", \&cb)	2474	=item $success = $client->query ($flags, "text", \&cb)
1980		2475
1981	Queues a query to the client, calling the given callback with	2476	Queues a query to the client, calling the given callback with
1982	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2477	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2478	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984		2479
1985	Queries can fail, so check the return code. Or don't, as queries will become	2480	Queries can fail, so check the return code. Or don't, as queries will
1986	reliable at some point in the future.	2481	become reliable at some point in the future.
1987		2482
1988	=cut	2483	=cut
1989		2484
1990	sub cf::client::query {	2485	sub cf::client::query {
1991	my ($self, $flags, $text, $cb) = @_;	2486	my ($self, $flags, $text, $cb) = @_;
…		…
1999	utf8::encode $text;	2494	utf8::encode $text;
2000	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2495	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001		2496
2002	$self->send_packet ($self->{query_queue}[0][0])	2497	$self->send_packet ($self->{query_queue}[0][0])
2003	if @{ $self->{query_queue} } == 1;	2498	if @{ $self->{query_queue} } == 1;
		2499
		2500	1
2004	}	2501	}
2005		2502
2006	cf::client->attach (	2503	cf::client->attach (
		2504	on_connect => sub {
		2505	my ($ns) = @_;
		2506
		2507	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2508	},
2007	on_reply => sub {	2509	on_reply => sub {
2008	my ($ns, $msg) = @_;	2510	my ($ns, $msg) = @_;
2009		2511
2010	# this weird shuffling is so that direct followup queries	2512	# this weird shuffling is so that direct followup queries
2011	# get handled first	2513	# get handled first
…		…
2023	} else {	2525	} else {
2024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2526	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025	}	2527	}
2026	}	2528	}
2027	},	2529	},
		2530	on_exticmd => sub {
		2531	my ($ns, $buf) = @_;
		2532
		2533	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2534
		2535	if (ref $msg) {
		2536	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2537	if (my %reply = $cb->($ns, $msg)) {
		2538	$reply{msgid} = $msg->{msgid};
		2539	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2540	}
		2541	}
		2542	} else {
		2543	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2544	}
		2545
		2546	cf::override;
		2547	},
2028	);	2548	);
2029		2549
2030	=item $client->async (\&cb)	2550	=item $client->async (\&cb)
2031		2551
2032	Create a new coroutine, running the specified callback. The coroutine will	2552	Create a new coroutine, running the specified callback. The coroutine will
…		…
2079		2599
2080	# here we export the classes and methods available to script code	2600	# here we export the classes and methods available to script code
2081		2601
2082	=pod	2602	=pod
2083		2603
2084	The following fucntions and emthods are available within a safe environment:	2604	The following functions and methods are available within a safe environment:
2085		2605
2086	cf::object contr pay_amount pay_player map	2606	cf::object
		2607	contr pay_amount pay_player map x y force_find force_add
		2608	insert remove
		2609
2087	cf::object::player player	2610	cf::object::player
2088	cf::player peaceful	2611	player
2089	cf::map trigger	2612
		2613	cf::player
		2614	peaceful
		2615
		2616	cf::map
		2617	trigger
2090		2618
2091	=cut	2619	=cut
2092		2620
2093	for (	2621	for (
2094	["cf::object" => qw(contr pay_amount pay_player map)],	2622	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2623	insert remove)],
2095	["cf::object::player" => qw(player)],	2624	["cf::object::player" => qw(player)],
2096	["cf::player" => qw(peaceful)],	2625	["cf::player" => qw(peaceful)],
2097	["cf::map" => qw(trigger)],	2626	["cf::map" => qw(trigger)],
2098	) {	2627	) {
2099	no strict 'refs';	2628	no strict 'refs';
…		…
2170	=back	2699	=back
2171		2700
2172	=cut	2701	=cut
2173		2702
2174	#############################################################################	2703	#############################################################################
2175
2176	=head2 EXTENSION DATABASE SUPPORT
2177
2178	Crossfire maintains a very simple database for extension use. It can
2179	currently store anything that can be serialised using Storable, which
2180	excludes objects.
2181
2182	The parameter C<$family> should best start with the name of the extension
2183	using it, it should be unique.
2184
2185	=over 4
2186
2187	=item $value = cf::db_get $family => $key
2188
2189	Returns a single value from the database.
2190
2191	=item cf::db_put $family => $key => $value
2192
2193	Stores the given C<$value> in the family.
2194
2195	=cut
2196
2197	our $DB;
2198
2199	sub db_init {
2200	unless ($DB) {
2201	$DB = BDB::db_create $DB_ENV;
2202
2203	cf::sync_job {
2204	eval {
2205	$DB->set_flags (BDB::CHKSUM);
2206
2207	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2208	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2209	cf::cleanup "db_open(db): $!" if $!;
2210	};
2211	cf::cleanup "db_open(db): $@" if $@;
2212	};
2213
2214	my $path = cf::localdir . "/database.pst";
2215	if (stat $path) {
2216	cf::sync_job {
2217	my $pst = Storable::retrieve $path;
2218
2219	cf::db_put (board => data => $pst->{board});
2220	cf::db_put (guildrules => data => $pst->{guildrules});
2221	cf::db_put (rent => balance => $pst->{rent}{balance});
2222	BDB::db_env_txn_checkpoint $DB_ENV;
2223
2224	unlink $path;
2225	};
2226	}
2227	}
2228	}
2229
2230	sub db_get($$) {
2231	my $key = "$_[0]/$_[1]";
2232
2233	cf::sync_job {
2234	BDB::db_get $DB, undef, $key, my $data;
2235
2236	$! ? ()
2237	: Compress::LZF::sthaw $data
2238	}
2239	}
2240
2241	sub db_put($$$) {
2242	BDB::dbreq_pri 4;
2243	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2244	}
2245
2246	#############################################################################
2247	# the server's init and main functions	2704	# the server's init and main functions
2248		2705
2249	sub init_resources {	2706	sub load_facedata($) {
2250	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2707	my ($path) = @_;
		2708
		2709	warn "loading facedata from $path\n";
		2710
		2711	my $facedata;
		2712	0 < aio_load $path, $facedata
		2713	or die "$path: $!";
		2714
		2715	$facedata = Coro::Storable::thaw $facedata;
		2716
		2717	$facedata->{version} == 2
		2718	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2719
		2720	{
		2721	my $faces = $facedata->{faceinfo};
		2722
		2723	while (my ($face, $info) = each %$faces) {
		2724	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2725	cf::face::set_visibility $idx, $info->{visibility};
		2726	cf::face::set_magicmap $idx, $info->{magicmap};
		2727	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2728	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2729
		2730	cf::cede_to_tick;
		2731	}
		2732
		2733	while (my ($face, $info) = each %$faces) {
		2734	next unless $info->{smooth};
		2735	my $idx = cf::face::find $face
		2736	or next;
		2737	if (my $smooth = cf::face::find $info->{smooth}) {
		2738	cf::face::set_smooth $idx, $smooth;
		2739	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2740	} else {
		2741	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2742	}
		2743
		2744	cf::cede_to_tick;
		2745	}
		2746	}
		2747
		2748	{
		2749	my $anims = $facedata->{animinfo};
		2750
		2751	while (my ($anim, $info) = each %$anims) {
		2752	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2753	cf::cede_to_tick;
		2754	}
		2755
		2756	cf::anim::invalidate_all; # d'oh
		2757	}
		2758
		2759	{
		2760	# TODO: for gcfclient pleasure, we should give resources
		2761	# that gcfclient doesn't grok a >10000 face index.
		2762	my $res = $facedata->{resource};
		2763	my $enc = JSON::XS->new->utf8->canonical;
		2764
		2765	while (my ($name, $info) = each %$res) {
		2766	my $meta = $enc->encode ({
		2767	name => $name,
		2768	type => $info->{type},
		2769	copyright => $info->{copyright}, #TODO#
		2770	});
		2771	my $data = pack "(w/a*)*", $meta, $info->{data};
		2772	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2773
		2774	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2775	cf::face::set_type $idx, 1;
		2776	cf::face::set_data $idx, 0, $data, $chk;
		2777
		2778	cf::cede_to_tick;
		2779	}
		2780	}
		2781
		2782	1
		2783	}
		2784
		2785	sub reload_regions {
		2786	load_resource_file "$MAPDIR/regions"
2251	or die "unable to load regions file\n";#d#	2787	or die "unable to load regions file\n";
		2788	}
		2789
		2790	sub reload_facedata {
		2791	load_facedata "$DATADIR/facedata"
		2792	or die "unable to load facedata\n";
		2793	}
		2794
		2795	sub reload_archetypes {
		2796	load_resource_file "$DATADIR/archetypes"
		2797	or die "unable to load archetypes\n";
		2798	#d# NEED to laod twice to resolve forward references
		2799	# this really needs to be done in an extra post-pass
		2800	# (which needs to be synchronous, so solve it differently)
		2801	load_resource_file "$DATADIR/archetypes"
		2802	or die "unable to load archetypes\n";
		2803	}
		2804
		2805	sub reload_treasures {
		2806	load_resource_file "$DATADIR/treasures"
		2807	or die "unable to load treasurelists\n";
		2808	}
		2809
		2810	sub reload_resources {
		2811	warn "reloading resource files...\n";
		2812
		2813	reload_regions;
		2814	reload_facedata;
		2815	#reload_archetypes;#d#
		2816	reload_archetypes;
		2817	reload_treasures;
		2818
		2819	warn "finished reloading resource files\n";
		2820	}
		2821
		2822	sub init {
		2823	reload_resources;
2252	}	2824	}
2253		2825
2254	sub cfg_load {	2826	sub cfg_load {
2255	open my $fh, "<:utf8", cf::confdir . "/config"	2827	open my $fh, "<:utf8", "$CONFDIR/config"
2256	or return;	2828	or return;
2257		2829
2258	local $/;	2830	local $/;
2259	*CFG = YAML::Syck::Load <$fh>;	2831	*CFG = YAML::Syck::Load <$fh>;
2260		2832
…		…
2268	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2840	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2269	and die "WARNING: m(un)lockall failed: $!\n";	2841	and die "WARNING: m(un)lockall failed: $!\n";
2270	};	2842	};
2271	warn $@ if $@;	2843	warn $@ if $@;
2272	}	2844	}
2273	}
2274
2275	sub init {
2276	init_resources;
2277	}	2845	}
2278		2846
2279	sub main {	2847	sub main {
2280	# we must not ever block the main coroutine	2848	# we must not ever block the main coroutine
2281	local $Coro::idle = sub {	2849	local $Coro::idle = sub {
…		…
2309	},	2877	},
2310	);	2878	);
2311	}	2879	}
2312	}	2880	}
2313		2881
		2882	sub write_runtime {
		2883	my $runtime = "$LOCALDIR/runtime";
		2884
		2885	# first touch the runtime file to show we are still running:
		2886	# the fsync below can take a very very long time.
		2887
		2888	IO::AIO::aio_utime $runtime, undef, undef;
		2889
		2890	my $guard = cf::lock_acquire "write_runtime";
		2891
		2892	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2893	or return;
		2894
		2895	my $value = $cf::RUNTIME + 90 + 10;
		2896	# 10 is the runtime save interval, for a monotonic clock
		2897	# 60 allows for the watchdog to kill the server.
		2898
		2899	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2900	and return;
		2901
		2902	# always fsync - this file is important
		2903	aio_fsync $fh
		2904	and return;
		2905
		2906	# touch it again to show we are up-to-date
		2907	aio_utime $fh, undef, undef;
		2908
		2909	close $fh
		2910	or return;
		2911
		2912	aio_rename "$runtime~", $runtime
		2913	and return;
		2914
		2915	warn "runtime file written.\n";
		2916
		2917	1
		2918	}
		2919
2314	sub emergency_save() {	2920	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	2921	my $freeze_guard = cf::freeze_mainloop;
2316		2922
2317	warn "enter emergency perl save\n";	2923	warn "enter emergency perl save\n";
2318		2924
…		…
2349		2955
2350	warn Carp::longmess "post_cleanup backtrace"	2956	warn Carp::longmess "post_cleanup backtrace"
2351	if $make_core;	2957	if $make_core;
2352	}	2958	}
2353		2959
2354	sub reload() {	2960	sub do_reload_perl() {
2355	# can/must only be called in main	2961	# can/must only be called in main
2356	if ($Coro::current != $Coro::main) {	2962	if ($Coro::current != $Coro::main) {
2357	warn "can only reload from main coroutine";	2963	warn "can only reload from main coroutine";
2358	return;	2964	return;
2359	}	2965	}
…		…
2384	Coro::cede;	2990	Coro::cede;
2385	last unless IO::AIO::nreqs || BDB::nreqs;	2991	last unless IO::AIO::nreqs || BDB::nreqs;
2386	warn "iterate...";	2992	warn "iterate...";
2387	}	2993	}
2388		2994
		2995	++$RELOAD;
		2996
2389	warn "cancelling all extension coros";	2997	warn "cancelling all extension coros";
2390	$_->cancel for values %EXT_CORO;	2998	$_->cancel for values %EXT_CORO;
2391	%EXT_CORO = ();	2999	%EXT_CORO = ();
2392		3000
2393	warn "removing commands";	3001	warn "removing commands";
2394	%COMMAND = ();	3002	%COMMAND = ();
2395		3003
2396	warn "removing ext commands";	3004	warn "removing ext/exti commands";
2397	%EXTCMD = ();	3005	%EXTCMD = ();
		3006	%EXTICMD = ();
2398		3007
2399	warn "unloading/nuking all extensions";	3008	warn "unloading/nuking all extensions";
2400	for my $pkg (@EXTS) {	3009	for my $pkg (@EXTS) {
2401	warn "... unloading $pkg";	3010	warn "... unloading $pkg";
2402		3011
…		…
2432	Symbol::delete_package "safe::$_"	3041	Symbol::delete_package "safe::$_"
2433	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3042	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2434		3043
2435	warn "unloading cf.pm \"a bit\"";	3044	warn "unloading cf.pm \"a bit\"";
2436	delete $INC{"cf.pm"};	3045	delete $INC{"cf.pm"};
		3046	delete $INC{"cf/pod.pm"};
2437		3047
2438	# don't, removes xs symbols, too,	3048	# don't, removes xs symbols, too,
2439	# and global variables created in xs	3049	# and global variables created in xs
2440	#Symbol::delete_package __PACKAGE__;	3050	#Symbol::delete_package __PACKAGE__;
2441		3051
…		…
2450		3060
2451	warn "loading extensions";	3061	warn "loading extensions";
2452	cf::load_extensions;	3062	cf::load_extensions;
2453		3063
2454	warn "reattaching attachments to objects/players";	3064	warn "reattaching attachments to objects/players";
2455	_global_reattach;	3065	_global_reattach; # objects, sockets
2456	warn "reattaching attachments to maps";	3066	warn "reattaching attachments to maps";
2457	reattach $_ for values %MAP;	3067	reattach $_ for values %MAP;
2458		3068	warn "reattaching attachments to players";
2459	warn "loading reloadable resources";	3069	reattach $_ for values %PLAYER;
2460	init_resources;
2461		3070
2462	warn "leaving sync_job";	3071	warn "leaving sync_job";
2463		3072
2464	1	3073	1
2465	} or do {	3074	} or do {
…		…
2471	warn "reloaded";	3080	warn "reloaded";
2472	};	3081	};
2473		3082
2474	our $RELOAD_WATCHER; # used only during reload	3083	our $RELOAD_WATCHER; # used only during reload
2475		3084
		3085	sub reload_perl() {
		3086	# doing reload synchronously and two reloads happen back-to-back,
		3087	# coro crashes during coro_state_free->destroy here.
		3088
		3089	$RELOAD_WATCHER ||= Event->timer (
		3090	reentrant => 0,
		3091	after => 0,
		3092	data => WF_AUTOCANCEL,
		3093	cb => sub {
		3094	do_reload_perl;
		3095	undef $RELOAD_WATCHER;
		3096	},
		3097	);
		3098	}
		3099
2476	register_command "reload" => sub {	3100	register_command "reload" => sub {
2477	my ($who, $arg) = @_;	3101	my ($who, $arg) = @_;
2478		3102
2479	if ($who->flag (FLAG_WIZ)) {	3103	if ($who->flag (FLAG_WIZ)) {
2480	$who->message ("reloading server.");	3104	$who->message ("reloading server.");
2481		3105	async { reload_perl };
2482	# doing reload synchronously and two reloads happen back-to-back,
2483	# coro crashes during coro_state_free->destroy here.
2484
2485	$RELOAD_WATCHER ||= Event->timer (
2486	reentrant => 0,
2487	after => 0,
2488	data => WF_AUTOCANCEL,
2489	cb => sub {
2490	reload;
2491	undef $RELOAD_WATCHER;
2492	},
2493	);
2494	}	3106	}
2495	};	3107	};
2496		3108
2497	unshift @INC, $LIBDIR;	3109	unshift @INC, $LIBDIR;
2498		3110
2499	my $bug_warning = 0;	3111	my $bug_warning = 0;
2500		3112
		3113	our @WAIT_FOR_TICK;
		3114	our @WAIT_FOR_TICK_BEGIN;
		3115
		3116	sub wait_for_tick {
		3117	return unless $TICK_WATCHER->is_active;
		3118	return if $Coro::current == $Coro::main;
		3119
		3120	my $signal = new Coro::Signal;
		3121	push @WAIT_FOR_TICK, $signal;
		3122	$signal->wait;
		3123	}
		3124
		3125	sub wait_for_tick_begin {
		3126	return unless $TICK_WATCHER->is_active;
		3127	return if $Coro::current == $Coro::main;
		3128
		3129	my $signal = new Coro::Signal;
		3130	push @WAIT_FOR_TICK_BEGIN, $signal;
		3131	$signal->wait;
		3132	}
		3133
		3134	my $min = 1e6;#d#
		3135	my $avg = 10;
2501	$TICK_WATCHER = Event->timer (	3136	$TICK_WATCHER = Event->timer (
2502	reentrant => 0,	3137	reentrant => 0,
2503	parked => 1,	3138	parked => 1,
2504	prio => 0,	3139	prio => 0,
2505	at => $NEXT_TICK || $TICK,	3140	at => $NEXT_TICK || $TICK,
…		…
2509	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3144	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2510	unless ++$bug_warning > 10;	3145	unless ++$bug_warning > 10;
2511	return;	3146	return;
2512	}	3147	}
2513		3148
2514	$NOW = Event::time;	3149	$NOW = $tick_start = Event::time;
2515		3150
2516	cf::server_tick; # one server iteration	3151	cf::server_tick; # one server iteration
		3152
		3153	0 && sync_job {#d#
		3154	for(1..10) {
		3155	my $t = Event::time;
		3156	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3157	or die;
		3158
		3159	$map->width (50);
		3160	$map->height (50);
		3161	$map->alloc;
		3162	$map->_load_objects ("/tmp/x.map", 1);
		3163	my $t = Event::time - $t;
		3164
		3165	#next unless $t < 0.0013;#d#
		3166	if ($t < $min) {
		3167	$min = $t;
		3168	}
		3169	$avg = $avg * 0.99 + $t * 0.01;
		3170	}
		3171	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3172	exit 0;
		3173	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3174	};
		3175
2517	$RUNTIME += $TICK;	3176	$RUNTIME += $TICK;
2518	$NEXT_TICK += $TICK;	3177	$NEXT_TICK += $TICK;
2519		3178
2520	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3179	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2521	$NEXT_RUNTIME_WRITE = $NOW + 10;	3180	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2523	write_runtime	3182	write_runtime
2524	or warn "ERROR: unable to write runtime file: $!";	3183	or warn "ERROR: unable to write runtime file: $!";
2525	};	3184	};
2526	}	3185	}
2527		3186
2528	$WAIT_FOR_TICK->broadcast;
2529	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2530
2531	# my $AFTER = Event::time;	3187	# my $AFTER = Event::time;
2532	# warn $AFTER - $NOW;#d#	3188	# warn $AFTER - $NOW;#d#
2533		3189
		3190	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3191	$sig->send;
		3192	}
		3193	while (my $sig = shift @WAIT_FOR_TICK) {
		3194	$sig->send;
		3195	}
		3196
		3197	$NOW = Event::time;
		3198
2534	# if we are delayed by four ticks or more, skip them all	3199	# if we are delayed by four ticks or more, skip them all
2535	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3200	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2536		3201
2537	$TICK_WATCHER->at ($NEXT_TICK);	3202	$TICK_WATCHER->at ($NEXT_TICK);
2538	$TICK_WATCHER->start;	3203	$TICK_WATCHER->start;
		3204
		3205	$LOAD = ($NOW - $tick_start) / $TICK;
		3206	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3207
		3208	_post_tick;
		3209
		3210
2539	},	3211	},
2540	);	3212	);
2541		3213
2542	{	3214	{
2543	BDB::max_poll_time $TICK * 0.1;	3215	BDB::max_poll_time $TICK * 0.1;
…		…
2571		3243
2572	cf::sync_job {	3244	cf::sync_job {
2573	eval {	3245	eval {
2574	BDB::db_env_open	3246	BDB::db_env_open
2575	$DB_ENV,	3247	$DB_ENV,
2576	$BDB_ENV_DIR,	3248	$BDBDIR,
2577	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3249	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2578	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3250	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2579	0666;	3251	0666;
2580		3252
2581	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3253	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2582		3254
2583	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3255	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2584	$DB_ENV->set_lk_detect;	3256	$DB_ENV->set_lk_detect;
2585	};	3257	};
2586		3258
…		…
2602	prio => 6,	3274	prio => 6,
2603	cb => \&IO::AIO::poll_cb,	3275	cb => \&IO::AIO::poll_cb,
2604	);	3276	);
2605	}	3277	}
2606		3278
		3279	my $_log_backtrace;
		3280
		3281	sub _log_backtrace {
		3282	my ($msg, @addr) = @_;
		3283
		3284	$msg =~ s/\n//;
		3285
		3286	# limit the # of concurrent backtraces
		3287	if ($_log_backtrace < 2) {
		3288	++$_log_backtrace;
		3289	async {
		3290	my @bt = fork_call {
		3291	@addr = map { sprintf "%x", $_ } @addr;
		3292	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3293	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3294	or die "addr2line: $!";
		3295
		3296	my @funcs;
		3297	my @res = <$fh>;
		3298	chomp for @res;
		3299	while (@res) {
		3300	my ($func, $line) = splice @res, 0, 2, ();
		3301	push @funcs, "[$func] $line";
		3302	}
		3303
		3304	@funcs
		3305	};
		3306
		3307	LOG llevInfo, "[ABT] $msg\n";
		3308	LOG llevInfo, "[ABT] $_\n" for @bt;
		3309	--$_log_backtrace;
		3310	};
		3311	} else {
		3312	LOG llevInfo, "[ABT] $msg\n";
		3313	LOG llevInfo, "[ABT] [suppressed]\n";
		3314	}
		3315	}
		3316
		3317	# load additional modules
		3318	use cf::pod;
		3319
2607	END { cf::emergency_save }	3320	END { cf::emergency_save }
2608		3321
2609	1	3322	1
2610		3323

Diff Legend

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