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.295 by root, Wed Jul 4 05:08:15 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;
28		34
		35	# configure various modules to our taste
		36	#
		37	$Storable::canonical = 1; # reduce rsync transfers
		38	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	39	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		40
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	41	$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		42
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	43	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;	44	$YAML::Syck::ImplicitUnicode = 1;
37		45
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	46	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		47
		48	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		49
40	our %COMMAND = ();	50	our %COMMAND = ();
41	our %COMMAND_TIME = ();	51	our %COMMAND_TIME = ();
42		52
43	our @EXTS = (); # list of extension package names	53	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	54	our %EXTCMD = ();
		55	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	56	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	57	our %EXT_MAP = (); # pluggable maps
47		58
		59	our $RELOAD; # number of reloads so far
48	our @EVENT;	60	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		61
51	our $TICK = MAX_TIME * 1e-6;	62	our $CONFDIR = confdir;
		63	our $DATADIR = datadir;
		64	our $LIBDIR = "$DATADIR/ext";
		65	our $PODDIR = "$DATADIR/pod";
		66	our $MAPDIR = "$DATADIR/" . mapdir;
		67	our $LOCALDIR = localdir;
		68	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		69	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		70	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		71	our $RANDOMDIR = "$LOCALDIR/random";
		72	our $BDBDIR = "$LOCALDIR/db";
		73
		74	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52	our $TICK_WATCHER;	75	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	76	our $AIO_POLL_WATCHER;
54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	77	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	78	our $NEXT_TICK;
56	our $NOW;	79	our $NOW;
…		…
65	our $RUNTIME;	88	our $RUNTIME;
66		89
67	our %PLAYER; # all users	90	our %PLAYER; # all users
68	our %MAP; # all maps	91	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	92	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		93
76	# used to convert map paths into valid unix filenames by replacing / by ∕	94	# used to convert map paths into valid unix filenames by replacing / by ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	95	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		96
		97	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		98	our $LOADAVG; # same thing, but with alpha-smoothing
		99	our $tick_start; # for load detecting purposes
		100
79	binmode STDOUT;	101	binmode STDOUT;
80	binmode STDERR;	102	binmode STDERR;
81		103
82	# read virtual server time, if available	104	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	105	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	106	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	107	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	108	$RUNTIME = <$fh> + 0.;
87	}	109	}
88		110
89	mkdir cf::localdir;	111	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	112	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		113
96	our $EMERGENCY_POSITION;	114	our $EMERGENCY_POSITION;
97		115
98	sub cf::map::normalise;	116	sub cf::map::normalise;
99		117
…		…
110	=item $cf::RUNTIME	128	=item $cf::RUNTIME
111		129
112	The time this server has run, starts at 0 and is increased by $cf::TICK on	130	The time this server has run, starts at 0 and is increased by $cf::TICK on
113	every server tick.	131	every server tick.
114		132
115	=item $cf::LIBDIR	133	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		134	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		135	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116		136
117	The perl library directory, where extensions and cf-specific modules can	137	Various directories - "/etc", read-only install directory, perl-library
118	be found. It will be added to C<@INC> automatically.	138	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		139	unique-items directory, player file directory, random maps directory and
		140	database environment.
119		141
120	=item $cf::NOW	142	=item $cf::NOW
121		143
122	The time of the last (current) server tick.	144	The time of the last (current) server tick.
123		145
124	=item $cf::TICK	146	=item $cf::TICK
125		147
126	The interval between server ticks, in seconds.	148	The interval between server ticks, in seconds.
		149
		150	=item $cf::LOADAVG
		151
		152	The current CPU load on the server (alpha-smoothed), as a value between 0
		153	(none) and 1 (overloaded), indicating how much time is spent on processing
		154	objects per tick. Healthy values are < 0.5.
		155
		156	=item $cf::LOAD
		157
		158	The raw value load value from the last tick.
127		159
128	=item %cf::CFG	160	=item %cf::CFG
129		161
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	162	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	163	from wherever your confdir points to.
132		164
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	165	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		166
135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	167	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	168	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	169	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		170
140	=back	171	=back
141		172
142	=cut	173	=cut
143		174
144	BEGIN {	175	BEGIN {
145	*CORE::GLOBAL::warn = sub {	176	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	177	my $msg = join "", @_;
147	utf8::encode $msg;
148		178
149	$msg .= "\n"	179	$msg .= "\n"
150	unless $msg =~ /\n$/;	180	unless $msg =~ /\n$/;
151		181
		182	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		183
		184	utf8::encode $msg;
152	LOG llevError, $msg;	185	LOG llevError, $msg;
153	};	186	};
154	}	187	}
155		188
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	189	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	190	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	191	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	192	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	193	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		194	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	195	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162		196
163	# we bless all objects into (empty) derived classes to force a method lookup	197	# we bless all objects into (empty) derived classes to force a method lookup
164	# within the Safe compartment.	198	# within the Safe compartment.
165	for my $pkg (qw(	199	for my $pkg (qw(
166	cf::global cf::attachable	200	cf::global cf::attachable
…		…
174	}	208	}
175		209
176	$Event::DIED = sub {	210	$Event::DIED = sub {
177	warn "error in event callback: @_";	211	warn "error in event callback: @_";
178	};	212	};
		213
		214	#############################################################################
179		215
180	=head2 UTILITY FUNCTIONS	216	=head2 UTILITY FUNCTIONS
181		217
182	=over 4	218	=over 4
183		219
…		…
202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	238	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203	$d	239	$d
204	} || "[unable to dump $_[0]: '$@']";	240	} || "[unable to dump $_[0]: '$@']";
205	}	241	}
206		242
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
210		244
211	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
212		246
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	247	=item $json = cf::to_json $ref
221		248
222	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
223		250
224	=cut	251	=cut
225		252
226	sub to_json($) {	253	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	254
228	JSON::Syck::Dump $_[0]	255	sub to_json ($) { $json_coder->encode ($_[0]) }
229	}	256	sub from_json ($) { $json_coder->decode ($_[0]) }
230		257
231	=item cf::lock_wait $string	258	=item cf::lock_wait $string
232		259
233	Wait until the given lock is available. See cf::lock_acquire.	260	Wait until the given lock is available. See cf::lock_acquire.
234		261
…		…
240	returned.	267	returned.
241		268
242	Lock names should begin with a unique identifier (for example, cf::map::find	269	Lock names should begin with a unique identifier (for example, cf::map::find
243	uses map_find and cf::map::load uses map_load).	270	uses map_find and cf::map::load uses map_load).
244		271
		272	=item $locked = cf::lock_active $string
		273
		274	Return true if the lock is currently active, i.e. somebody has locked it.
		275
