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.227 by root, Fri Mar 23 18:32:48 2007 UTC vs.
Revision 1.311 by root, Fri Jul 20 16:11:10 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;
26	use YAML::Syck ();	30	use YAML::Syck ();
27	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
28	use Time::HiRes;	32	use Time::HiRes;
29	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
30		35
31	# configure various modules to our taste	36	# configure various modules to our taste
32	#	37	#
		38	$Storable::canonical = 1; # reduce rsync transfers
33	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
34	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
35		41
36	$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
37		43
…		…
45	our %COMMAND = ();	51	our %COMMAND = ();
46	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
47		53
48	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
49	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
50	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
51	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
52		59
53	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
54	our @EVENT;	61	our @EVENT;
55	our $LIBDIR = datadir . "/ext";
56		62
57	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(!)
58	our $TICK_WATCHER;	76	our $TICK_WATCHER;
59	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
60	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61	our $NEXT_TICK;	79	our $NEXT_TICK;
62	our $NOW;	80	our $NOW;
…		…
71	our $RUNTIME;	89	our $RUNTIME;
72		90
73	our %PLAYER; # all users	91	our %PLAYER; # all users
74	our %MAP; # all maps	92	our %MAP; # all maps
75	our $LINK_MAP; # the special {link} map, which is always available	93	our $LINK_MAP; # the special {link} map, which is always available
76	our $RANDOM_MAPS = cf::localdir . "/random";
77	our $BDB_ENV_DIR = cf::localdir . "/db";
78
79	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81		94
82	# 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 ∕
83	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84		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
85	binmode STDOUT;	102	binmode STDOUT;
86	binmode STDERR;	103	binmode STDERR;
87		104
88	# read virtual server time, if available	105	# read virtual server time, if available
89	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
91	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
92	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
93	}	110	}
94		111
95	mkdir cf::localdir;	112	mkdir $_
96	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97	mkdir cf::localdir . "/" . cf::tmpdir;
98	mkdir cf::localdir . "/" . cf::uniquedir;
99	mkdir $RANDOM_MAPS;
100	mkdir $BDB_ENV_DIR;
101		114
102	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
103		116
104	sub cf::map::normalise;	117	sub cf::map::normalise;
105		118
…		…
116	=item $cf::RUNTIME	129	=item $cf::RUNTIME
117		130
118	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
119	every server tick.	132	every server tick.
120		133
121	=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
122		137
123	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
124	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.
125		142
126	=item $cf::NOW	143	=item $cf::NOW
127		144
128	The time of the last (current) server tick.	145	The time of the last (current) server tick.
129		146
130	=item $cf::TICK	147	=item $cf::TICK
131		148
132	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.
133		160
134	=item %cf::CFG	161	=item %cf::CFG
135		162
136	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
137	from wherever your confdir points to.	164	from wherever your confdir points to.
138		165
139	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
140		167
141	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
142	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
143	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.
144	window of cpu time available, or simply to synchronise to the server tick.	171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
145		177
146	=back	178	=back
147		179
148	=cut	180	=cut
149		181
150	BEGIN {	182	BEGIN {
151	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
152	my $msg = join "", @_;	184	my $msg = join "", @_;
153	utf8::encode $msg;
154		185
155	$msg .= "\n"	186	$msg .= "\n"
156	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
157		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
158	LOG llevError, $msg;	192	LOG llevError, $msg;
159	};	193	};
160	}	194	}
161		195
162	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168		203
169	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
170	# within the Safe compartment.	205	# within the Safe compartment.
171	for my $pkg (qw(	206	for my $pkg (qw(
172	cf::global cf::attachable	207	cf::global cf::attachable
…		…
180	}	215	}
181		216
182	$Event::DIED = sub {	217	$Event::DIED = sub {
183	warn "error in event callback: @_";	218	warn "error in event callback: @_";
184	};	219	};
		220
		221	#############################################################################
185		222
186	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
187		224
188	=over 4	225	=over 4
189		226
…		…
208	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209	$d	246	$d
210	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
211	}	248	}
212		249
213	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
216		251
217	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
218		253
219	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
220		255
221	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
222		264
223	=item cf::lock_wait $string	265	=item cf::lock_wait $string
224		266
225	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
226		268
…		…
232	returned.	274	returned.
233		275
234	Lock names should begin with a unique identifier (for example, cf::map::find	276	Lock names should begin with a unique identifier (for example, cf::map::find
235	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
236		278
		279	=item $locked = cf::lock_active $string
		280
		281	Return true if the lock is currently active, i.e. somebody has locked it.
		282
237	=cut	283	=cut
238		284
239	our %LOCK;	285	our %LOCK;
240		286
241	sub lock_wait($) {	287	sub lock_wait($) {
…		…
258		304
259	Coro::guard {	305	Coro::guard {
260	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
261	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
262	}	308	}
		309	}
		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
263	}	315	}
264		316
265	sub freeze_mainloop {	317	sub freeze_mainloop {
266	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
267		319
…		…
282		334
283	BEGIN { *async = \&Coro::async_pool }	335	BEGIN { *async = \&Coro::async_pool }
284		336
285	=item cf::sync_job { BLOCK }	337	=item cf::sync_job { BLOCK }
286		338
287	The design of crossfire+ requires that the main coro ($Coro::main) is	339	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288	always able to handle events or runnable, as crossfire+ is only partly	340	is always able to handle events or runnable, as Crossfire TRT is only
289	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	341	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		342	acceptable.
290		343
291	If it must be done, put the blocking parts into C<sync_job>. This will run	344	If it must be done, put the blocking parts into C<sync_job>. This will run
292	the given BLOCK in another coroutine while waiting for the result. The	345	the given BLOCK in another coroutine while waiting for the result. The
293	server will be frozen during this time, so the block should either finish	346	server will be frozen during this time, so the block should either finish
294	fast or be very important.	347	fast or be very important.
…		…
297		350
298	sub sync_job(&) {	351	sub sync_job(&) {
299	my ($job) = @_;	352	my ($job) = @_;
300		353
301	if ($Coro::current == $Coro::main) {	354	if ($Coro::current == $Coro::main) {
		355	my $time = Event::time;
		356
302	# this is the main coro, too bad, we have to block	357	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	358	# till the operation succeeds, freezing the server :/
304		359
305	# TODO: use suspend/resume instead	360	# TODO: use suspend/resume instead
306	# (but this is cancel-safe)	361	# (but this is cancel-safe)
…		…
317		372
318	while ($busy) {	373	while ($busy) {
319	Coro::cede or Event::one_event;	374	Coro::cede or Event::one_event;
320	}	375	}
321		376
		377	$time = Event::time - $time;
		378
		379	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		380	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		381
		382	$tick_start += $time; # do not account sync jobs to server load
		383
322	wantarray ? @res : $res[0]	384	wantarray ? @res : $res[0]
323	} else {	385	} else {
324	# we are in another coroutine, how wonderful, everything just works	386	# we are in another coroutine, how wonderful, everything just works
325		387
326	$job->()	388	$job->()
…		…
345	$EXT_CORO{$coro+0} = $coro;	407	$EXT_CORO{$coro+0} = $coro;
346		408
347	$coro	409	$coro
348	}	410	}
349		411
350	sub write_runtime {	412	=item fork_call { }, $args
351	my $guard = cf::lock_acquire "write_runtime";
352		413
353	my $runtime = cf::localdir . "/runtime";	414	Executes the given code block with the given arguments in a seperate
		415	process, returning the results. Everything must be serialisable with
		416	Coro::Storable. May, of course, block. Note that the executed sub may
		417	never block itself or use any form of Event handling.
354		418
355	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	419	=cut
356	or return;
357		420
358	my $value = $cf::RUNTIME + 90 + 10;	421	sub _store_scalar {
359	# 10 is the runtime save interval, for a monotonic clock	422	open my $fh, ">", \my $buf
360	# 60 allows for the watchdog to kill the server.	423	or die "fork_call: cannot open fh-to-buf in child : $!";
361		424	Storable::store_fd $_[0], $fh;
362	(aio_write $fh, 0, (length $value), $value, 0) <= 0
363	and return;
364
365	# always fsync - this file is important
366	aio_fsync $fh
367	and return;
368
369	close $fh	425	close $fh;
370	or return;
371		426
372	aio_rename "$runtime~", $runtime	427	$buf
373	and return;	428	}
374		429
		430	sub fork_call(&@) {
		431	my ($cb, @args) = @_;
		432
		433	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		434	# or die "socketpair: $!";
		435	pipe my $fh1, my $fh2
		436	or die "pipe: $!";
		437
		438	if (my $pid = fork) {
		439	close $fh2;
		440
		441	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		442	warn "pst<$res>" unless $res =~ /^pst/;
		443	$res = Coro::Storable::thaw $res;
		444
		445	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		446
		447	Carp::confess $$res unless "ARRAY" eq ref $res;
		448
		449	return wantarray ? @$res : $res->[-1];
		450	} else {
		451	reset_signals;
		452	local $SIG{__WARN__};
		453	local $SIG{__DIE__};
		454	# just in case, this hack effectively disables event
		455	# in the child. cleaner and slower would be canceling all watchers,
		456	# but this works for the time being.
		457	local $Coro::idle;
		458	$Coro::current->prio (Coro::PRIO_MAX);
		459
		460	eval {
		461	close $fh1;
		462
		463	my @res = eval { $cb->(@args) };
		464
		465	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		466	close $fh2;
		467	};
		468
		469	warn $@ if $@;
		470	_exit 0;
375	1	471	}
		472	}
		473
		474	=item $value = cf::db_get $family => $key
		475
		476	Returns a single value from the environment database.
		477
		478	=item cf::db_put $family => $key => $value
		479
		480	Stores the given C<$value> in the family. It can currently store binary
		481	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		482
		483	=cut
		484
		485	our $DB;
		486
		487	sub db_init {
		488	unless ($DB) {
		489	$DB = BDB::db_create $DB_ENV;
		490
		491	cf::sync_job {
		492	eval {
		493	$DB->set_flags (BDB::CHKSUM);
		494
		495	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		496	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		497	cf::cleanup "db_open(db): $!" if $!;
		498	};
		499	cf::cleanup "db_open(db): $@" if $@;
		500	};
		501	}
		502	}
		503
		504	sub db_get($$) {
		505	my $key = "$_[0]/$_[1]";
		506
		507	cf::sync_job {
		508	BDB::db_get $DB, undef, $key, my $data;
		509
		510	$! ? ()
		511	: $data
		512	}
		513	}
		514
		515	sub db_put($$$) {
		516	BDB::dbreq_pri 4;
		517	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		518	}
		519
		520	=item cf::cache $id => [$paths...], $processversion => $process
		521
		522	Generic caching function that returns the value of the resource $id,
		523	caching and regenerating as required.
		524
		525	This function can block.
		526
		527	=cut
		528
		529	sub cache {
		530	my ($id, $src, $processversion, $process) = @_;
		531
		532	my $meta =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	aio_stat $_
		537	and Carp::croak "$_: $!";
		538
		539	($_, (stat _)[7,9])
		540	} @$src;
		541
		542	my $dbmeta = db_get cache => "$id/meta";
		543	if ($dbmeta ne $meta) {
		544	# changed, we may need to process
		545
		546	my @data;
		547	my $md5;
		548
		549	for (0 .. $#$src) {
		550	0 <= aio_load $src->[$_], $data[$_]
		551	or Carp::croak "$src->[$_]: $!";
		552	}
		553
		554	# if processing is expensive, check
		555	# checksum first
		556	if (1) {
		557	$md5 =
		558	join "\x00",
		559	$processversion,
		560	map {
		561	Coro::cede;
		562	($src->[$_], Digest::MD5::md5_hex $data[$_])
		563	} 0.. $#$src;
		564
		565
		566	my $dbmd5 = db_get cache => "$id/md5";
		567	if ($dbmd5 eq $md5) {
		568	db_put cache => "$id/meta", $meta;
		569
		570	return db_get cache => "$id/data";
		571	}
		572	}
		573
		574	my $t1 = Time::HiRes::time;
		575	my $data = $process->(\@data);
		576	my $t2 = Time::HiRes::time;
		577
		578	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		579
		580	db_put cache => "$id/data", $data;
		581	db_put cache => "$id/md5" , $md5;
		582	db_put cache => "$id/meta", $meta;
		583
		584	return $data;
		585	}
		586
		587	db_get cache => "$id/data"
		588	}
		589
		590	=item cf::datalog type => key => value, ...
		591
		592	Log a datalog packet of the given type with the given key-value pairs.
		593
		594	=cut
		595
		596	sub datalog($@) {
		597	my ($type, %kv) = @_;
		598	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
376	}	599	}
377		600
378	=back	601	=back
379		602
380	=cut	603	=cut
…		…
387	attach callbacks/event handlers (a collection of which is called an "attachment")	610	attach callbacks/event handlers (a collection of which is called an "attachment")
388	to it. All such attachable objects support the following methods.	611	to it. All such attachable objects support the following methods.
389		612
390	In the following description, CLASS can be any of C<global>, C<object>	613	In the following description, CLASS can be any of C<global>, C<object>
391	C<player>, C<client> or C<map> (i.e. the attachable objects in	614	C<player>, C<client> or C<map> (i.e. the attachable objects in
392	crossfire+).	615	Crossfire TRT).
393		616
394	=over 4	617	=over 4
395		618
396	=item $attachable->attach ($attachment, key => $value...)	619	=item $attachable->attach ($attachment, key => $value...)
397		620
…		…
560	$registry = $CB_TYPE[$object_type] ||= [];	783	$registry = $CB_TYPE[$object_type] ||= [];
561		784
562	} elsif ($type eq "subtype") {	785	} elsif ($type eq "subtype") {
563	defined $object_type or Carp::croak "subtype specified without type";	786	defined $object_type or Carp::croak "subtype specified without type";
564	my $object_subtype = shift @arg;	787	my $object_subtype = shift @arg;
565	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	788	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
566		789
567	} elsif ($type eq "package") {	790	} elsif ($type eq "package") {
568	my $pkg = shift @arg;	791	my $pkg = shift @arg;
569		792
570	while (my ($name, $id) = each %cb_id) {	793	while (my ($name, $id) = each %cb_id) {
…		…
599	_attach $registry, $klass, @attach;	822	_attach $registry, $klass, @attach;
600	}	823	}
601		824
602	$obj->{$name} = \%arg;	825	$obj->{$name} = \%arg;
603	} else {	826	} else {
604	warn "object uses attachment '$name' that is not available, postponing.\n";	827	warn "object uses attachment '$name' which is not available, postponing.\n";
605	}	828	}
606		829
607	$obj->{_attachment}{$name} = undef;	830	$obj->{_attachment}{$name} = undef;
608	}	831	}
609		832
…		…
611	if (ref $_[0]) {	834	if (ref $_[0]) {
612	_object_attach @_;	835	_object_attach @_;
613	} else {	836	} else {
614	_attach shift->_attach_registry, @_;	837	_attach shift->_attach_registry, @_;
615	}	838	}
		839	_recalc_want;
