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.225 by root, Wed Mar 14 00:04:58 2007 UTC vs.
Revision 1.308 by root, Mon Jul 16 14:09:40 2007 UTC

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

Diff Legend

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