245	=cut	276	=cut
246		277
247	our %LOCK;	278	our %LOCK;
248		279
249	sub lock_wait($) {	280	sub lock_wait($) {
…		…
266		297
267	Coro::guard {	298	Coro::guard {
268	# wake up all waiters, to be on the safe side	299	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	300	$_->ready for @{ delete $LOCK{$key} };
270	}	301	}
		302	}
		303
		304	sub lock_active($) {
		305	my ($key) = @_;
		306
		307	! ! $LOCK{$key}
271	}	308	}
272		309
273	sub freeze_mainloop {	310	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	311	return unless $TICK_WATCHER->is_active;
275		312
…		…
290		327
291	BEGIN { *async = \&Coro::async_pool }	328	BEGIN { *async = \&Coro::async_pool }
292		329
293	=item cf::sync_job { BLOCK }	330	=item cf::sync_job { BLOCK }
294		331
295	The design of crossfire+ requires that the main coro ($Coro::main) is	332	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	333	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.	334	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		335	acceptable.
298		336
299	If it must be done, put the blocking parts into C<sync_job>. This will run	337	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	338	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	339	server will be frozen during this time, so the block should either finish
302	fast or be very important.	340	fast or be very important.
…		…
305		343
306	sub sync_job(&) {	344	sub sync_job(&) {
307	my ($job) = @_;	345	my ($job) = @_;
308		346
309	if ($Coro::current == $Coro::main) {	347	if ($Coro::current == $Coro::main) {
		348	my $time = Event::time;
		349
310	# this is the main coro, too bad, we have to block	350	# this is the main coro, too bad, we have to block
311	# till the operation succeeds, freezing the server :/	351	# till the operation succeeds, freezing the server :/
312		352
313	# TODO: use suspend/resume instead	353	# TODO: use suspend/resume instead
314	# (but this is cancel-safe)	354	# (but this is cancel-safe)
…		…
325		365
326	while ($busy) {	366	while ($busy) {
327	Coro::cede or Event::one_event;	367	Coro::cede or Event::one_event;
328	}	368	}
329		369
		370	$time = Event::time - $time;
		371
		372	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		373	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		374
		375	$tick_start += $time; # do not account sync jobs to server load
		376
330	wantarray ? @res : $res[0]	377	wantarray ? @res : $res[0]
331	} else {	378	} else {
332	# we are in another coroutine, how wonderful, everything just works	379	# we are in another coroutine, how wonderful, everything just works
333		380
334	$job->()	381	$job->()
…		…
353	$EXT_CORO{$coro+0} = $coro;	400	$EXT_CORO{$coro+0} = $coro;
354		401
355	$coro	402	$coro
356	}	403	}
357		404
358	sub write_runtime {	405	=item fork_call { }, $args
359	my $guard = cf::lock_acquire "write_runtime";
360		406
361	my $runtime = cf::localdir . "/runtime";	407	Executes the given code block with the given arguments in a seperate
		408	process, returning the results. Everything must be serialisable with
		409	Coro::Storable. May, of course, block. Note that the executed sub may
		410	never block itself or use any form of Event handling.
362		411
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	412	=cut
364	or return;
365		413
366	my $value = $cf::RUNTIME + 90 + 10;	414	sub fork_call(&@) {
367	# 10 is the runtime save interval, for a monotonic clock	415	my ($cb, @args) = @_;
368	# 60 allows for the watchdog to kill the server.
369		416
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	417	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
371	and return;	418	# or die "socketpair: $!";
		419	pipe my $fh1, my $fh2
		420	or die "pipe: $!";
372		421
373	# always fsync - this file is important	422	if (my $pid = fork) {
374	aio_fsync $fh
375	and return;
376
377	close $fh	423	close $fh2;
378	or return;
379		424
380	aio_rename "$runtime~", $runtime	425	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
381	and return;	426	$res = Coro::Storable::thaw $res;
382		427
		428	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		429
		430	die $$res unless "ARRAY" eq ref $res;
		431
		432	return wantarray ? @$res : $res->[-1];
		433	} else {
		434	reset_signals;
		435	local $SIG{__WARN__};
		436	local $SIG{__DIE__};
		437	eval {
		438	close $fh1;
		439
		440	my @res = eval { $cb->(@args) };
		441	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		442	};
		443
		444	warn $@ if $@;
		445	_exit 0;
383	1	446	}
		447	}
		448
		449	=item $value = cf::db_get $family => $key
		450
		451	Returns a single value from the environment database.
		452
		453	=item cf::db_put $family => $key => $value
		454
		455	Stores the given C<$value> in the family. It can currently store binary
		456	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		457
		458	=cut
		459
		460	our $DB;
		461
		462	sub db_init {
		463	unless ($DB) {
		464	$DB = BDB::db_create $DB_ENV;
		465
		466	cf::sync_job {
		467	eval {
		468	$DB->set_flags (BDB::CHKSUM);
		469
		470	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		471	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		472	cf::cleanup "db_open(db): $!" if $!;
		473	};
		474	cf::cleanup "db_open(db): $@" if $@;
		475	};
		476	}
		477	}
		478
		479	sub db_get($$) {
		480	my $key = "$_[0]/$_[1]";
		481
		482	cf::sync_job {
		483	BDB::db_get $DB, undef, $key, my $data;
		484
		485	$! ? ()
		486	: $data
		487	}
		488	}
		489
		490	sub db_put($$$) {
		491	BDB::dbreq_pri 4;
		492	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		493	}
		494
		495	=item cf::cache $id => [$paths...], $processversion => $process
		496
		497	Generic caching function that returns the value of the resource $id,
		498	caching and regenerating as required.
		499
		500	This function can block.
		501
		502	=cut
		503
		504	sub cache {
		505	my ($id, $src, $processversion, $process) = @_;
		506
		507	my $meta =
		508	join "\x00",
		509	$processversion,
		510	map {
		511	aio_stat $_
		512	and Carp::croak "$_: $!";
		513
		514	($_, (stat _)[7,9])
		515	} @$src;
		516
		517	my $dbmeta = db_get cache => "$id/meta";
		518	if ($dbmeta ne $meta) {
		519	# changed, we may need to process
		520
		521	my @data;
		522	my $md5;
		523
		524	for (0 .. $#$src) {
		525	0 <= aio_load $src->[$_], $data[$_]
		526	or Carp::croak "$src->[$_]: $!";
		527	}
		528
		529	# if processing is expensive, check
		530	# checksum first
		531	if (1) {
		532	$md5 =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	Coro::cede;
		537	($src->[$_], Digest::MD5::md5_hex $data[$_])
		538	} 0.. $#$src;
		539
		540
		541	my $dbmd5 = db_get cache => "$id/md5";
		542	if ($dbmd5 eq $md5) {
		543	db_put cache => "$id/meta", $meta;
		544
		545	return db_get cache => "$id/data";
		546	}
		547	}
		548
		549	my $t1 = Time::HiRes::time;
		550	my $data = $process->(\@data);
		551	my $t2 = Time::HiRes::time;
		552
		553	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		554
		555	db_put cache => "$id/data", $data;
		556	db_put cache => "$id/md5" , $md5;
		557	db_put cache => "$id/meta", $meta;
		558
		559	return $data;
		560	}
		561
		562	db_get cache => "$id/data"
		563	}
		564
		565	=item cf::datalog type => key => value, ...
		566
		567	Log a datalog packet of the given type with the given key-value pairs.
		568
		569	=cut
		570
		571	sub datalog($@) {
		572	my ($type, %kv) = @_;
		573	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384	}	574	}
385		575
386	=back	576	=back
387		577
388	=cut	578	=cut
…		…
395	attach callbacks/event handlers (a collection of which is called an "attachment")	585	attach callbacks/event handlers (a collection of which is called an "attachment")
396	to it. All such attachable objects support the following methods.	586	to it. All such attachable objects support the following methods.
397		587
398	In the following description, CLASS can be any of C<global>, C<object>	588	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	589	C<player>, C<client> or C<map> (i.e. the attachable objects in
400	crossfire+).	590	Crossfire TRT).
401		591
402	=over 4	592	=over 4
403		593
404	=item $attachable->attach ($attachment, key => $value...)	594	=item $attachable->attach ($attachment, key => $value...)
405		595
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	758	$registry = $CB_TYPE[$object_type] ||= [];
569		759
570	} elsif ($type eq "subtype") {	760	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	761	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	762	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	763	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		764
575	} elsif ($type eq "package") {	765	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	766	my $pkg = shift @arg;
577		767
578	while (my ($name, $id) = each %cb_id) {	768	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	797	_attach $registry, $klass, @attach;
608	}	798	}
609		799
610	$obj->{$name} = \%arg;	800	$obj->{$name} = \%arg;
611	} else {	801	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	802	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	803	}
614		804
615	$obj->{_attachment}{$name} = undef;	805	$obj->{_attachment}{$name} = undef;
616	}	806	}
617		807
…		…
619	if (ref $_[0]) {	809	if (ref $_[0]) {
620	_object_attach @_;	810	_object_attach @_;
621	} else {	811	} else {
622	_attach shift->_attach_registry, @_;	812	_attach shift->_attach_registry, @_;
623	}	813	}
		814	_recalc_want;
624	};	815	};
625		816
626	# all those should be optimised	817	# all those should be optimised
627	sub cf::attachable::detach {	818	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	819	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	822	delete $obj->{_attachment}{$name};
632	reattach ($obj);	823	reattach ($obj);
633	} else {	824	} else {
634	Carp::croak "cannot, currently, detach class attachments";	825	Carp::croak "cannot, currently, detach class attachments";
635	}	826	}
		827	_recalc_want;
636	};	828	};
637		829
638	sub cf::attachable::attached {	830	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	831	my ($obj, $name) = @_;
640		832
…		…
813	or return;	1005	or return;
814	$av = eval { (Storable::thaw $av)->{objs} };	1006	$av = eval { (Storable::thaw $av)->{objs} };
815	}	1007	}
816		1008
817	warn sprintf "loading %s (%d)\n",	1009	warn sprintf "loading %s (%d)\n",
818	$filename, length $data, scalar @{$av || []};#d#	1010	$filename, length $data, scalar @{$av || []};
819	return ($data, $av);	1011	return ($data, $av);
820	}	1012	}
		1013
		1014	=head2 COMMAND CALLBACKS
		1015
		1016	=over 4
		1017
		1018	=cut