616	};	840	};
617		841
618	# all those should be optimised	842	# all those should be optimised
619	sub cf::attachable::detach {	843	sub cf::attachable::detach {
620	my ($obj, $name) = @_;	844	my ($obj, $name) = @_;
…		…
623	delete $obj->{_attachment}{$name};	847	delete $obj->{_attachment}{$name};
624	reattach ($obj);	848	reattach ($obj);
625	} else {	849	} else {
626	Carp::croak "cannot, currently, detach class attachments";	850	Carp::croak "cannot, currently, detach class attachments";
627	}	851	}
		852	_recalc_want;
628	};	853	};
629		854
630	sub cf::attachable::attached {	855	sub cf::attachable::attached {
631	my ($obj, $name) = @_;	856	my ($obj, $name) = @_;
632		857
…		…
647	";	872	";
648	die if $@;	873	die if $@;
649	}	874	}
650		875
651	our $override;	876	our $override;
652	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	877	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
653		878
654	sub override {	879	sub override {
655	$override = 1;	880	$override = 1;
656	@invoke_results = ();	881	@INVOKE_RESULTS = (@_);
657	}	882	}
658		883
659	sub do_invoke {	884	sub do_invoke {
660	my $event = shift;	885	my $event = shift;
661	my $callbacks = shift;	886	my $callbacks = shift;
662		887
663	@invoke_results = ();	888	@INVOKE_RESULTS = ();
664		889
665	local $override;	890	local $override;
666		891
667	for (@$callbacks) {	892	for (@$callbacks) {
668	eval { &{$_->[1]} };	893	eval { &{$_->[1]} };
…		…
685		910
686	Generate an object-specific event with the given arguments.	911	Generate an object-specific event with the given arguments.
687		912
688	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	913	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
689	removed in future versions), and there is no public API to access override	914	removed in future versions), and there is no public API to access override
690	results (if you must, access C<@cf::invoke_results> directly).	915	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
691		916
692	=back	917	=back
693		918
694	=cut	919	=cut
695		920
…		…
805	or return;	1030	or return;
806	$av = eval { (Storable::thaw $av)->{objs} };	1031	$av = eval { (Storable::thaw $av)->{objs} };
807	}	1032	}
808		1033
809	warn sprintf "loading %s (%d)\n",	1034	warn sprintf "loading %s (%d)\n",
810	$filename, length $data, scalar @{$av || []};#d#	1035	$filename, length $data, scalar @{$av || []};
811	return ($data, $av);	1036	return ($data, $av);
812	}	1037	}
		1038
		1039	=head2 COMMAND CALLBACKS
		1040
		1041	=over 4
		1042
		1043	=cut
813		1044
814	#############################################################################	1045	#############################################################################
815	# command handling &c	1046	# command handling &c
816		1047
817	=item cf::register_command $name => \&callback($ob,$args);	1048	=item cf::register_command $name => \&callback($ob,$args);
…		…
830	push @{ $COMMAND{$name} }, [$caller, $cb];	1061	push @{ $COMMAND{$name} }, [$caller, $cb];
831	}	1062	}
832		1063
833	=item cf::register_extcmd $name => \&callback($pl,$packet);	1064	=item cf::register_extcmd $name => \&callback($pl,$packet);
834		1065
835	Register a callbackf ro execution when the client sends an extcmd packet.	1066	Register a callback for execution when the client sends an (synchronous)
		1067	extcmd packet. Ext commands will be processed in the order they are
		1068	received by the server, like other user commands. The first argument is
		1069	the logged-in player. Ext commands can only be processed after a player
		1070	has logged in successfully.
836		1071
837	If the callback returns something, it is sent back as if reply was being	1072	If the callback returns something, it is sent back as if reply was being
838	called.	1073	called.
839		1074
		1075	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1076
		1077	Register a callback for execution when the client sends an (asynchronous)
		1078	exticmd packet. Exti commands are processed by the server as soon as they
		1079	are received, i.e. out of order w.r.t. other commands. The first argument
		1080	is a client socket. Exti commands can be received anytime, even before
		1081	log-in.
		1082
		1083	If the callback returns something, it is sent back as if reply was being
		1084	called.
		1085