821		1019
822	#############################################################################	1020	#############################################################################
823	# command handling &c	1021	# command handling &c
824		1022
825	=item cf::register_command $name => \&callback($ob,$args);	1023	=item cf::register_command $name => \&callback($ob,$args);
…		…
838	push @{ $COMMAND{$name} }, [$caller, $cb];	1036	push @{ $COMMAND{$name} }, [$caller, $cb];
839	}	1037	}
840		1038
841	=item cf::register_extcmd $name => \&callback($pl,$packet);	1039	=item cf::register_extcmd $name => \&callback($pl,$packet);
842		1040
843	Register a callbackf ro execution when the client sends an extcmd packet.	1041	Register a callback for execution when the client sends an (synchronous)
		1042	extcmd packet. Ext commands will be processed in the order they are
		1043	received by the server, like other user commands. The first argument is
		1044	the logged-in player. Ext commands can only be processed after a player
		1045	has logged in successfully.
844		1046
845	If the callback returns something, it is sent back as if reply was being	1047	If the callback returns something, it is sent back as if reply was being
846	called.	1048	called.
847		1049
		1050	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1051
		1052	Register a callback for execution when the client sends an (asynchronous)
		1053	exticmd packet. Exti commands are processed by the server as soon as they
		1054	are received, i.e. out of order w.r.t. other commands. The first argument
		1055	is a client socket. Exti commands can be received anytime, even before
		1056	log-in.
		1057
		1058	If the callback returns something, it is sent back as if reply was being
		1059	called.
		1060
848	=cut	1061	=cut
849		1062
850	sub register_extcmd {	1063	sub register_extcmd {
851	my ($name, $cb) = @_;	1064	my ($name, $cb) = @_;
852		1065
853	$EXTCMD{$name} = $cb;	1066	$EXTCMD{$name} = $cb;
		1067	}
		1068
		1069	sub register_exticmd {
		1070	my ($name, $cb) = @_;
		1071
		1072	$EXTICMD{$name} = $cb;
854	}	1073	}
855		1074
856	cf::player->attach (	1075	cf::player->attach (
857	on_command => sub {	1076	on_command => sub {
858	my ($pl, $name, $params) = @_;	1077	my ($pl, $name, $params) = @_;
…		…
867	cf::override;	1086	cf::override;
868	},	1087	},
869	on_extcmd => sub {	1088	on_extcmd => sub {
870	my ($pl, $buf) = @_;	1089	my ($pl, $buf) = @_;
871		1090
872	my $msg = eval { from_json $buf };	1091	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873		1092
874	if (ref $msg) {	1093	if (ref $msg) {
875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1094	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876	if (my %reply = $cb->($pl, $msg)) {	1095	if (my %reply = $cb->($pl, $msg)) {
877	$pl->ext_reply ($msg->{msgid}, %reply);	1096	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
883		1102
884	cf::override;	1103	cf::override;
885	},	1104	},
886	);	1105	);
887		1106
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 {	1107	sub load_extensions {
		1108	cf::sync_job {
		1109	my %todo;
		1110
923	for my $ext (<$LIBDIR/*.ext>) {	1111	for my $path (<$LIBDIR/*.ext>) {
924	next unless -r $ext;	1112	next unless -r $path;
925	eval {	1113
926	load_extension $ext;	1114	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1115	my $base = $1;
		1116	my $pkg = $1;
		1117	$pkg =~ s/[^[:word:]]/_/g;
		1118	$pkg = "ext::$pkg";
		1119
		1120	open my $fh, "<:utf8", $path
		1121	or die "$path: $!";
		1122
		1123	my $source = do { local $/; <$fh> };
		1124
		1125	my %ext = (
		1126	path => $path,
		1127	base => $base,
		1128	pkg => $pkg,
		1129	);
		1130
		1131	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1132	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1133
		1134	$ext{source} =
		1135	"package $pkg; use strict; use utf8;\n"
		1136	. "#line 1 \"$path\"\n{\n"
		1137	. $source
		1138	. "\n};\n1";
		1139
		1140	$todo{$base} = \%ext;
		1141	}
		1142
		1143	my %done;
		1144	while (%todo) {
		1145	my $progress;
		1146
		1147	while (my ($k, $v) = each %todo) {
		1148	for (split /,\s*/, $v->{meta}{depends}) {
		1149	goto skip
		1150	unless exists $done{$_};
		1151	}
		1152
		1153	warn "... loading '$k' into '$v->{pkg}'\n";
		1154
		1155	unless (eval $v->{source}) {
		1156	my $msg = $@ ? "$v->{path}: $@\n"
		1157	: "$v->{base}: extension inactive.\n";
		1158
		1159	if (exists $v->{meta}{mandatory}) {
		1160	warn $msg;
		1161	warn "mandatory extension failed to load, exiting.\n";
		1162	exit 1;
		1163	}
		1164
		1165	warn $msg;
		1166	}
		1167
		1168	$done{$k} = delete $todo{$k};
		1169	push @EXTS, $v->{pkg};
		1170	$progress = 1;
927	1	1171	}
928	} or warn "$ext not loaded: $@";	1172
		1173	skip:
		1174	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1175	unless $progress;
		1176	}
929	}	1177	};
930	}	1178	}
931		1179
932	#############################################################################	1180	#############################################################################
933		1181
		1182	=back
		1183
934	=head2 CORE EXTENSIONS	1184	=head2 CORE EXTENSIONS
935		1185
936	Functions and methods that extend core crossfire objects.	1186	Functions and methods that extend core crossfire objects.
937		1187
938	=cut	1188	=cut
…		…
950	Returns the given player object, loading it if necessary (might block).	1200	Returns the given player object, loading it if necessary (might block).
951		1201
952	=cut	1202	=cut
953		1203
954	sub playerdir($) {	1204	sub playerdir($) {
955	cf::localdir	1205	"$PLAYERDIR/"
956	. "/"
957	. cf::playerdir
958	. "/"
959	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1206	. (ref $_[0] ? $_[0]->ob->name : $_[0])
960	}	1207	}
961		1208
962	sub path($) {	1209	sub path($) {
963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1210	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964		1211
965	(playerdir $login) . "/$login.pl"	1212	(playerdir $login) . "/playerdata"
966	}	1213	}
967		1214
968	sub find_active($) {	1215	sub find_active($) {
969	$cf::PLAYER{$_[0]}	1216	$cf::PLAYER{$_[0]}
970	and $cf::PLAYER{$_[0]}->active	1217	and $cf::PLAYER{$_[0]}->active
…		…
983	my $login = $_[0];	1230	my $login = $_[0];
984		1231
985	my $guard = cf::lock_acquire "user_find:$login";	1232	my $guard = cf::lock_acquire "user_find:$login";
986		1233
987	$cf::PLAYER{$_[0]} || do {	1234	$cf::PLAYER{$_[0]} || do {
		1235	# rename old playerfiles to new ones
		1236	#TODO: remove when no longer required
		1237	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1238	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1239	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1240	aio_unlink +(playerdir $login) . "/$login.pl";
		1241
988	my $pl = load_pl path $login	1242	my $pl = load_pl path $login
989	or return;	1243	or return;
990	$cf::PLAYER{$login} = $pl	1244	$cf::PLAYER{$login} = $pl
991	}	1245	}
992	}	1246	}
…		…
1029		1283
1030	=cut	1284	=cut
1031		1285
1032	sub quit_character {	1286	sub quit_character {
1033	my ($pl) = @_;	1287	my ($pl) = @_;
		1288
		1289	my $name = $pl->ob->name;
1034		1290
1035	$pl->{deny_save} = 1;	1291	$pl->{deny_save} = 1;
1036	$pl->password ("*"); # this should lock out the player until we nuked the dir	1292	$pl->password ("*"); # this should lock out the player until we nuked the dir
1037		1293
1038	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1294	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1043	my $path = playerdir $pl;	1299	my $path = playerdir $pl;
1044	my $temp = "$path~$cf::RUNTIME~deleting~";	1300	my $temp = "$path~$cf::RUNTIME~deleting~";
1045	aio_rename $path, $temp;	1301	aio_rename $path, $temp;
1046	delete $cf::PLAYER{$pl->ob->name};	1302	delete $cf::PLAYER{$pl->ob->name};
1047	$pl->destroy;	1303	$pl->destroy;
		1304
		1305	my $prefix = qr<^~\Q$name\E/>;
		1306
		1307	# nuke player maps
		1308	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1309
1048	IO::AIO::aio_rmtree $temp;	1310	IO::AIO::aio_rmtree $temp;
		1311	}
		1312
		1313	=item $pl->kick
		1314
		1315	Kicks a player out of the game. This destroys the connection.
		1316
		1317	=cut
		1318
		1319	sub kick {
		1320	my ($pl, $kicker) = @_;
		1321
		1322	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1323	$pl->killer ("kicked");
		1324	$pl->ns->destroy;
1049	}	1325	}
1050		1326
1051	=item cf::player::list_logins	1327	=item cf::player::list_logins
1052		1328
1053	Returns am arrayref of all valid playernames in the system, can take a	1329	Returns am arrayref of all valid playernames in the system, can take a
1054	while and may block, so not sync_job-capable, ever.	1330	while and may block, so not sync_job-capable, ever.
1055		1331
1056	=cut	1332	=cut
1057		1333
1058	sub list_logins {	1334	sub list_logins {
1059	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1335	my $dirs = aio_readdir $PLAYERDIR
1060	or return [];	1336	or return [];
1061		1337
1062	my @logins;	1338	my @logins;
1063		1339
1064	for my $login (@$dirs) {	1340	for my $login (@$dirs) {
…		…
1099	}	1375	}
1100		1376
1101	\@paths	1377	\@paths
1102	}	1378	}
1103		1379
		1380	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1381
		1382	Expand crossfire pod fragments into protocol xml.
		1383
		1384	=cut
		1385
		1386	sub expand_cfpod {
		1387	((my $self), (local $_)) = @_;
		1388
		1389	# escape & and <
		1390	s/&/&amp;/g;
		1391	s/(?<![BIUGH])</&lt;/g;
		1392
		1393	# this is buggy, it needs to properly take care of nested <'s
		1394
		1395	1 while
		1396	# replace B<>, I<>, U<> etc.
		1397	s/B<([^\>]*)>/<b>$1<\/b>/
		1398	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1399	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1400	# replace G<male|female> tags
		1401	|| s{G<([^>|]*)\|([^>]*)>}{
		1402	$self->gender ? $2 : $1
		1403	}ge
		1404	# replace H<hint text>
		1405	|| s{H<([^\>]*)>}
		1406	{
		1407	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1408	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1409	"")
		1410	[$self->{hintmode}]
		1411	}ge;
		1412
		1413	# create single paragraphs (very hackish)
		1414	s/(?<=\S)\n(?=\w)/ /g;
		1415
		1416	# compress some whitespace
		1417	s/\s+\n/\n/g; # ws line-ends
		1418	s/\n\n+/\n/g; # double lines
		1419	s/^\n+//; # beginning lines
		1420	s/\n+$//; # ending lines
		1421
		1422	$_
		1423	}
		1424
		1425	sub hintmode {
		1426	$_[0]{hintmode} = $_[1] if @_ > 1;
		1427	$_[0]{hintmode}
		1428	}
		1429
1104	=item $player->ext_reply ($msgid, $msgtype, %msg)	1430	=item $player->ext_reply ($msgid, %msg)
1105		1431
1106	Sends an ext reply to the player.	1432	Sends an ext reply to the player.
1107		1433
1108	=cut	1434	=cut
1109		1435
1110	sub ext_reply($$$%) {	1436	sub ext_reply($$%) {
1111	my ($self, $id, %msg) = @_;	1437	my ($self, $id, %msg) = @_;
1112		1438
1113	$msg{msgid} = $id;	1439	$msg{msgid} = $id;
1114		1440	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1115	$self->send ("ext " . cf::to_json \%msg);
1116	}	1441	}
1117		1442
1118	package cf;	1443	=item $player->ext_event ($type, %msg)
		1444
		1445	Sends an ext event to the client.
		1446
		1447	=cut
		1448
		1449	sub ext_event($$%) {
		1450	my ($self, $type, %msg) = @_;
		1451
		1452	$self->ns->ext_event ($type, %msg);
		1453	}
		1454
		1455	=head3 cf::region
		1456
		1457	=over 4
		1458
		1459	=cut
		1460
		1461	package cf::region;
		1462
		1463	=item cf::region::find_by_path $path
		1464
		1465	Tries to decuce the likely region for a map knowing only its path.
		1466
		1467	=cut
		1468
		1469	sub find_by_path($) {
		1470	my ($path) = @_;
		1471
		1472	my ($match, $specificity);
		1473
		1474	for my $region (list) {
		1475	if ($region->match && $path =~ $region->match) {
		1476	($match, $specificity) = ($region, $region->specificity)
		1477	if $region->specificity > $specificity;
		1478	}
		1479	}
		1480
		1481	$match
		1482	}