840	=cut	1086	=cut
841		1087
842	sub register_extcmd {	1088	sub register_extcmd {
843	my ($name, $cb) = @_;	1089	my ($name, $cb) = @_;
844		1090
845	$EXTCMD{$name} = $cb;	1091	$EXTCMD{$name} = $cb;
		1092	}
		1093
		1094	sub register_exticmd {
		1095	my ($name, $cb) = @_;
		1096
		1097	$EXTICMD{$name} = $cb;
846	}	1098	}
847		1099
848	cf::player->attach (	1100	cf::player->attach (
849	on_command => sub {	1101	on_command => sub {
850	my ($pl, $name, $params) = @_;	1102	my ($pl, $name, $params) = @_;
…		…
859	cf::override;	1111	cf::override;
860	},	1112	},
861	on_extcmd => sub {	1113	on_extcmd => sub {
862	my ($pl, $buf) = @_;	1114	my ($pl, $buf) = @_;
863		1115
864	my $msg = eval { from_json $buf };	1116	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
865		1117
866	if (ref $msg) {	1118	if (ref $msg) {
867	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1119	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
868	if (my %reply = $cb->($pl, $msg)) {	1120	if (my %reply = $cb->($pl, $msg)) {
869	$pl->ext_reply ($msg->{msgid}, %reply);	1121	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
875		1127
876	cf::override;	1128	cf::override;
877	},	1129	},
878	);	1130	);
879		1131
880	sub load_extension {
881	my ($path) = @_;
882
883	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
884	my $base = $1;
885	my $pkg = $1;
886	$pkg =~ s/[^[:word:]]/_/g;
887	$pkg = "ext::$pkg";
888
889	warn "... loading '$path' into '$pkg'\n";
890
891	open my $fh, "<:utf8", $path
892	or die "$path: $!";
893
894	my $source =
895	"package $pkg; use strict; use utf8;\n"
896	. "#line 1 \"$path\"\n{\n"
897	. (do { local $/; <$fh> })
898	. "\n};\n1";
899
900	unless (eval $source) {
901	my $msg = $@ ? "$path: $@\n"
902	: "extension disabled.\n";
903	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
904	warn $@;
905	warn "mandatory extension failed to load, exiting.\n";
906	exit 1;
907	}
908	die $@;
909	}
910
911	push @EXTS, $pkg;
912	}
913
914	sub load_extensions {	1132	sub load_extensions {
		1133	cf::sync_job {
		1134	my %todo;
		1135
915	for my $ext (<$LIBDIR/*.ext>) {	1136	for my $path (<$LIBDIR/*.ext>) {
916	next unless -r $ext;	1137	next unless -r $path;
917	eval {	1138
918	load_extension $ext;	1139	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1140	my $base = $1;
		1141	my $pkg = $1;
		1142	$pkg =~ s/[^[:word:]]/_/g;
		1143	$pkg = "ext::$pkg";
		1144
		1145	open my $fh, "<:utf8", $path
		1146	or die "$path: $!";
		1147
		1148	my $source = do { local $/; <$fh> };
		1149
		1150	my %ext = (
		1151	path => $path,
		1152	base => $base,
		1153	pkg => $pkg,
		1154	);
		1155
		1156	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1157	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1158
		1159	$ext{source} =
		1160	"package $pkg; use strict; use utf8;\n"
		1161	. "#line 1 \"$path\"\n{\n"
		1162	. $source
		1163	. "\n};\n1";
		1164
		1165	$todo{$base} = \%ext;
		1166	}
		1167
		1168	my %done;
		1169	while (%todo) {
		1170	my $progress;
		1171
		1172	while (my ($k, $v) = each %todo) {
		1173	for (split /,\s*/, $v->{meta}{depends}) {
		1174	goto skip
		1175	unless exists $done{$_};
		1176	}
		1177
		1178	warn "... loading '$k' into '$v->{pkg}'\n";
		1179
		1180	unless (eval $v->{source}) {
		1181	my $msg = $@ ? "$v->{path}: $@\n"
		1182	: "$v->{base}: extension inactive.\n";
		1183
		1184	if (exists $v->{meta}{mandatory}) {
		1185	warn $msg;
		1186	warn "mandatory extension failed to load, exiting.\n";
		1187	exit 1;
		1188	}
		1189
		1190	warn $msg;
		1191	}
		1192
		1193	$done{$k} = delete $todo{$k};
		1194	push @EXTS, $v->{pkg};
		1195	$progress = 1;
919	1	1196	}
920	} or warn "$ext not loaded: $@";	1197
		1198	skip:
		1199	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1200	unless $progress;
		1201	}
921	}	1202	};
922	}	1203	}
923		1204
924	#############################################################################	1205	#############################################################################
925		1206
		1207	=back
		1208
926	=head2 CORE EXTENSIONS	1209	=head2 CORE EXTENSIONS
927		1210
928	Functions and methods that extend core crossfire objects.	1211	Functions and methods that extend core crossfire objects.
929		1212
930	=cut	1213	=cut
…		…
942	Returns the given player object, loading it if necessary (might block).	1225	Returns the given player object, loading it if necessary (might block).
943		1226
944	=cut	1227	=cut
945		1228
946	sub playerdir($) {	1229	sub playerdir($) {
947	cf::localdir	1230	"$PLAYERDIR/"
948	. "/"
949	. cf::playerdir
950	. "/"
951	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1231	. (ref $_[0] ? $_[0]->ob->name : $_[0])
952	}	1232	}
953		1233
954	sub path($) {	1234	sub path($) {
955	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1235	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
956		1236
957	(playerdir $login) . "/$login.pl"	1237	(playerdir $login) . "/playerdata"
958	}	1238	}
959		1239
960	sub find_active($) {	1240	sub find_active($) {
961	$cf::PLAYER{$_[0]}	1241	$cf::PLAYER{$_[0]}
962	and $cf::PLAYER{$_[0]}->active	1242	and $cf::PLAYER{$_[0]}->active
…		…
975	my $login = $_[0];	1255	my $login = $_[0];
976		1256
977	my $guard = cf::lock_acquire "user_find:$login";	1257	my $guard = cf::lock_acquire "user_find:$login";
978		1258
979	$cf::PLAYER{$_[0]} || do {	1259	$cf::PLAYER{$_[0]} || do {
		1260	# rename old playerfiles to new ones
		1261	#TODO: remove when no longer required
		1262	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1263	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1264	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1265	aio_unlink +(playerdir $login) . "/$login.pl";
		1266
980	my $pl = load_pl path $login	1267	my $pl = load_pl path $login
981	or return;	1268	or return;
982	$cf::PLAYER{$login} = $pl	1269	$cf::PLAYER{$login} = $pl
983	}	1270	}
984	}	1271	}
…		…
1068	while and may block, so not sync_job-capable, ever.	1355	while and may block, so not sync_job-capable, ever.
1069		1356
1070	=cut	1357	=cut
1071		1358
1072	sub list_logins {	1359	sub list_logins {
1073	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1360	my $dirs = aio_readdir $PLAYERDIR
1074	or return [];	1361	or return [];
1075		1362
1076	my @logins;	1363	my @logins;
1077		1364
1078	for my $login (@$dirs) {	1365	for my $login (@$dirs) {
…		…
1113	}	1400	}
1114		1401
1115	\@paths	1402	\@paths
1116	}	1403	}
1117		1404
		1405	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1406
		1407	Expand crossfire pod fragments into protocol xml.
		1408
		1409	=cut
		1410
		1411	sub expand_cfpod {
		1412	((my $self), (local $_)) = @_;
		1413
		1414	# escape & and <
		1415	s/&/&amp;/g;
		1416	s/(?<![BIUGH])</&lt;/g;
		1417
		1418	# this is buggy, it needs to properly take care of nested <'s
		1419
		1420	1 while
		1421	# replace B<>, I<>, U<> etc.
		1422	s/B<([^\>]*)>/<b>$1<\/b>/
		1423	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1424	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1425	# replace G<male|female> tags
		1426	|| s{G<([^>|]*)\|([^>]*)>}{
		1427	$self->gender ? $2 : $1
		1428	}ge
		1429	# replace H<hint text>
		1430	|| s{H<([^\>]*)>}
		1431	{
		1432	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1433	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1434	"")
		1435	[$self->{hintmode}]
		1436	}ge;
		1437
		1438	# create single paragraphs (very hackish)
		1439	s/(?<=\S)\n(?=\w)/ /g;
		1440
		1441	# compress some whitespace
		1442	s/\s+\n/\n/g; # ws line-ends
		1443	s/\n\n+/\n/g; # double lines
		1444	s/^\n+//; # beginning lines
		1445	s/\n+$//; # ending lines
		1446
		1447	$_
		1448	}
		1449
		1450	sub hintmode {
		1451	$_[0]{hintmode} = $_[1] if @_ > 1;
		1452	$_[0]{hintmode}
		1453	}
		1454
1118	=item $player->ext_reply ($msgid, $msgtype, %msg)	1455	=item $player->ext_reply ($msgid, %msg)
1119		1456
1120	Sends an ext reply to the player.	1457	Sends an ext reply to the player.
1121		1458
1122	=cut	1459	=cut
1123		1460
1124	sub ext_reply($$$%) {	1461	sub ext_reply($$%) {
1125	my ($self, $id, %msg) = @_;	1462	my ($self, $id, %msg) = @_;
1126		1463
1127	$msg{msgid} = $id;	1464	$msg{msgid} = $id;
1128		1465	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1129	$self->send ("ext " . cf::to_json \%msg);
1130	}	1466	}
1131		1467
1132	package cf;	1468	=item $player->ext_event ($type, %msg)
		1469
		1470	Sends an ext event to the client.
		1471
		1472	=cut
		1473
		1474	sub ext_event($$%) {
		1475	my ($self, $type, %msg) = @_;
		1476
		1477	$self->ns->ext_event ($type, %msg);
		1478	}
		1479
		1480	=head3 cf::region
		1481
		1482	=over 4
		1483
		1484	=cut
		1485
		1486	package cf::region;
		1487
		1488	=item cf::region::find_by_path $path
		1489
		1490	Tries to decuce the likely region for a map knowing only its path.
		1491
		1492	=cut
		1493
		1494	sub find_by_path($) {
		1495	my ($path) = @_;
		1496
		1497	my ($match, $specificity);
		1498
		1499	for my $region (list) {
		1500	if ($region->{match} && $path =~ $region->{match}) {
		1501	($match, $specificity) = ($region, $region->specificity)
		1502	if $region->specificity > $specificity;
		1503	}
		1504	}
		1505
		1506	$match
		1507	}