1119		1483
1120	=back	1484	=back
1121
1122		1485
1123	=head3 cf::map	1486	=head3 cf::map
1124		1487
1125	=over 4	1488	=over 4
1126		1489
…		…
1181	my ($self, $merge) = @_;	1544	my ($self, $merge) = @_;
1182		1545
1183	# we have to keep some variables in memory intact	1546	# we have to keep some variables in memory intact
1184	local $self->{path};	1547	local $self->{path};
1185	local $self->{load_path};	1548	local $self->{load_path};
1186	local $self->{deny_save};
1187	local $self->{deny_reset};
1188		1549
1189	$self->SUPER::thawer_merge ($merge);	1550	$self->SUPER::thawer_merge ($merge);
1190	}	1551	}
1191		1552
1192	sub normalise {	1553	sub normalise {
…		…
1264		1625
1265	# the original (read-only) location	1626	# the original (read-only) location
1266	sub load_path {	1627	sub load_path {
1267	my ($self) = @_;	1628	my ($self) = @_;
1268		1629
1269	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1630	"$MAPDIR/$self->{path}.map"
1270	}	1631	}
1271		1632
1272	# the temporary/swap location	1633	# the temporary/swap location
1273	sub save_path {	1634	sub save_path {
1274	my ($self) = @_;	1635	my ($self) = @_;
1275		1636
1276	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1637	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1638	"$TMPDIR/$path.map"
1278	}	1639	}
1279		1640
1280	# the unique path, undef == no special unique path	1641	# the unique path, undef == no special unique path
1281	sub uniq_path {	1642	sub uniq_path {
1282	my ($self) = @_;	1643	my ($self) = @_;
1283		1644
1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1645	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1646	"$UNIQUEDIR/$path"
1286	}	1647	}
1287		1648
1288	# and all this just because we cannot iterate over	1649	# and all this just because we cannot iterate over
1289	# all maps in C++...	1650	# all maps in C++...
1290	sub change_all_map_light {	1651	sub change_all_map_light {
1291	my ($change) = @_;	1652	my ($change) = @_;
1292		1653
1293	$_->change_map_light ($change)	1654	$_->change_map_light ($change)
1294	for grep $_->outdoor, values %cf::MAP;	1655	for grep $_->outdoor, values %cf::MAP;
		1656	}
		1657
		1658	sub decay_objects {
		1659	my ($self) = @_;
		1660
		1661	return if $self->{deny_reset};
		1662
		1663	$self->do_decay_objects;
1295	}	1664	}
1296		1665
1297	sub unlink_save {	1666	sub unlink_save {
1298	my ($self) = @_;	1667	my ($self) = @_;
1299		1668
…		…
1357	$self->load_header_orig	1726	$self->load_header_orig
1358	or return;	1727	or return;
1359	$self->prepare_orig;	1728	$self->prepare_orig;
1360	}	1729	}
1361		1730
		1731	$self->{deny_reset} = 1
		1732	if $self->no_reset;
		1733
		1734	$self->default_region (cf::region::find_by_path $self->{path})
		1735	unless $self->default_region;
		1736
1362	1	1737	1
1363	}	1738	}
1364		1739
1365	sub find;	1740	sub find;
1366	sub find {	1741	sub find {
…		…
1378	$map->{last_save} = $cf::RUNTIME;	1753	$map->{last_save} = $cf::RUNTIME;
1379		1754
1380	$map->load_header	1755	$map->load_header
1381	or return;	1756	or return;
1382		1757
1383	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1758	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1384	# doing this can freeze the server in a sync job, obviously	1759	# doing this can freeze the server in a sync job, obviously
1385	#$cf::WAIT_FOR_TICK->wait;	1760	#$cf::WAIT_FOR_TICK->wait;
1386	$map->reset;	1761	$map->reset;
1387	undef $guard;	1762	undef $guard;
1388	return find $path;	1763	return find $path;
…		…
1399	my ($self) = @_;	1774	my ($self) = @_;
1400		1775
1401	local $self->{deny_reset} = 1; # loading can take a long time	1776	local $self->{deny_reset} = 1; # loading can take a long time
1402		1777
1403	my $path = $self->{path};	1778	my $path = $self->{path};
		1779
		1780	{
1404	my $guard = cf::lock_acquire "map_load:$path";	1781	my $guard = cf::lock_acquire "map_load:$path";
1405		1782
1406	return if $self->in_memory != cf::MAP_SWAPPED;	1783	return if $self->in_memory != cf::MAP_SWAPPED;
1407		1784
1408	$self->in_memory (cf::MAP_LOADING);	1785	$self->in_memory (cf::MAP_LOADING);
1409		1786
1410	$self->alloc;	1787	$self->alloc;
1411		1788
1412	$self->pre_load;	1789	$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;	1790	Coro::cede;
1438	$self->set_darkness_map;	1791
		1792	$self->_load_objects ($self->{load_path}, 1)
		1793	or return;
		1794
		1795	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1796	if delete $self->{load_original};
		1797
		1798	if (my $uniq = $self->uniq_path) {
		1799	utf8::encode $uniq;
		1800	if (aio_open $uniq, O_RDONLY, 0) {
		1801	$self->clear_unique_items;
		1802	$self->_load_objects ($uniq, 0);
		1803	}
		1804	}
		1805
		1806	Coro::cede;
		1807	# now do the right thing for maps
		1808	$self->link_multipart_objects;
1439	$self->difficulty ($self->estimate_difficulty)	1809	$self->difficulty ($self->estimate_difficulty)
1440	unless $self->difficulty;	1810	unless $self->difficulty;
1441	Coro::cede;	1811	Coro::cede;
		1812
		1813	unless ($self->{deny_activate}) {
		1814	$self->decay_objects;
		1815	$self->fix_auto_apply;
		1816	$self->update_buttons;
		1817	Coro::cede;
		1818	$self->set_darkness_map;
		1819	Coro::cede;
1442	$self->activate;	1820	$self->activate;
		1821	}
		1822
		1823	$self->in_memory (cf::MAP_IN_MEMORY);
1443	}	1824	}
1444		1825
1445	$self->post_load;	1826	$self->post_load;
1446
1447	$self->in_memory (cf::MAP_IN_MEMORY);
1448	}	1827	}
1449		1828
1450	sub customise_for {	1829	sub customise_for {
1451	my ($self, $ob) = @_;	1830	my ($self, $ob) = @_;
1452		1831
1453	return find "~" . $ob->name . "/" . $self->{path}	1832	return find "~" . $ob->name . "/" . $self->{path}
1454	if $self->per_player;	1833	if $self->per_player;
		1834
		1835	# return find "?party/" . $ob->name . "/" . $self->{path}
		1836	# if $self->per_party;
1455		1837
1456	$self	1838	$self
1457	}	1839	}
1458		1840
1459	# find and load all maps in the 3x3 area around a map	1841	# find and load all maps in the 3x3 area around a map
…		…
1570		1952
1571	sub reset_at {	1953	sub reset_at {
1572	my ($self) = @_;	1954	my ($self) = @_;
1573		1955
1574	# TODO: safety, remove and allow resettable per-player maps	1956	# 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};	1957	return 1e99 if $self->{deny_reset};
1577		1958
1578	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1959	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1579	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1960	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1580		1961
…		…
1591	my ($self) = @_;	1972	my ($self) = @_;
1592		1973
1593	my $lock = cf::lock_acquire "map_data:$self->{path}";	1974	my $lock = cf::lock_acquire "map_data:$self->{path}";
1594		1975
1595	return if $self->players;	1976	return if $self->players;
1596	return if $self->isa ("ext::map_per_player");#d#
1597		1977
1598	warn "resetting map ", $self->path;#d#	1978	warn "resetting map ", $self->path;
1599		1979
1600	$self->in_memory (cf::MAP_SWAPPED);	1980	$self->in_memory (cf::MAP_SWAPPED);
1601		1981
1602	# need to save uniques path	1982	# need to save uniques path
1603	unless ($self->{deny_save}) {	1983	unless ($self->{deny_save}) {
…		…
1635	$cf::MAP{$self->path} = $self;	2015	$cf::MAP{$self->path} = $self;
1636		2016
1637	$self->reset; # polite request, might not happen	2017	$self->reset; # polite request, might not happen
1638	}	2018	}
1639		2019
		2020	=item $maps = cf::map::tmp_maps
		2021
		2022	Returns an arrayref with all map paths of currently instantiated and saved
		2023	maps. May block.
		2024
		2025	=cut
		2026
		2027	sub tmp_maps() {
		2028	[
		2029	map {
		2030	utf8::decode $_;
		2031	/\.map$/
		2032	? normalise $_
		2033	: ()
		2034	} @{ aio_readdir $TMPDIR or [] }
		2035	]
		2036	}
		2037
		2038	=item $maps = cf::map::random_maps
		2039
		2040	Returns an arrayref with all map paths of currently instantiated and saved
		2041	random maps. May block.
		2042
		2043	=cut
		2044
		2045	sub random_maps() {
		2046	[
		2047	map {
		2048	utf8::decode $_;
		2049	/\.map$/
		2050	? normalise "?random/$_"
		2051	: ()
		2052	} @{ aio_readdir $RANDOMDIR or [] }
		2053	]
		2054	}
		2055
1640	=item cf::map::unique_maps	2056	=item cf::map::unique_maps
1641		2057
1642	Returns an arrayref of paths of all shared maps that have	2058	Returns an arrayref of paths of all shared maps that have
1643	instantiated unique items. May block.	2059	instantiated unique items. May block.
1644		2060
1645	=cut	2061	=cut
1646		2062
1647	sub unique_maps() {	2063	sub unique_maps() {
1648	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2064	[
1649	or return;	2065	map {
1650
1651	my @paths;
1652
1653	for (@$files) {
1654	utf8::decode $_;	2066	utf8::decode $_;
1655	next if /\.pst$/;	2067	/\.map$/
1656	next unless /^$PATH_SEP/o;	2068	? normalise $_
1657		2069	: ()
1658	push @paths, cf::map::normalise $_;	2070	} @{ aio_readdir $UNIQUEDIR or [] }
1659	}	2071	]
1660
1661	\@paths
1662	}	2072	}
1663		2073
1664	package cf;	2074	package cf;
1665		2075
1666	=back	2076	=back
…		…
1712		2122
1713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2123	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1714		2124
1715	if ($self->{record_replies}) {	2125	if ($self->{record_replies}) {
1716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2126	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2127
1717	} else {	2128	} else {
		2129	my $pl = $self->contr;
		2130
		2131	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2132	my $diag = $pl->{npc_dialog};
		2133	$diag->{pl}->ext_reply (
		2134	$diag->{id},
		2135	msgtype => "reply",
		2136	msg => $diag->{pl}->expand_cfpod ($msg),
		2137	add_topics => []
		2138	);
		2139
		2140	} else {
1718	$msg = $npc->name . " says: $msg" if $npc;	2141	$msg = $npc->name . " says: $msg" if $npc;
1719	$self->message ($msg, $flags);	2142	$self->message ($msg, $flags);
		2143	}
1720	}	2144	}
1721	}	2145	}
1722		2146
1723	=item $player_object->may ("access")	2147	=item $player_object->may ("access")
1724		2148
…		…
1772	$self->deactivate_recursive;	2196	$self->deactivate_recursive;
1773		2197
1774	return if UNIVERSAL::isa $self->map, "ext::map_link";	2198	return if UNIVERSAL::isa $self->map, "ext::map_link";
1775		2199
1776	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2200	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1777	if $self->map;	2201	if $self->map && $self->map->{path} ne "{link}";
1778		2202
1779	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2203	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1780	}	2204	}
1781		2205
1782	sub cf::object::player::leave_link {	2206	sub cf::object::player::leave_link {
1783	my ($self, $map, $x, $y) = @_;	2207	my ($self, $map, $x, $y) = @_;
		2208
		2209	return unless $self->contr->active;
1784		2210
1785	my $link_pos = delete $self->{_link_pos};	2211	my $link_pos = delete $self->{_link_pos};
1786		2212
1787	unless ($map) {	2213	unless ($map) {
1788	# restore original map position	2214	# restore original map position
…		…
1811		2237
1812	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2238	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813	$self->enter_map ($map, $x, $y);	2239	$self->enter_map ($map, $x, $y);
1814	}	2240	}
1815		2241
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)	2242	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1849		2243
		2244	Moves the player to the given map-path and coordinates by first freezing
		2245	her, loading and preparing them map, calling the provided $check callback
		2246	that has to return the map if sucecssful, and then unfreezes the player on
		2247	the new (success) or old (failed) map position.
		2248
1850	=cut	2249	=cut
		2250
		2251	our $GOTOGEN;
1851		2252
1852	sub cf::object::player::goto {	2253	sub cf::object::player::goto {
1853	my ($self, $path, $x, $y) = @_;	2254	my ($self, $path, $x, $y, $check) = @_;
		2255
		2256	# do generation counting so two concurrent goto's will be executed in-order
		2257	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854		2258
1855	$self->enter_link;	2259	$self->enter_link;
1856		2260
1857	(async {	2261	(async {
1858	my $map = eval {	2262	my $map = eval {
1859	my $map = cf::map::find $path;	2263	my $map = cf::map::find $path;
		2264
		2265	if ($map) {
1860	$map = $map->customise_for ($self) if $map;	2266	$map = $map->customise_for ($self);
		2267	$map = $check->($map) if $check && $map;
		2268	} else {
		2269	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2270	}
		2271
1861	$map	2272	$map
		2273	};
		2274
		2275	if ($@) {
		2276	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2277	LOG llevError | logBacktrace, Carp::longmess $@;
1862	} or	2278	}
1863	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864		2279
		2280	if ($gen == $self->{_goto_generation}) {
		2281	delete $self->{_goto_generation};
1865	$self->leave_link ($map, $x, $y);	2282	$self->leave_link ($map, $x, $y);
		2283	}
1866	})->prio (1);	2284	})->prio (1);
1867	}	2285	}
1868		2286
1869	=item $player_object->enter_exit ($exit_object)	2287	=item $player_object->enter_exit ($exit_object)
1870		2288
…		…
1909		2327
1910	$rmp->{random_seed} ||= $exit->random_seed;	2328	$rmp->{random_seed} ||= $exit->random_seed;
1911		2329
1912	my $data = cf::to_json $rmp;	2330	my $data = cf::to_json $rmp;
1913	my $md5 = Digest::MD5::md5_hex $data;	2331	my $md5 = Digest::MD5::md5_hex $data;
1914	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2332	my $meta = "$RANDOMDIR/$md5.meta";
1915		2333
1916	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2334	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917	aio_write $fh, 0, (length $data), $data, 0;	2335	aio_write $fh, 0, (length $data), $data, 0;
1918	undef $fh;	2336	undef $fh;
1919	aio_rename "$meta~", $meta;	2337	aio_rename "$meta~", $meta;
…		…
1928		2346
1929	return unless $self->type == cf::PLAYER;	2347	return unless $self->type == cf::PLAYER;
1930		2348
1931	if ($exit->slaying eq "/!") {	2349	if ($exit->slaying eq "/!") {
1932	#TODO: this should de-fi-ni-te-ly not be a sync-job	2350	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2351	# the problem is that $exit might not survive long enough
		2352	# so it needs to be done right now, right here
1933	cf::sync_job { prepare_random_map $exit };	2353	cf::sync_job { prepare_random_map $exit };
1934	}	2354	}
1935		2355
1936	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2356	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937	my $hp = $exit->stats->hp;	2357	my $hp = $exit->stats->hp;
…		…
1945	$self->goto ($slaying, $hp, $sp);	2365	$self->goto ($slaying, $hp, $sp);
1946		2366
1947	1;	2367	1;
1948	}) {	2368	}) {
1949	$self->message ("Something went wrong deep within the crossfire server. "	2369	$self->message ("Something went wrong deep within the crossfire server. "
1950	. "I'll try to bring you back to the map you were before. "	2370	. "I'll try to bring you back to the map you were before. "
1951	. "Please report this to the dungeon master!",	2371	. "Please report this to the dungeon master!",
1952	cf::NDI_UNIQUE | cf::NDI_RED);	2372	cf::NDI_UNIQUE | cf::NDI_RED);
1953		2373
1954	warn "ERROR in enter_exit: $@";	2374	warn "ERROR in enter_exit: $@";
1955	$self->leave_link;	2375	$self->leave_link;
1956	}	2376	}
1957	})->prio (1);	2377	})->prio (1);
…		…
1970		2390
1971	sub cf::client::send_drawinfo {	2391	sub cf::client::send_drawinfo {
1972	my ($self, $text, $flags) = @_;	2392	my ($self, $text, $flags) = @_;
1973		2393
1974	utf8::encode $text;	2394	utf8::encode $text;
1975	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2395	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976	}	2396	}
1977		2397
		2398	=item $client->send_msg ($color, $type, $msg, [extra...])
		2399
		2400	Send a drawinfo or msg packet to the client, formatting the msg for the
		2401	client if neccessary. C<$type> should be a string identifying the type of
		2402	the message, with C<log> being the default. If C<$color> is negative, suppress
		2403	the message unless the client supports the msg packet.
		2404
		2405	=cut
		2406
		2407	sub cf::client::send_msg {
		2408	my ($self, $color, $type, $msg, @extra) = @_;
		2409
		2410	$msg = $self->pl->expand_cfpod ($msg);
		2411
		2412	return unless @extra || length $msg;
		2413
		2414	if ($self->can_msg) {
		2415	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2416	} else {
		2417	# replace some tags by gcfclient-compatible ones
		2418	for ($msg) {
		2419	1 while
		2420	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2421	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2422	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2423	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2424	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2425	}
		2426
		2427	if ($color >= 0) {
		2428	if (0 && $msg =~ /\[/) {
		2429	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2430	} else {
		2431	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2432	$self->send_packet ("drawinfo $color $msg")
		2433	}
		2434	}
		2435	}
		2436	}
		2437
		2438	=item $client->ext_event ($type, %msg)
		2439
		2440	Sends an ext event to the client.
		2441
		2442	=cut
		2443
		2444	sub cf::client::ext_event($$%) {
		2445	my ($self, $type, %msg) = @_;
		2446
		2447	$msg{msgtype} = "event_$type";
		2448	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2449	}
1978		2450
1979	=item $success = $client->query ($flags, "text", \&cb)	2451	=item $success = $client->query ($flags, "text", \&cb)
1980		2452
1981	Queues a query to the client, calling the given callback with	2453	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>,	2454	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>.	2455	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984		2456
1985	Queries can fail, so check the return code. Or don't, as queries will become	2457	Queries can fail, so check the return code. Or don't, as queries will
1986	reliable at some point in the future.	2458	become reliable at some point in the future.
1987		2459
1988	=cut	2460	=cut
1989		2461
1990	sub cf::client::query {	2462	sub cf::client::query {
1991	my ($self, $flags, $text, $cb) = @_;	2463	my ($self, $flags, $text, $cb) = @_;
…		…
1999	utf8::encode $text;	2471	utf8::encode $text;
2000	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2472	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001		2473
2002	$self->send_packet ($self->{query_queue}[0][0])	2474	$self->send_packet ($self->{query_queue}[0][0])
2003	if @{ $self->{query_queue} } == 1;	2475	if @{ $self->{query_queue} } == 1;
		2476
		2477	1
2004	}	2478	}
2005		2479
2006	cf::client->attach (	2480	cf::client->attach (
		2481	on_connect => sub {
		2482	my ($ns) = @_;
		2483
		2484	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2485	},
2007	on_reply => sub {	2486	on_reply => sub {
2008	my ($ns, $msg) = @_;	2487	my ($ns, $msg) = @_;
2009		2488
2010	# this weird shuffling is so that direct followup queries	2489	# this weird shuffling is so that direct followup queries
2011	# get handled first	2490	# get handled first
…		…
2023	} else {	2502	} else {
2024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2503	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025	}	2504	}
2026	}	2505	}
2027	},	2506	},
		2507	on_exticmd => sub {
		2508	my ($ns, $buf) = @_;
		2509
		2510	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2511
		2512	if (ref $msg) {
		2513	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2514	if (my %reply = $cb->($ns, $msg)) {
		2515	$reply{msgid} = $msg->{msgid};
		2516	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2517	}
		2518	}
		2519	} else {
		2520	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2521	}
		2522
		2523	cf::override;
		2524	},