1133		1508
1134	=back	1509	=back
1135
1136		1510
1137	=head3 cf::map	1511	=head3 cf::map
1138		1512
1139	=over 4	1513	=over 4
1140		1514
…		…
1195	my ($self, $merge) = @_;	1569	my ($self, $merge) = @_;
1196		1570
1197	# we have to keep some variables in memory intact	1571	# we have to keep some variables in memory intact
1198	local $self->{path};	1572	local $self->{path};
1199	local $self->{load_path};	1573	local $self->{load_path};
1200	local $self->{deny_save};
1201	local $self->{deny_reset};
1202		1574
1203	$self->SUPER::thawer_merge ($merge);	1575	$self->SUPER::thawer_merge ($merge);
1204	}	1576	}
1205		1577
1206	sub normalise {	1578	sub normalise {
…		…
1253	$self->init; # pass $1 etc.	1625	$self->init; # pass $1 etc.
1254	return $self;	1626	return $self;
1255	}	1627	}
1256	}	1628	}
1257		1629
1258	Carp::carp "unable to resolve path '$path' (base '$base').";	1630	Carp::cluck "unable to resolve path '$path' (base '$base').";
1259	()	1631	()
1260	}	1632	}
1261		1633
1262	sub init {	1634	sub init {
1263	my ($self) = @_;	1635	my ($self) = @_;
…		…
1278		1650
1279	# the original (read-only) location	1651	# the original (read-only) location
1280	sub load_path {	1652	sub load_path {
1281	my ($self) = @_;	1653	my ($self) = @_;
1282		1654
1283	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1655	"$MAPDIR/$self->{path}.map"
1284	}	1656	}
1285		1657
1286	# the temporary/swap location	1658	# the temporary/swap location
1287	sub save_path {	1659	sub save_path {
1288	my ($self) = @_;	1660	my ($self) = @_;
1289		1661
1290	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1662	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1663	"$TMPDIR/$path.map"
1292	}	1664	}
1293		1665
1294	# the unique path, undef == no special unique path	1666	# the unique path, undef == no special unique path
1295	sub uniq_path {	1667	sub uniq_path {
1296	my ($self) = @_;	1668	my ($self) = @_;
1297		1669
1298	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1670	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1671	"$UNIQUEDIR/$path"
1300	}	1672	}
1301		1673
1302	# and all this just because we cannot iterate over	1674	# and all this just because we cannot iterate over
1303	# all maps in C++...	1675	# all maps in C++...
1304	sub change_all_map_light {	1676	sub change_all_map_light {
1305	my ($change) = @_;	1677	my ($change) = @_;
1306		1678
1307	$_->change_map_light ($change)	1679	$_->change_map_light ($change)
1308	for grep $_->outdoor, values %cf::MAP;	1680	for grep $_->outdoor, values %cf::MAP;
		1681	}
		1682
		1683	sub decay_objects {
		1684	my ($self) = @_;
		1685
		1686	return if $self->{deny_reset};
		1687
		1688	$self->do_decay_objects;
1309	}	1689	}
1310		1690
1311	sub unlink_save {	1691	sub unlink_save {
1312	my ($self) = @_;	1692	my ($self) = @_;
1313		1693
…		…
1371	$self->load_header_orig	1751	$self->load_header_orig
1372	or return;	1752	or return;
1373	$self->prepare_orig;	1753	$self->prepare_orig;
1374	}	1754	}
1375		1755
		1756	$self->{deny_reset} = 1
		1757	if $self->no_reset;
		1758
		1759	$self->default_region (cf::region::find_by_path $self->{path})
		1760	unless $self->default_region;
		1761
1376	1	1762	1
1377	}	1763	}
1378		1764
1379	sub find;	1765	sub find;
1380	sub find {	1766	sub find {
…		…
1392	$map->{last_save} = $cf::RUNTIME;	1778	$map->{last_save} = $cf::RUNTIME;
1393		1779
1394	$map->load_header	1780	$map->load_header
1395	or return;	1781	or return;
1396		1782
1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1783	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398	# doing this can freeze the server in a sync job, obviously	1784	# doing this can freeze the server in a sync job, obviously
1399	#$cf::WAIT_FOR_TICK->wait;	1785	#$cf::WAIT_FOR_TICK->wait;
1400	$map->reset;	1786	$map->reset;
1401	undef $guard;	1787	undef $guard;
1402	return find $path;	1788	return find $path;
…		…
1413	my ($self) = @_;	1799	my ($self) = @_;
1414		1800
1415	local $self->{deny_reset} = 1; # loading can take a long time	1801	local $self->{deny_reset} = 1; # loading can take a long time
1416		1802
1417	my $path = $self->{path};	1803	my $path = $self->{path};
		1804
		1805	{
1418	my $guard = cf::lock_acquire "map_load:$path";	1806	my $guard = cf::lock_acquire "map_load:$path";
1419		1807
1420	return if $self->in_memory != cf::MAP_SWAPPED;	1808	return if $self->in_memory != cf::MAP_SWAPPED;
1421		1809
1422	$self->in_memory (cf::MAP_LOADING);	1810	$self->in_memory (cf::MAP_LOADING);
1423		1811
1424	$self->alloc;	1812	$self->alloc;
1425		1813
1426	$self->pre_load;	1814	$self->pre_load;
1427
1428	$self->_load_objects ($self->{load_path}, 1)
1429	or return;
1430
1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432	if delete $self->{load_original};
1433
1434	if (my $uniq = $self->uniq_path) {
1435	utf8::encode $uniq;
1436	if (aio_open $uniq, O_RDONLY, 0) {
1437	$self->clear_unique_items;
1438	$self->_load_objects ($uniq, 0);
1439	}
1440	}
1441
1442	Coro::cede;
1443
1444	# now do the right thing for maps
1445	$self->link_multipart_objects;
1446
1447	unless ($self->{deny_activate}) {
1448	$self->decay_objects;
1449	$self->fix_auto_apply;
1450	$self->update_buttons;
1451	Coro::cede;	1815	Coro::cede;
1452	$self->set_darkness_map;	1816
		1817	$self->_load_objects ($self->{load_path}, 1)
		1818	or return;
		1819
		1820	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1821	if delete $self->{load_original};
		1822
		1823	if (my $uniq = $self->uniq_path) {
		1824	utf8::encode $uniq;
		1825	if (aio_open $uniq, O_RDONLY, 0) {
		1826	$self->clear_unique_items;
		1827	$self->_load_objects ($uniq, 0);
		1828	}
		1829	}
		1830
		1831	Coro::cede;
		1832	# now do the right thing for maps
		1833	$self->link_multipart_objects;
1453	$self->difficulty ($self->estimate_difficulty)	1834	$self->difficulty ($self->estimate_difficulty)
1454	unless $self->difficulty;	1835	unless $self->difficulty;
1455	Coro::cede;	1836	Coro::cede;
		1837
		1838	unless ($self->{deny_activate}) {
		1839	$self->decay_objects;
		1840	$self->fix_auto_apply;
		1841	$self->update_buttons;
		1842	Coro::cede;
		1843	$self->set_darkness_map;
		1844	Coro::cede;
1456	$self->activate;	1845	$self->activate;
		1846	}
		1847
		1848	$self->in_memory (cf::MAP_IN_MEMORY);
1457	}	1849	}
1458		1850
1459	$self->post_load;	1851	$self->post_load;
1460
1461	$self->in_memory (cf::MAP_IN_MEMORY);
1462	}	1852	}
1463		1853
1464	sub customise_for {	1854	sub customise_for {
1465	my ($self, $ob) = @_;	1855	my ($self, $ob) = @_;
1466		1856
1467	return find "~" . $ob->name . "/" . $self->{path}	1857	return find "~" . $ob->name . "/" . $self->{path}
1468	if $self->per_player;	1858	if $self->per_player;
		1859
		1860	# return find "?party/" . $ob->name . "/" . $self->{path}
		1861	# if $self->per_party;
1469		1862
1470	$self	1863	$self
1471	}	1864	}
1472		1865
1473	# find and load all maps in the 3x3 area around a map	1866	# find and load all maps in the 3x3 area around a map
…		…
1520		1913
1521	undef $MAP_PREFETCH{$path};	1914	undef $MAP_PREFETCH{$path};
1522	$MAP_PREFETCHER ||= cf::async {	1915	$MAP_PREFETCHER ||= cf::async {
1523	while (%MAP_PREFETCH) {	1916	while (%MAP_PREFETCH) {
1524	for my $path (keys %MAP_PREFETCH) {	1917	for my $path (keys %MAP_PREFETCH) {
1525	my $map = find $path	1918	if (my $map = find $path) {
1526	or next;
1527	$map->load;	1919	$map->load;
		1920	}
1528		1921
1529	delete $MAP_PREFETCH{$path};	1922	delete $MAP_PREFETCH{$path};
1530	}	1923	}
1531	}	1924	}
1532	undef $MAP_PREFETCHER;	1925	undef $MAP_PREFETCHER;
…		…
1584		1977
1585	sub reset_at {	1978	sub reset_at {
1586	my ($self) = @_;	1979	my ($self) = @_;
1587		1980
1588	# TODO: safety, remove and allow resettable per-player maps	1981	# TODO: safety, remove and allow resettable per-player maps
1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
1590	return 1e99 if $self->{deny_reset};	1982	return 1e99 if $self->{deny_reset};
1591		1983
1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1984	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1985	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594		1986
…		…
1605	my ($self) = @_;	1997	my ($self) = @_;
1606		1998
1607	my $lock = cf::lock_acquire "map_data:$self->{path}";	1999	my $lock = cf::lock_acquire "map_data:$self->{path}";
1608		2000
1609	return if $self->players;	2001	return if $self->players;
1610	return if $self->isa ("ext::map_per_player");#d#
1611		2002
1612	warn "resetting map ", $self->path;#d#	2003	warn "resetting map ", $self->path;
1613		2004
1614	$self->in_memory (cf::MAP_SWAPPED);	2005	$self->in_memory (cf::MAP_SWAPPED);
1615		2006
1616	# need to save uniques path	2007	# need to save uniques path
1617	unless ($self->{deny_save}) {	2008	unless ($self->{deny_save}) {
…		…
1649	$cf::MAP{$self->path} = $self;	2040	$cf::MAP{$self->path} = $self;
1650		2041
1651	$self->reset; # polite request, might not happen	2042	$self->reset; # polite request, might not happen
1652	}	2043	}
1653		2044
		2045	=item $maps = cf::map::tmp_maps
		2046
		2047	Returns an arrayref with all map paths of currently instantiated and saved
		2048	maps. May block.
		2049
		2050	=cut
		2051
		2052	sub tmp_maps() {
		2053	[
		2054	map {
		2055	utf8::decode $_;
		2056	/\.map$/
		2057	? normalise $_
		2058	: ()
		2059	} @{ aio_readdir $TMPDIR or [] }
		2060	]
		2061	}
		2062
		2063	=item $maps = cf::map::random_maps
		2064
		2065	Returns an arrayref with all map paths of currently instantiated and saved
		2066	random maps. May block.
		2067
		2068	=cut
		2069
		2070	sub random_maps() {
		2071	[
		2072	map {
		2073	utf8::decode $_;
		2074	/\.map$/
		2075	? normalise "?random/$_"
		2076	: ()
		2077	} @{ aio_readdir $RANDOMDIR or [] }
		2078	]
		2079	}
		2080
1654	=item cf::map::unique_maps	2081	=item cf::map::unique_maps
1655		2082
1656	Returns an arrayref of paths of all shared maps that have	2083	Returns an arrayref of paths of all shared maps that have
1657	instantiated unique items. May block.	2084	instantiated unique items. May block.
1658		2085
1659	=cut	2086	=cut
1660		2087
1661	sub unique_maps() {	2088	sub unique_maps() {
1662	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2089	[
1663	or return;	2090	map {
1664
1665	my @paths;
1666
1667	for (@$files) {
1668	utf8::decode $_;	2091	utf8::decode $_;
1669	next if /\.pst$/;	2092	/\.map$/
1670	next unless /^$PATH_SEP/o;	2093	? normalise $_
1671		2094	: ()
1672	push @paths, cf::map::normalise $_;	2095	} @{ aio_readdir $UNIQUEDIR or [] }
1673	}	2096	]
1674
1675	\@paths
1676	}	2097	}
1677		2098
1678	package cf;	2099	package cf;
1679		2100
1680	=back	2101	=back
…		…
1726		2147
1727	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2148	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728		2149
1729	if ($self->{record_replies}) {	2150	if ($self->{record_replies}) {
1730	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2151	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2152
1731	} else {	2153	} else {
		2154	my $pl = $self->contr;
		2155
		2156	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2157	my $diag = $pl->{npc_dialog};
		2158	$diag->{pl}->ext_reply (
		2159	$diag->{id},
		2160	msgtype => "reply",
		2161	msg => $diag->{pl}->expand_cfpod ($msg),
		2162	add_topics => []
		2163	);
		2164
		2165	} else {
1732	$msg = $npc->name . " says: $msg" if $npc;	2166	$msg = $npc->name . " says: $msg" if $npc;
1733	$self->message ($msg, $flags);	2167	$self->message ($msg, $flags);
		2168	}
1734	}	2169	}
1735	}	2170	}
1736		2171
1737	=item $player_object->may ("access")	2172	=item $player_object->may ("access")
1738		2173
…		…
1786	$self->deactivate_recursive;	2221	$self->deactivate_recursive;
1787		2222
1788	return if UNIVERSAL::isa $self->map, "ext::map_link";	2223	return if UNIVERSAL::isa $self->map, "ext::map_link";
1789		2224
1790	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2225	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791	if $self->map;	2226	if $self->map && $self->map->{path} ne "{link}";
1792		2227
1793	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2228	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1794	}	2229	}
1795		2230
1796	sub cf::object::player::leave_link {	2231	sub cf::object::player::leave_link {
1797	my ($self, $map, $x, $y) = @_;	2232	my ($self, $map, $x, $y) = @_;
		2233
		2234	return unless $self->contr->active;
1798		2235
1799	my $link_pos = delete $self->{_link_pos};	2236	my $link_pos = delete $self->{_link_pos};
1800		2237
1801	unless ($map) {	2238	unless ($map) {
1802	# restore original map position	2239	# restore original map position
…		…
1825		2262
1826	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2263	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827	$self->enter_map ($map, $x, $y);	2264	$self->enter_map ($map, $x, $y);
1828	}	2265	}
1829		2266
1830	cf::player->attach (	2267	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831	on_logout => sub {
1832	my ($pl) = @_;
1833		2268
1834	# abort map switching before logout	2269	Moves the player to the given map-path and coordinates by first freezing
1835	if ($pl->ob->{_link_pos}) {	2270	her, loading and preparing them map, calling the provided $check callback
1836	cf::sync_job {	2271	that has to return the map if sucecssful, and then unfreezes the player on
1837	$pl->ob->leave_link	2272	the new (success) or old (failed) map position. In either case, $done will
1838	};	2273	be called at the end of this process.
1839	}
1840	},
1841	on_login => sub {
1842	my ($pl) = @_;
1843		2274
1844	# try to abort aborted map switching on player login :)
1845	# should happen only on crashes
1846	if ($pl->ob->{_link_pos}) {
1847	$pl->ob->enter_link;
1848	(async {
1849	$pl->ob->reply (undef,
1850	"There was an internal problem at your last logout, "
1851	. "the server will try to bring you to your intended destination in a second.",
1852	cf::NDI_RED);
1853	# we need this sleep as the login has a concurrent enter_exit running
1854	# and this sleep increases chances of the player not ending up in scorn
1855	Coro::Timer::sleep 1;
1856	$pl->ob->leave_link;
1857	})->prio (2);
1858	}
1859	},
1860	);
1861
1862	=item $player_object->goto ($path, $x, $y)
1863
1864	=cut	2275	=cut
		2276
		2277	our $GOTOGEN;
1865		2278
1866	sub cf::object::player::goto {	2279	sub cf::object::player::goto {
1867	my ($self, $path, $x, $y) = @_;	2280	my ($self, $path, $x, $y, $check, $done) = @_;
		2281
		2282	# do generation counting so two concurrent goto's will be executed in-order
		2283	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868		2284
1869	$self->enter_link;	2285	$self->enter_link;
1870		2286
1871	(async {	2287	(async {
1872	my $map = eval {	2288	my $map = eval {
1873	my $map = cf::map::find $path;	2289	my $map = cf::map::find $path;
		2290
		2291	if ($map) {
1874	$map = $map->customise_for ($self) if $map;	2292	$map = $map->customise_for ($self);
		2293	$map = $check->($map) if $check && $map;
		2294	} else {
		2295	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2296	}
		2297
1875	$map	2298	$map
		2299	};
		2300
		2301	if ($@) {
		2302	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2303	LOG llevError | logBacktrace, Carp::longmess $@;
1876	} or	2304	}
1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878		2305
		2306	if ($gen == $self->{_goto_generation}) {
		2307	delete $self->{_goto_generation};
1879	$self->leave_link ($map, $x, $y);	2308	$self->leave_link ($map, $x, $y);
		2309	}
		2310
		2311	$done->() if $done;
1880	})->prio (1);	2312	})->prio (1);
1881	}	2313	}
1882		2314
1883	=item $player_object->enter_exit ($exit_object)	2315	=item $player_object->enter_exit ($exit_object)
1884		2316
…		…
1923		2355
1924	$rmp->{random_seed} ||= $exit->random_seed;	2356	$rmp->{random_seed} ||= $exit->random_seed;
1925		2357
1926	my $data = cf::to_json $rmp;	2358	my $data = cf::to_json $rmp;
1927	my $md5 = Digest::MD5::md5_hex $data;	2359	my $md5 = Digest::MD5::md5_hex $data;
1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2360	my $meta = "$RANDOMDIR/$md5.meta";
1929		2361
1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2362	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931	aio_write $fh, 0, (length $data), $data, 0;	2363	aio_write $fh, 0, (length $data), $data, 0;
1932	undef $fh;	2364	undef $fh;
1933	aio_rename "$meta~", $meta;	2365	aio_rename "$meta~", $meta;
…		…
1942		2374
1943	return unless $self->type == cf::PLAYER;	2375	return unless $self->type == cf::PLAYER;
1944		2376
1945	if ($exit->slaying eq "/!") {	2377	if ($exit->slaying eq "/!") {
1946	#TODO: this should de-fi-ni-te-ly not be a sync-job	2378	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2379	# the problem is that $exit might not survive long enough
		2380	# so it needs to be done right now, right here
1947	cf::sync_job { prepare_random_map $exit };	2381	cf::sync_job { prepare_random_map $exit };
1948	}	2382	}
1949		2383
1950	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2384	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951	my $hp = $exit->stats->hp;	2385	my $hp = $exit->stats->hp;
1952	my $sp = $exit->stats->sp;	2386	my $sp = $exit->stats->sp;
1953		2387
1954	$self->enter_link;	2388	$self->enter_link;
		2389
		2390	# if exit is damned, update players death & WoR home-position
		2391	$self->contr->savebed ($slaying, $hp, $sp)
		2392	if $exit->flag (FLAG_DAMNED);
1955		2393
1956	(async {	2394	(async {
1957	$self->deactivate_recursive; # just to be sure	2395	$self->deactivate_recursive; # just to be sure
1958	unless (eval {	2396	unless (eval {
1959	$self->goto ($slaying, $hp, $sp);	2397	$self->goto ($slaying, $hp, $sp);
1960		2398
1961	1;	2399	1;
1962	}) {	2400	}) {
1963	$self->message ("Something went wrong deep within the crossfire server. "	2401	$self->message ("Something went wrong deep within the crossfire server. "
1964	. "I'll try to bring you back to the map you were before. "	2402	. "I'll try to bring you back to the map you were before. "
1965	. "Please report this to the dungeon master!",	2403	. "Please report this to the dungeon master!",
1966	cf::NDI_UNIQUE | cf::NDI_RED);	2404	cf::NDI_UNIQUE | cf::NDI_RED);
1967		2405
1968	warn "ERROR in enter_exit: $@";	2406	warn "ERROR in enter_exit: $@";
1969	$self->leave_link;	2407	$self->leave_link;
1970	}	2408	}
1971	})->prio (1);	2409	})->prio (1);
…		…
1987		2425
1988	utf8::encode $text;	2426	utf8::encode $text;
1989	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2427	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990	}	2428	}
1991		2429
		2430	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2431
		2432	Send a drawinfo or msg packet to the client, formatting the msg for the
		2433	client if neccessary. C<$type> should be a string identifying the type of
		2434	the message, with C<log> being the default. If C<$color> is negative, suppress
		2435	the message unless the client supports the msg packet.
		2436
		2437	=cut
		2438
		2439	sub cf::client::send_msg {
		2440	my ($self, $channel, $msg, $color, @extra) = @_;
		2441
		2442	$msg = $self->pl->expand_cfpod ($msg);
		2443
		2444	return unless @extra || length $msg;
		2445
		2446	$color &= ~cf::NDI_UNIQUE; # just in case...
		2447
		2448	if (ref $channel) {
		2449	# send meta info to client, if not yet sent
		2450	unless (exists $self->{channel}{$channel->{id}}) {
		2451	$self->{channel}{$channel->{id}} = $channel;
		2452	$self->ext_event (channel_info => %$channel);
		2453	}
		2454
		2455	$channel = $channel->{id};
		2456	}
		2457
		2458	if ($self->can_msg) {
		2459	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2460	} else {
		2461	# replace some tags by gcfclient-compatible ones
		2462	for ($msg) {
		2463	1 while
		2464	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2465	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2466	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2467	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2468	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2469	}
		2470
		2471	if ($color >= 0) {
		2472	if (0 && $msg =~ /\[/) {
		2473	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2474	} else {
		2475	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2476	$self->send_packet ("drawinfo $color $msg")
		2477	}
		2478	}
		2479	}
		2480	}
		2481
		2482	=item $client->ext_event ($type, %msg)
		2483
		2484	Sends an ext event to the client.
		2485
		2486	=cut
		2487
		2488	sub cf::client::ext_event($$%) {
		2489	my ($self, $type, %msg) = @_;
		2490
		2491	return unless $self->extcmd;
		2492
		2493	$msg{msgtype} = "event_$type";
		2494	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2495	}
1992		2496
1993	=item $success = $client->query ($flags, "text", \&cb)	2497	=item $success = $client->query ($flags, "text", \&cb)
1994		2498
1995	Queues a query to the client, calling the given callback with	2499	Queues a query to the client, calling the given callback with
1996	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2500	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2501	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998		2502
1999	Queries can fail, so check the return code. Or don't, as queries will become	2503	Queries can fail, so check the return code. Or don't, as queries will
2000	reliable at some point in the future.	2504	become reliable at some point in the future.
2001		2505
2002	=cut	2506	=cut
2003		2507
2004	sub cf::client::query {	2508	sub cf::client::query {
2005	my ($self, $flags, $text, $cb) = @_;	2509	my ($self, $flags, $text, $cb) = @_;
…		…
2013	utf8::encode $text;	2517	utf8::encode $text;
2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2518	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015		2519
2016	$self->send_packet ($self->{query_queue}[0][0])	2520	$self->send_packet ($self->{query_queue}[0][0])
2017	if @{ $self->{query_queue} } == 1;	2521	if @{ $self->{query_queue} } == 1;
		2522
		2523	1
2018	}	2524	}
2019		2525
2020	cf::client->attach (	2526	cf::client->attach (
		2527	on_connect => sub {
		2528	my ($ns) = @_;
		2529
		2530	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2531	},
2021	on_reply => sub {	2532	on_reply => sub {
2022	my ($ns, $msg) = @_;	2533	my ($ns, $msg) = @_;
2023		2534
2024	# this weird shuffling is so that direct followup queries	2535	# this weird shuffling is so that direct followup queries
2025	# get handled first	2536	# get handled first
…		…
2037	} else {	2548	} else {
2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2549	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039	}	2550	}
2040	}	2551	}
2041	},	2552	},
		2553	on_exticmd => sub {
		2554	my ($ns, $buf) = @_;
		2555
		2556	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2557
		2558	if (ref $msg) {
		2559	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2560	if (my %reply = $cb->($ns, $msg)) {
		2561	$reply{msgid} = $msg->{msgid};
		2562	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2563	}
		2564	}
		2565	} else {
		2566	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2567	}
		2568
		2569	cf::override;
		2570	},
2042	);	2571	);
2043		2572
2044	=item $client->async (\&cb)	2573	=item $client->async (\&cb)
2045		2574
2046	Create a new coroutine, running the specified callback. The coroutine will	2575	Create a new coroutine, running the specified callback. The coroutine will
…		…
2093		2622
2094	# here we export the classes and methods available to script code	2623	# here we export the classes and methods available to script code
2095		2624
2096	=pod	2625	=pod
2097		2626
2098	The following fucntions and emthods are available within a safe environment:	2627	The following functions and methods are available within a safe environment:
2099		2628
2100	cf::object contr pay_amount pay_player map	2629	cf::object
		2630	contr pay_amount pay_player map x y force_find force_add
		2631	insert remove
		2632
2101	cf::object::player player	2633	cf::object::player
2102	cf::player peaceful	2634	player
2103	cf::map trigger	2635
		2636	cf::player
		2637	peaceful
		2638
		2639	cf::map
		2640	trigger
2104		2641
2105	=cut	2642	=cut
2106		2643
2107	for (	2644	for (
2108	["cf::object" => qw(contr pay_amount pay_player map)],	2645	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2646	insert remove)],
2109	["cf::object::player" => qw(player)],	2647	["cf::object::player" => qw(player)],
2110	["cf::player" => qw(peaceful)],	2648	["cf::player" => qw(peaceful)],
2111	["cf::map" => qw(trigger)],	2649	["cf::map" => qw(trigger)],
2112	) {	2650	) {
2113	no strict 'refs';	2651	no strict 'refs';
…		…
2184	=back	2722	=back
2185		2723
2186	=cut	2724	=cut
2187		2725
2188	#############################################################################	2726	#############################################################################
2189
2190	=head2 EXTENSION DATABASE SUPPORT
2191
2192	Crossfire maintains a very simple database for extension use. It can
2193	currently store anything that can be serialised using Storable, which
2194	excludes objects.
2195
2196	The parameter C<$family> should best start with the name of the extension
2197	using it, it should be unique.
2198
2199	=over 4
2200
2201	=item $value = cf::db_get $family => $key
2202
2203	Returns a single value from the database.
2204
2205	=item cf::db_put $family => $key => $value
2206
2207	Stores the given C<$value> in the family.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	sub db_init {
2214	unless ($DB) {
2215	$DB = BDB::db_create $DB_ENV;
2216
2217	cf::sync_job {
2218	eval {
2219	$DB->set_flags (BDB::CHKSUM);
2220
2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223	cf::cleanup "db_open(db): $!" if $!;
2224	};
2225	cf::cleanup "db_open(db): $@" if $@;
2226	};
2227
2228	my $path = cf::localdir . "/database.pst";
2229	if (stat $path) {
2230	cf::sync_job {
2231	my $pst = Storable::retrieve $path;
2232
2233	cf::db_put (board => data => $pst->{board});
2234	cf::db_put (guildrules => data => $pst->{guildrules});
2235	cf::db_put (rent => balance => $pst->{rent}{balance});
2236	BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238	unlink $path;
2239	};
2240	}
2241	}
2242	}
2243
2244	sub db_get($$) {
2245	my $key = "$_[0]/$_[1]";
2246
2247	cf::sync_job {
2248	BDB::db_get $DB, undef, $key, my $data;
2249
2250	$! ? ()
2251	: Compress::LZF::sthaw $data
2252	}
2253	}
2254
2255	sub db_put($$$) {
2256	BDB::dbreq_pri 4;
2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258	}
2259
2260	#############################################################################
2261	# the server's init and main functions	2727	# the server's init and main functions
2262		2728
2263	sub load_faces {	2729	sub load_facedata($) {
2264	my $path = sprintf "%s/faces", cf::datadir;	2730	my ($path) = @_;
2265		2731
2266	warn "loading faces from $path\n";	2732	warn "loading facedata from $path\n";
2267		2733
2268	my $faces;	2734	my $facedata;
2269	0 < aio_load $path, $faces	2735	0 < aio_load $path, $facedata
2270	or die "$path: $!";	2736	or die "$path: $!";
2271		2737
2272	Coro::cede;
2273	$faces = Storable::thaw $faces;	2738	$facedata = Coro::Storable::thaw $facedata;
2274	Coro::cede;
2275		2739
2276	my $meta = delete $faces->{""};
2277	$meta->{version} == 1	2740	$facedata->{version} == 2
2278	or cf::cleanup "$path: version mismatch, cannot proceed.";	2741	or cf::cleanup "$path: version mismatch, cannot proceed.";
2279		2742
		2743	{
		2744	my $faces = $facedata->{faceinfo};
		2745
2280	while (my ($face, $info) = each %$faces) {	2746	while (my ($face, $info) = each %$faces) {
2281	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2747	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2282	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2748	cf::face::set_visibility $idx, $info->{visibility};
		2749	cf::face::set_magicmap $idx, $info->{magicmap};
2283	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2750	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2284	Coro::cede;	2751	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2285	}
2286		2752
		2753	cf::cede_to_tick;
		2754	}
		2755
2287	while (my ($face, $info) = each %$faces) {	2756	while (my ($face, $info) = each %$faces) {
2288	next unless $info->{smooth};	2757	next unless $info->{smooth};
2289	my $idx = cf::face::find $face	2758	my $idx = cf::face::find $face
2290	or next;	2759	or next;
2291	if (my $smooth = cf::face::find $info->{smooth}) {	2760	if (my $smooth = cf::face::find $info->{smooth}) {
2292	cf::face::set_smooth $idx, $smooth;	2761	cf::face::set_smooth $idx, $smooth;
		2762	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2293	} else {	2763	} else {
2294	warn "smooth face '$info->{smooth}' not found for face '$face'";	2764	warn "smooth face '$info->{smooth}' not found for face '$face'";
2295	}	2765	}
2296	Coro::cede;	2766
		2767	cf::cede_to_tick;
		2768	}
		2769	}
		2770
		2771	{
		2772	my $anims = $facedata->{animinfo};
		2773
		2774	while (my ($anim, $info) = each %$anims) {
		2775	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2776	cf::cede_to_tick;
		2777	}
		2778
		2779	cf::anim::invalidate_all; # d'oh
		2780	}
		2781
		2782	{
		2783	# TODO: for gcfclient pleasure, we should give resources
		2784	# that gcfclient doesn't grok a >10000 face index.
		2785	my $res = $facedata->{resource};
		2786	my $enc = JSON::XS->new->utf8->canonical;
		2787
		2788	while (my ($name, $info) = each %$res) {
		2789	my $meta = $enc->encode ({
		2790	name => $name,
		2791	type => $info->{type},
		2792	copyright => $info->{copyright}, #TODO#
		2793	});
		2794
		2795	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2796
		2797	if ($name =~ /\.jpg$/) {
		2798	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2799	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2800	} else {
		2801	my $data = pack "(w/a*)*", $meta, $info->{data};
		2802	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2803
		2804	cf::face::set_type $idx, 1;
		2805	cf::face::set_data $idx, 0, $data, $chk;
		2806	}
		2807
		2808	cf::cede_to_tick;
		2809	}
2297	}	2810	}
2298		2811
2299	1	2812	1
2300	}	2813	}
2301		2814
		2815	sub reload_regions {
		2816	load_resource_file "$MAPDIR/regions"
		2817	or die "unable to load regions file\n";
		2818
		2819	for (cf::region::list) {
		2820	$_->{match} = qr/$_->{match}/
		2821	if exists $_->{match};
		2822	}
		2823	}
		2824
		2825	sub reload_facedata {
		2826	load_facedata "$DATADIR/facedata"
		2827	or die "unable to load facedata\n";
		2828	}
		2829
		2830	sub reload_archetypes {
		2831	load_resource_file "$DATADIR/archetypes"
		2832	or die "unable to load archetypes\n";
		2833	#d# NEED to laod twice to resolve forward references
		2834	# this really needs to be done in an extra post-pass
		2835	# (which needs to be synchronous, so solve it differently)
		2836	load_resource_file "$DATADIR/archetypes"
		2837	or die "unable to load archetypes\n";
		2838	}
		2839
		2840	sub reload_treasures {
		2841	load_resource_file "$DATADIR/treasures"
		2842	or die "unable to load treasurelists\n";
		2843	}
		2844
2302	sub reload_resources {	2845	sub reload_resources {
2303	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2846	warn "reloading resource files...\n";
2304	or die "unable to load regions file\n";#d#	2847
		2848	reload_regions;
2305	load_faces	2849	reload_facedata;
2306	or die "unable to load faces\n";#d#	2850	#reload_archetypes;#d#
		2851	reload_archetypes;
		2852	reload_treasures;
		2853
		2854	warn "finished reloading resource files\n";
2307	}	2855	}
2308		2856
2309	sub init {	2857	sub init {
2310	reload_resources;	2858	reload_resources;
2311	}	2859	}
2312		2860
2313	sub cfg_load {	2861	sub cfg_load {
2314	open my $fh, "<:utf8", cf::confdir . "/config"	2862	open my $fh, "<:utf8", "$CONFDIR/config"
2315	or return;	2863	or return;
2316		2864
2317	local $/;	2865	local $/;
2318	*CFG = YAML::Syck::Load <$fh>;	2866	*CFG = YAML::Syck::Load <$fh>;
2319		2867
…		…
2364	},	2912	},
2365	);	2913	);
2366	}	2914	}
2367	}	2915	}
2368		2916
		2917	sub write_runtime {
		2918	my $runtime = "$LOCALDIR/runtime";
		2919
		2920	# first touch the runtime file to show we are still running:
		2921	# the fsync below can take a very very long time.
		2922
		2923	IO::AIO::aio_utime $runtime, undef, undef;
		2924
		2925	my $guard = cf::lock_acquire "write_runtime";
		2926
		2927	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2928	or return;
		2929
		2930	my $value = $cf::RUNTIME + 90 + 10;
		2931	# 10 is the runtime save interval, for a monotonic clock
		2932	# 60 allows for the watchdog to kill the server.
		2933
		2934	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2935	and return;
		2936
		2937	# always fsync - this file is important
		2938	aio_fsync $fh
		2939	and return;
		2940
		2941	# touch it again to show we are up-to-date
		2942	aio_utime $fh, undef, undef;
		2943
		2944	close $fh
		2945	or return;
		2946
		2947	aio_rename "$runtime~", $runtime
		2948	and return;
		2949
		2950	warn "runtime file written.\n";
		2951
		2952	1
		2953	}
		2954