2028	);	2525	);
2029		2526
2030	=item $client->async (\&cb)	2527	=item $client->async (\&cb)
2031		2528
2032	Create a new coroutine, running the specified callback. The coroutine will	2529	Create a new coroutine, running the specified callback. The coroutine will
…		…
2079		2576
2080	# here we export the classes and methods available to script code	2577	# here we export the classes and methods available to script code
2081		2578
2082	=pod	2579	=pod
2083		2580
2084	The following fucntions and emthods are available within a safe environment:	2581	The following functions and methods are available within a safe environment:
2085		2582
2086	cf::object contr pay_amount pay_player map	2583	cf::object contr pay_amount pay_player map
2087	cf::object::player player	2584	cf::object::player player
2088	cf::player peaceful	2585	cf::player peaceful
2089	cf::map trigger	2586	cf::map trigger
…		…
2170	=back	2667	=back
2171		2668
2172	=cut	2669	=cut
2173		2670
2174	#############################################################################	2671	#############################################################################
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	2672	# the server's init and main functions
2248		2673
2249	sub init_resources {	2674	sub load_facedata($) {
2250	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2675	my ($path) = @_;
		2676
		2677	warn "loading facedata from $path\n";
		2678
		2679	my $facedata;
		2680	0 < aio_load $path, $facedata
		2681	or die "$path: $!";
		2682
		2683	$facedata = Coro::Storable::thaw $facedata;
		2684
		2685	$facedata->{version} == 2
		2686	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2687
		2688	{
		2689	my $faces = $facedata->{faceinfo};
		2690
		2691	while (my ($face, $info) = each %$faces) {
		2692	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2693	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2694	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2695	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2696	Coro::cede;
		2697	}
		2698
		2699	while (my ($face, $info) = each %$faces) {
		2700	next unless $info->{smooth};
		2701	my $idx = cf::face::find $face
		2702	or next;
		2703	if (my $smooth = cf::face::find $info->{smooth}) {
		2704	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2705	} else {
		2706	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2707	}
		2708	Coro::cede;
		2709	}
		2710	}
		2711
		2712	{
		2713	my $anims = $facedata->{animinfo};
		2714
		2715	while (my ($anim, $info) = each %$anims) {
		2716	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2717	Coro::cede;
		2718	}
		2719
		2720	cf::anim::invalidate_all; # d'oh
		2721	}
		2722
		2723	1
		2724	}
		2725
		2726	sub reload_regions {
		2727	load_resource_file "$MAPDIR/regions"
2251	or die "unable to load regions file\n";#d#	2728	or die "unable to load regions file\n";
		2729	}
		2730
		2731	sub reload_facedata {
		2732	load_facedata "$DATADIR/facedata"
		2733	or die "unable to load facedata\n";
		2734	}
		2735
		2736	sub reload_archetypes {
		2737	load_resource_file "$DATADIR/archetypes"
		2738	or die "unable to load archetypes\n";
		2739	#d# NEED to laod twice to resolve forward references
		2740	# this really needs to be done in an extra post-pass
		2741	# (which needs to be synchronous, so solve it differently)
		2742	load_resource_file "$DATADIR/archetypes"
		2743	or die "unable to load archetypes\n";
		2744	}
		2745
		2746	sub reload_treasures {
		2747	load_resource_file "$DATADIR/treasures"
		2748	or die "unable to load treasurelists\n";
		2749	}
		2750
		2751	sub reload_resources {
		2752	warn "reloading resource files...\n";
		2753
		2754	reload_regions;
		2755	reload_facedata;
		2756	#reload_archetypes;#d#
		2757	reload_archetypes;
		2758	reload_treasures;
		2759
		2760	warn "finished reloading resource files\n";
		2761	}
		2762
		2763	sub init {
		2764	reload_resources;
2252	}	2765	}
2253		2766
2254	sub cfg_load {	2767	sub cfg_load {
2255	open my $fh, "<:utf8", cf::confdir . "/config"	2768	open my $fh, "<:utf8", "$CONFDIR/config"
2256	or return;	2769	or return;
2257		2770
2258	local $/;	2771	local $/;
2259	*CFG = YAML::Syck::Load <$fh>;	2772	*CFG = YAML::Syck::Load <$fh>;
2260		2773
…		…
2268	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2781	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2269	and die "WARNING: m(un)lockall failed: $!\n";	2782	and die "WARNING: m(un)lockall failed: $!\n";
2270	};	2783	};
2271	warn $@ if $@;	2784	warn $@ if $@;
2272	}	2785	}
2273	}
2274
2275	sub init {
2276	init_resources;
2277	}	2786	}
2278		2787
2279	sub main {	2788	sub main {
2280	# we must not ever block the main coroutine	2789	# we must not ever block the main coroutine
2281	local $Coro::idle = sub {	2790	local $Coro::idle = sub {
…		…
2309	},	2818	},
2310	);	2819	);
2311	}	2820	}
2312	}	2821	}
2313		2822
		2823	sub write_runtime {
		2824	my $runtime = "$LOCALDIR/runtime";
		2825
		2826	# first touch the runtime file to show we are still running:
		2827	# the fsync below can take a very very long time.
		2828
		2829	IO::AIO::aio_utime $runtime, undef, undef;
		2830
		2831	my $guard = cf::lock_acquire "write_runtime";
		2832
		2833	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2834	or return;
		2835
		2836	my $value = $cf::RUNTIME + 90 + 10;
		2837	# 10 is the runtime save interval, for a monotonic clock
		2838	# 60 allows for the watchdog to kill the server.
		2839
		2840	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2841	and return;
		2842
		2843	# always fsync - this file is important
		2844	aio_fsync $fh
		2845	and return;
		2846
		2847	# touch it again to show we are up-to-date
		2848	aio_utime $fh, undef, undef;
		2849
		2850	close $fh
		2851	or return;
		2852
		2853	aio_rename "$runtime~", $runtime
		2854	and return;
		2855
		2856	warn "runtime file written.\n";
		2857
		2858	1
		2859	}
		2860