2369	sub emergency_save() {	2955	sub emergency_save() {
2370	my $freeze_guard = cf::freeze_mainloop;	2956	my $freeze_guard = cf::freeze_mainloop;
2371		2957
2372	warn "enter emergency perl save\n";	2958	warn "enter emergency perl save\n";
2373		2959
…		…
2404		2990
2405	warn Carp::longmess "post_cleanup backtrace"	2991	warn Carp::longmess "post_cleanup backtrace"
2406	if $make_core;	2992	if $make_core;
2407	}	2993	}
2408		2994
2409	sub reload() {	2995	sub do_reload_perl() {
2410	# can/must only be called in main	2996	# can/must only be called in main
2411	if ($Coro::current != $Coro::main) {	2997	if ($Coro::current != $Coro::main) {
2412	warn "can only reload from main coroutine";	2998	warn "can only reload from main coroutine";
2413	return;	2999	return;
2414	}	3000	}
…		…
2448	%EXT_CORO = ();	3034	%EXT_CORO = ();
2449		3035
2450	warn "removing commands";	3036	warn "removing commands";
2451	%COMMAND = ();	3037	%COMMAND = ();
2452		3038
2453	warn "removing ext commands";	3039	warn "removing ext/exti commands";
2454	%EXTCMD = ();	3040	%EXTCMD = ();
		3041	%EXTICMD = ();
2455		3042
2456	warn "unloading/nuking all extensions";	3043	warn "unloading/nuking all extensions";
2457	for my $pkg (@EXTS) {	3044	for my $pkg (@EXTS) {
2458	warn "... unloading $pkg";	3045	warn "... unloading $pkg";
2459		3046
…		…
2489	Symbol::delete_package "safe::$_"	3076	Symbol::delete_package "safe::$_"
2490	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3077	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2491		3078
2492	warn "unloading cf.pm \"a bit\"";	3079	warn "unloading cf.pm \"a bit\"";
2493	delete $INC{"cf.pm"};	3080	delete $INC{"cf.pm"};
		3081	delete $INC{"cf/pod.pm"};
2494		3082
2495	# don't, removes xs symbols, too,	3083	# don't, removes xs symbols, too,
2496	# and global variables created in xs	3084	# and global variables created in xs
2497	#Symbol::delete_package __PACKAGE__;	3085	#Symbol::delete_package __PACKAGE__;
2498		3086
…		…
2513	warn "reattaching attachments to maps";	3101	warn "reattaching attachments to maps";
2514	reattach $_ for values %MAP;	3102	reattach $_ for values %MAP;
2515	warn "reattaching attachments to players";	3103	warn "reattaching attachments to players";
2516	reattach $_ for values %PLAYER;	3104	reattach $_ for values %PLAYER;
2517		3105
2518	warn "loading reloadable resources";
2519	reload_resources;
2520
2521	warn "leaving sync_job";	3106	warn "leaving sync_job";
2522		3107
2523	1	3108	1
2524	} or do {	3109	} or do {
2525	warn $@;	3110	warn $@;
…		…
2530	warn "reloaded";	3115	warn "reloaded";
2531	};	3116	};
2532		3117
2533	our $RELOAD_WATCHER; # used only during reload	3118	our $RELOAD_WATCHER; # used only during reload
2534		3119
		3120	sub reload_perl() {
		3121	# doing reload synchronously and two reloads happen back-to-back,
		3122	# coro crashes during coro_state_free->destroy here.
		3123
		3124	$RELOAD_WATCHER ||= Event->timer (
		3125	reentrant => 0,
		3126	after => 0,
		3127	data => WF_AUTOCANCEL,
		3128	cb => sub {
		3129	do_reload_perl;
		3130	undef $RELOAD_WATCHER;
		3131	},
		3132	);
		3133	}
		3134
2535	register_command "reload" => sub {	3135	register_command "reload" => sub {
2536	my ($who, $arg) = @_;	3136	my ($who, $arg) = @_;
2537		3137
2538	if ($who->flag (FLAG_WIZ)) {	3138	if ($who->flag (FLAG_WIZ)) {
2539	$who->message ("reloading server.");	3139	$who->message ("reloading server.");
2540		3140	async { reload_perl };
2541	# doing reload synchronously and two reloads happen back-to-back,
2542	# coro crashes during coro_state_free->destroy here.
2543
2544	$RELOAD_WATCHER ||= Event->timer (
2545	reentrant => 0,
2546	after => 0,
2547	data => WF_AUTOCANCEL,
2548	cb => sub {
2549	reload;
2550	undef $RELOAD_WATCHER;
2551	},
2552	);
2553	}	3141	}
2554	};	3142	};
2555		3143
2556	unshift @INC, $LIBDIR;	3144	unshift @INC, $LIBDIR;
2557		3145
2558	my $bug_warning = 0;	3146	my $bug_warning = 0;
2559		3147
		3148	our @WAIT_FOR_TICK;
		3149	our @WAIT_FOR_TICK_BEGIN;
		3150
		3151	sub wait_for_tick {
		3152	return unless $TICK_WATCHER->is_active;
		3153	return if $Coro::current == $Coro::main;
		3154
		3155	my $signal = new Coro::Signal;
		3156	push @WAIT_FOR_TICK, $signal;
		3157	$signal->wait;
		3158	}
		3159
		3160	sub wait_for_tick_begin {
		3161	return unless $TICK_WATCHER->is_active;
		3162	return if $Coro::current == $Coro::main;
		3163
		3164	my $signal = new Coro::Signal;
		3165	push @WAIT_FOR_TICK_BEGIN, $signal;
		3166	$signal->wait;
		3167	}
		3168
		3169	my $min = 1e6;#d#
		3170	my $avg = 10;
2560	$TICK_WATCHER = Event->timer (	3171	$TICK_WATCHER = Event->timer (
2561	reentrant => 0,	3172	reentrant => 0,
2562	parked => 1,	3173	parked => 1,
2563	prio => 0,	3174	prio => 0,
2564	at => $NEXT_TICK || $TICK,	3175	at => $NEXT_TICK || $TICK,
…		…
2568	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3179	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2569	unless ++$bug_warning > 10;	3180	unless ++$bug_warning > 10;
2570	return;	3181	return;
2571	}	3182	}
2572		3183
2573	$NOW = Event::time;	3184	$NOW = $tick_start = Event::time;
2574		3185
2575	cf::server_tick; # one server iteration	3186	cf::server_tick; # one server iteration
		3187
		3188	0 && sync_job {#d#
		3189	for(1..10) {
		3190	my $t = Event::time;
		3191	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3192	or die;
		3193
		3194	$map->width (50);
		3195	$map->height (50);
		3196	$map->alloc;
		3197	$map->_load_objects ("/tmp/x.map", 1);
		3198	my $t = Event::time - $t;
		3199
		3200	#next unless $t < 0.0013;#d#
		3201	if ($t < $min) {
		3202	$min = $t;
		3203	}
		3204	$avg = $avg * 0.99 + $t * 0.01;
		3205	}
		3206	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3207	exit 0;
		3208	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3209	};
		3210
2576	$RUNTIME += $TICK;	3211	$RUNTIME += $TICK;
2577	$NEXT_TICK += $TICK;	3212	$NEXT_TICK += $TICK;
2578		3213
2579	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3214	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2580	$NEXT_RUNTIME_WRITE = $NOW + 10;	3215	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2582	write_runtime	3217	write_runtime
2583	or warn "ERROR: unable to write runtime file: $!";	3218	or warn "ERROR: unable to write runtime file: $!";
2584	};	3219	};
2585	}	3220	}
2586		3221
2587	$WAIT_FOR_TICK->broadcast;
2588	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2589
2590	# my $AFTER = Event::time;	3222	# my $AFTER = Event::time;
2591	# warn $AFTER - $NOW;#d#	3223	# warn $AFTER - $NOW;#d#
2592		3224
		3225	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3226	$sig->send;
		3227	}
		3228	while (my $sig = shift @WAIT_FOR_TICK) {
		3229	$sig->send;
		3230	}
		3231
		3232	$NOW = Event::time;
		3233