2314	sub emergency_save() {	2861	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	2862	my $freeze_guard = cf::freeze_mainloop;
2316		2863
2317	warn "enter emergency perl save\n";	2864	warn "enter emergency perl save\n";
2318		2865
…		…
2349		2896
2350	warn Carp::longmess "post_cleanup backtrace"	2897	warn Carp::longmess "post_cleanup backtrace"
2351	if $make_core;	2898	if $make_core;
2352	}	2899	}
2353		2900
2354	sub reload() {	2901	sub do_reload_perl() {
2355	# can/must only be called in main	2902	# can/must only be called in main
2356	if ($Coro::current != $Coro::main) {	2903	if ($Coro::current != $Coro::main) {
2357	warn "can only reload from main coroutine";	2904	warn "can only reload from main coroutine";
2358	return;	2905	return;
2359	}	2906	}
…		…
2384	Coro::cede;	2931	Coro::cede;
2385	last unless IO::AIO::nreqs || BDB::nreqs;	2932	last unless IO::AIO::nreqs || BDB::nreqs;
2386	warn "iterate...";	2933	warn "iterate...";
2387	}	2934	}
2388		2935
		2936	++$RELOAD;
		2937
2389	warn "cancelling all extension coros";	2938	warn "cancelling all extension coros";
2390	$_->cancel for values %EXT_CORO;	2939	$_->cancel for values %EXT_CORO;
2391	%EXT_CORO = ();	2940	%EXT_CORO = ();
2392		2941
2393	warn "removing commands";	2942	warn "removing commands";
2394	%COMMAND = ();	2943	%COMMAND = ();
2395		2944
2396	warn "removing ext commands";	2945	warn "removing ext/exti commands";
2397	%EXTCMD = ();	2946	%EXTCMD = ();
		2947	%EXTICMD = ();
2398		2948
2399	warn "unloading/nuking all extensions";	2949	warn "unloading/nuking all extensions";
2400	for my $pkg (@EXTS) {	2950	for my $pkg (@EXTS) {
2401	warn "... unloading $pkg";	2951	warn "... unloading $pkg";
2402		2952
…		…
2432	Symbol::delete_package "safe::$_"	2982	Symbol::delete_package "safe::$_"
2433	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2983	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2434		2984
2435	warn "unloading cf.pm \"a bit\"";	2985	warn "unloading cf.pm \"a bit\"";
2436	delete $INC{"cf.pm"};	2986	delete $INC{"cf.pm"};
		2987	delete $INC{"cf/pod.pm"};
2437		2988
2438	# don't, removes xs symbols, too,	2989	# don't, removes xs symbols, too,
2439	# and global variables created in xs	2990	# and global variables created in xs
2440	#Symbol::delete_package __PACKAGE__;	2991	#Symbol::delete_package __PACKAGE__;
2441		2992
…		…
2450		3001
2451	warn "loading extensions";	3002	warn "loading extensions";
2452	cf::load_extensions;	3003	cf::load_extensions;
2453		3004
2454	warn "reattaching attachments to objects/players";	3005	warn "reattaching attachments to objects/players";
2455	_global_reattach;	3006	_global_reattach; # objects, sockets
2456	warn "reattaching attachments to maps";	3007	warn "reattaching attachments to maps";
2457	reattach $_ for values %MAP;	3008	reattach $_ for values %MAP;
2458		3009	warn "reattaching attachments to players";
2459	warn "loading reloadable resources";	3010	reattach $_ for values %PLAYER;
2460	init_resources;
2461		3011
2462	warn "leaving sync_job";	3012	warn "leaving sync_job";
2463		3013
2464	1	3014	1
2465	} or do {	3015	} or do {
…		…
2471	warn "reloaded";	3021	warn "reloaded";
2472	};	3022	};
2473		3023
2474	our $RELOAD_WATCHER; # used only during reload	3024	our $RELOAD_WATCHER; # used only during reload
2475		3025
		3026	sub reload_perl() {
		3027	# doing reload synchronously and two reloads happen back-to-back,
		3028	# coro crashes during coro_state_free->destroy here.
		3029
		3030	$RELOAD_WATCHER ||= Event->timer (
		3031	reentrant => 0,
		3032	after => 0,
		3033	data => WF_AUTOCANCEL,
		3034	cb => sub {
		3035	do_reload_perl;
		3036	undef $RELOAD_WATCHER;
		3037	},
		3038	);
		3039	}
		3040
2476	register_command "reload" => sub {	3041	register_command "reload" => sub {
2477	my ($who, $arg) = @_;	3042	my ($who, $arg) = @_;
2478		3043
2479	if ($who->flag (FLAG_WIZ)) {	3044	if ($who->flag (FLAG_WIZ)) {
2480	$who->message ("reloading server.");	3045	$who->message ("reloading server.");
2481		3046	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	}	3047	}
2495	};	3048	};
2496		3049
2497	unshift @INC, $LIBDIR;	3050	unshift @INC, $LIBDIR;
2498		3051
2499	my $bug_warning = 0;	3052	my $bug_warning = 0;
2500		3053
		3054	our @WAIT_FOR_TICK;
		3055	our @WAIT_FOR_TICK_BEGIN;
		3056
		3057	sub wait_for_tick {
		3058	return unless $TICK_WATCHER->is_active;
		3059	return if $Coro::current == $Coro::main;
		3060
		3061	my $signal = new Coro::Signal;
		3062	push @WAIT_FOR_TICK, $signal;
		3063	$signal->wait;
		3064	}
		3065
		3066	sub wait_for_tick_begin {
		3067	return unless $TICK_WATCHER->is_active;
		3068	return if $Coro::current == $Coro::main;
		3069
		3070	my $signal = new Coro::Signal;
		3071	push @WAIT_FOR_TICK_BEGIN, $signal;
		3072	$signal->wait;
		3073	}
		3074
		3075	my $min = 1e6;#d#
		3076	my $avg = 10;
2501	$TICK_WATCHER = Event->timer (	3077	$TICK_WATCHER = Event->timer (
2502	reentrant => 0,	3078	reentrant => 0,
2503	parked => 1,	3079	parked => 1,
2504	prio => 0,	3080	prio => 0,
2505	at => $NEXT_TICK || $TICK,	3081	at => $NEXT_TICK || $TICK,
…		…
2509	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3085	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2510	unless ++$bug_warning > 10;	3086	unless ++$bug_warning > 10;
2511	return;	3087	return;
2512	}	3088	}
2513		3089
2514	$NOW = Event::time;	3090	$NOW = $tick_start = Event::time;
2515		3091
2516	cf::server_tick; # one server iteration	3092	cf::server_tick; # one server iteration
		3093
		3094	0 && sync_job {#d#
		3095	for(1..10) {
		3096	my $t = Event::time;
		3097	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3098	or die;
		3099
		3100	$map->width (50);
		3101	$map->height (50);
		3102	$map->alloc;
		3103	$map->_load_objects ("/tmp/x.map", 1);
		3104	my $t = Event::time - $t;
		3105
		3106	#next unless $t < 0.0013;#d#
		3107	if ($t < $min) {
		3108	$min = $t;
		3109	}
		3110	$avg = $avg * 0.99 + $t * 0.01;
		3111	}
		3112	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3113	exit 0;
		3114	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3115	};
		3116
2517	$RUNTIME += $TICK;	3117	$RUNTIME += $TICK;
2518	$NEXT_TICK += $TICK;	3118	$NEXT_TICK += $TICK;
2519		3119
2520	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3120	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2521	$NEXT_RUNTIME_WRITE = $NOW + 10;	3121	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2523	write_runtime	3123	write_runtime
2524	or warn "ERROR: unable to write runtime file: $!";	3124	or warn "ERROR: unable to write runtime file: $!";
2525	};	3125	};
2526	}	3126	}
2527		3127
2528	$WAIT_FOR_TICK->broadcast;
2529	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2530
2531	# my $AFTER = Event::time;	3128	# my $AFTER = Event::time;
2532	# warn $AFTER - $NOW;#d#	3129	# warn $AFTER - $NOW;#d#
2533		3130
		3131	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3132	$sig->send;
		3133	}
		3134	while (my $sig = shift @WAIT_FOR_TICK) {
		3135	$sig->send;
		3136	}
		3137
		3138	$NOW = Event::time;
		3139
2534	# if we are delayed by four ticks or more, skip them all	3140	# if we are delayed by four ticks or more, skip them all
2535	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3141	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2536		3142
2537	$TICK_WATCHER->at ($NEXT_TICK);	3143	$TICK_WATCHER->at ($NEXT_TICK);
2538	$TICK_WATCHER->start;	3144	$TICK_WATCHER->start;
		3145
		3146	$LOAD = ($NOW - $tick_start) / $TICK;
		3147	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3148
		3149	_post_tick;
		3150
		3151
2539	},	3152	},
2540	);	3153	);
2541		3154
2542	{	3155	{
2543	BDB::max_poll_time $TICK * 0.1;	3156	BDB::max_poll_time $TICK * 0.1;
…		…
2571		3184
2572	cf::sync_job {	3185	cf::sync_job {
2573	eval {	3186	eval {
2574	BDB::db_env_open	3187	BDB::db_env_open
2575	$DB_ENV,	3188	$DB_ENV,
2576	$BDB_ENV_DIR,	3189	$BDBDIR,
2577	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3190	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2578	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3191	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2579	0666;	3192	0666;
2580		3193
2581	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3194	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2582		3195
2583	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3196	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2584	$DB_ENV->set_lk_detect;	3197	$DB_ENV->set_lk_detect;
2585	};	3198	};
2586		3199
…		…
2602	prio => 6,	3215	prio => 6,
2603	cb => \&IO::AIO::poll_cb,	3216	cb => \&IO::AIO::poll_cb,
2604	);	3217	);
2605	}	3218	}
2606		3219
		3220	my $_log_backtrace;
		3221
		3222	sub _log_backtrace {
		3223	my ($msg, @addr) = @_;
		3224
		3225	$msg =~ s/\n//;
		3226
		3227	# limit the # of concurrent backtraces
		3228	if ($_log_backtrace < 2) {
		3229	++$_log_backtrace;
		3230	async {
		3231	my @bt = fork_call {
		3232	@addr = map { sprintf "%x", $_ } @addr;
		3233	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3234	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3235	or die "addr2line: $!";
		3236
		3237	my @funcs;
		3238	my @res = <$fh>;
		3239	chomp for @res;
		3240	while (@res) {
		3241	my ($func, $line) = splice @res, 0, 2, ();
		3242	push @funcs, "[$func] $line";
		3243	}
		3244
		3245	@funcs
		3246	};
		3247
		3248	LOG llevInfo, "[ABT] $msg\n";
		3249	LOG llevInfo, "[ABT] $_\n" for @bt;
		3250	--$_log_backtrace;
		3251	};
		3252	} else {
		3253	LOG llevInfo, "[ABT] $msg\n";
		3254	LOG llevInfo, "[ABT] [suppressed]\n";
		3255	}
		3256	}
		3257
		3258	# load additional modules
		3259	use cf::pod;
		3260
2607	END { cf::emergency_save }	3261	END { cf::emergency_save }
2608		3262
2609	1	3263	1
2610		3264

Diff Legend

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