2593	# if we are delayed by four ticks or more, skip them all	3234	# if we are delayed by four ticks or more, skip them all
2594	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3235	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2595		3236
2596	$TICK_WATCHER->at ($NEXT_TICK);	3237	$TICK_WATCHER->at ($NEXT_TICK);
2597	$TICK_WATCHER->start;	3238	$TICK_WATCHER->start;
		3239
		3240	$LOAD = ($NOW - $tick_start) / $TICK;
		3241	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3242
		3243	_post_tick;
		3244
		3245
2598	},	3246	},
2599	);	3247	);
2600		3248
2601	{	3249	{
2602	BDB::max_poll_time $TICK * 0.1;	3250	BDB::max_poll_time $TICK * 0.1;
…		…
2630		3278
2631	cf::sync_job {	3279	cf::sync_job {
2632	eval {	3280	eval {
2633	BDB::db_env_open	3281	BDB::db_env_open
2634	$DB_ENV,	3282	$DB_ENV,
2635	$BDB_ENV_DIR,	3283	$BDBDIR,
2636	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3284	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2637	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3285	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2638	0666;	3286	0666;
2639		3287
2640	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3288	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2641		3289
2642	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3290	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2643	$DB_ENV->set_lk_detect;	3291	$DB_ENV->set_lk_detect;
2644	};	3292	};
2645		3293
…		…
2661	prio => 6,	3309	prio => 6,
2662	cb => \&IO::AIO::poll_cb,	3310	cb => \&IO::AIO::poll_cb,
2663	);	3311	);
2664	}	3312	}
2665		3313
		3314	my $_log_backtrace;
		3315
		3316	sub _log_backtrace {
		3317	my ($msg, @addr) = @_;
		3318
		3319	$msg =~ s/\n//;
		3320
		3321	# limit the # of concurrent backtraces
		3322	if ($_log_backtrace < 2) {
		3323	++$_log_backtrace;
		3324	async {
		3325	my @bt = fork_call {
		3326	@addr = map { sprintf "%x", $_ } @addr;
		3327	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3328	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3329	or die "addr2line: $!";
		3330
		3331	my @funcs;
		3332	my @res = <$fh>;
		3333	chomp for @res;
		3334	while (@res) {
		3335	my ($func, $line) = splice @res, 0, 2, ();
		3336	push @funcs, "[$func] $line";
		3337	}
		3338
		3339	@funcs
		3340	};
		3341
		3342	LOG llevInfo, "[ABT] $msg\n";
		3343	LOG llevInfo, "[ABT] $_\n" for @bt;
		3344	--$_log_backtrace;
		3345	};
		3346	} else {
		3347	LOG llevInfo, "[ABT] $msg\n";
		3348	LOG llevInfo, "[ABT] [suppressed]\n";
		3349	}
		3350	}
		3351
		3352	# load additional modules
		3353	use cf::pod;
		3354
2666	END { cf::emergency_save }	3355	END { cf::emergency_save }
2667		3356
2668	1	3357	1
2669		3358

Diff Legend

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