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.223 by root, Sun Mar 11 02:12:44 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use JSON::XS 1.4 ();
20	use BDB ();	26	use BDB ();
21	use Data::Dumper;	27	use Data::Dumper;
22	use Digest::MD5;	28	use Digest::MD5;
23	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
24	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	32	use Time::HiRes;
27	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
28		35
		36	# configure various modules to our taste
		37	#
		38	$Storable::canonical = 1; # reduce rsync transfers
		39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	40	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		41
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	42	$Event::Eval = 1; # no idea why this is required, but it is
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		43
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
37		46
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
40	our %COMMAND = ();	51	our %COMMAND = ();
41	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
42		53
43	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
47		59
48	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
49	our @EVENT;	61	our @EVENT;
50	our $LIBDIR = datadir . "/ext";
51		62
52	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(!)
53	our $TICK_WATCHER;	76	our $TICK_WATCHER;
54	our $AIO_POLL_WATCHER;	77	our $AIO_POLL_WATCHER;
55	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
56	our $NEXT_TICK;	79	our $NEXT_TICK;
57	our $NOW;	80	our $NOW;
…		…
66	our $RUNTIME;	89	our $RUNTIME;
67		90
68	our %PLAYER; # all users	91	our %PLAYER; # all users
69	our %MAP; # all maps	92	our %MAP; # all maps
70	our $LINK_MAP; # the special {link} map, which is always available	93	our $LINK_MAP; # the special {link} map, which is always available
71	our $RANDOM_MAPS = cf::localdir . "/random";
72	our $BDB_ENV_DIR = cf::localdir . "/db";
73
74	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
75	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
76		94
77	# 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 ∕
78	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
79		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
80	binmode STDOUT;	102	binmode STDOUT;
81	binmode STDERR;	103	binmode STDERR;
82		104
83	# read virtual server time, if available	105	# read virtual server time, if available
84	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
85	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
86	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
87	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
88	}	110	}
89		111
90	mkdir cf::localdir;	112	mkdir $_
91	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
92	mkdir cf::localdir . "/" . cf::tmpdir;
93	mkdir cf::localdir . "/" . cf::uniquedir;
94	mkdir $RANDOM_MAPS;
95	mkdir $BDB_ENV_DIR;
96		114
97	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
98		116
99	sub cf::map::normalise;	117	sub cf::map::normalise;
100		118
…		…
111	=item $cf::RUNTIME	129	=item $cf::RUNTIME
112		130
113	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
114	every server tick.	132	every server tick.
115		133
116	=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
117		137
118	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
119	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.
120		142
121	=item $cf::NOW	143	=item $cf::NOW
122		144
123	The time of the last (current) server tick.	145	The time of the last (current) server tick.
124		146
125	=item $cf::TICK	147	=item $cf::TICK
126		148
127	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.
128		160
129	=item %cf::CFG	161	=item %cf::CFG
130		162
131	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
132	from wherever your confdir points to.	164	from wherever your confdir points to.
133		165
134	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	166	=item cf::wait_for_tick, cf::wait_for_tick_begin
135		167
136	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
137	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
138	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.
139	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.
140		177
141	=back	178	=back
142		179
143	=cut	180	=cut
144		181
145	BEGIN {	182	BEGIN {
146	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
147	my $msg = join "", @_;	184	my $msg = join "", @_;
148	utf8::encode $msg;
149		185
150	$msg .= "\n"	186	$msg .= "\n"
151	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
152		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
153	LOG llevError, $msg;	192	LOG llevError, $msg;
154	};	193	};
155	}	194	}
156		195
157	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
158	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
159	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
160	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
161	@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';
162	@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)
163		203
164	# 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
165	# within the Safe compartment.	205	# within the Safe compartment.
166	for my $pkg (qw(	206	for my $pkg (qw(
167	cf::global cf::attachable	207	cf::global cf::attachable
…		…
175	}	215	}
176		216
177	$Event::DIED = sub {	217	$Event::DIED = sub {
178	warn "error in event callback: @_";	218	warn "error in event callback: @_";
179	};	219	};
		220
		221	#############################################################################
180		222
181	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
182		224
183	=over 4	225	=over 4
184		226
…		…
203	$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;
204	$d	246	$d
205	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
206	}	248	}
207		249
208	use JSON::Syck (); # TODO# replace by JSON::PC once working
209
210	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
211		251
212	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
213		253
214	=cut
215
216	sub from_json($) {
217	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
218	JSON::Syck::Load $_[0]
219	}
220
221	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
222		255
223	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
224		257
225	=cut	258	=cut
226		259
227	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
228	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
229	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
230	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
231		264
232	=item cf::lock_wait $string	265	=item cf::lock_wait $string
233		266
234	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
235		268
…		…
241	returned.	274	returned.
242		275
243	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
244	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
245		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
246	=cut	283	=cut
247		284
248	our %LOCK;	285	our %LOCK;
249		286
250	sub lock_wait($) {	287	sub lock_wait($) {
…		…
267		304
268	Coro::guard {	305	Coro::guard {
269	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
270	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
271	}	308	}
		309	}
		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
272	}	315	}
273		316
274	sub freeze_mainloop {	317	sub freeze_mainloop {
275	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
276		319
…		…
291		334
292	BEGIN { *async = \&Coro::async_pool }	335	BEGIN { *async = \&Coro::async_pool }
293		336
294	=item cf::sync_job { BLOCK }	337	=item cf::sync_job { BLOCK }
295		338
296	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)
297	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
298	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.
299		343
300	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
301	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
302	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
303	fast or be very important.	347	fast or be very important.
…		…
306		350
307	sub sync_job(&) {	351	sub sync_job(&) {
308	my ($job) = @_;	352	my ($job) = @_;
309		353
310	if ($Coro::current == $Coro::main) {	354	if ($Coro::current == $Coro::main) {
		355	my $time = Event::time;
		356
311	# this is the main coro, too bad, we have to block	357	# this is the main coro, too bad, we have to block
312	# till the operation succeeds, freezing the server :/	358	# till the operation succeeds, freezing the server :/
313		359
314	# TODO: use suspend/resume instead	360	# TODO: use suspend/resume instead
315	# (but this is cancel-safe)	361	# (but this is cancel-safe)
…		…
326		372
327	while ($busy) {	373	while ($busy) {
328	Coro::cede or Event::one_event;	374	Coro::cede or Event::one_event;
329	}	375	}
330		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
331	wantarray ? @res : $res[0]	384	wantarray ? @res : $res[0]
332	} else {	385	} else {
333	# we are in another coroutine, how wonderful, everything just works	386	# we are in another coroutine, how wonderful, everything just works
334		387
335	$job->()	388	$job->()
…		…
354	$EXT_CORO{$coro+0} = $coro;	407	$EXT_CORO{$coro+0} = $coro;
355		408
356	$coro	409	$coro
357	}	410	}
358		411
359	sub write_runtime {	412	=item fork_call { }, $args
360	my $guard = cf::lock_acquire "write_runtime";
361		413
362	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.
363		418
364	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	419	=cut
365	or return;
366		420
367	my $value = $cf::RUNTIME + 90 + 10;	421	sub _store_scalar {
368	# 10 is the runtime save interval, for a monotonic clock	422	open my $fh, ">", \my $buf
369	# 60 allows for the watchdog to kill the server.	423	or die "fork_call: cannot open fh-to-buf in child : $!";
370		424	Storable::store_fd $_[0], $fh;
371	(aio_write $fh, 0, (length $value), $value, 0) <= 0
372	and return;
373
374	# always fsync - this file is important
375	aio_fsync $fh
376	and return;
377
378	close $fh	425	close $fh;
379	or return;
380		426
381	aio_rename "$runtime~", $runtime	427	$buf
382	and return;	428	}
383		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;
384	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 });
385	}	599	}
386		600
387	=back	601	=back
388		602
389	=cut	603	=cut
…		…
396	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")
397	to it. All such attachable objects support the following methods.	611	to it. All such attachable objects support the following methods.
398		612
399	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>
400	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
401	crossfire+).	615	Crossfire TRT).
402		616
403	=over 4	617	=over 4
404		618
405	=item $attachable->attach ($attachment, key => $value...)	619	=item $attachable->attach ($attachment, key => $value...)
406		620
…		…
569	$registry = $CB_TYPE[$object_type] ||= [];	783	$registry = $CB_TYPE[$object_type] ||= [];
570		784
571	} elsif ($type eq "subtype") {	785	} elsif ($type eq "subtype") {
572	defined $object_type or Carp::croak "subtype specified without type";	786	defined $object_type or Carp::croak "subtype specified without type";
573	my $object_subtype = shift @arg;	787	my $object_subtype = shift @arg;
574	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	788	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575		789
576	} elsif ($type eq "package") {	790	} elsif ($type eq "package") {
577	my $pkg = shift @arg;	791	my $pkg = shift @arg;
578		792
579	while (my ($name, $id) = each %cb_id) {	793	while (my ($name, $id) = each %cb_id) {
…		…
608	_attach $registry, $klass, @attach;	822	_attach $registry, $klass, @attach;
609	}	823	}
610		824
611	$obj->{$name} = \%arg;	825	$obj->{$name} = \%arg;
612	} else {	826	} else {
613	warn "object uses attachment '$name' that is not available, postponing.\n";	827	warn "object uses attachment '$name' which is not available, postponing.\n";
614	}	828	}
615		829
616	$obj->{_attachment}{$name} = undef;	830	$obj->{_attachment}{$name} = undef;
617	}	831	}
618		832
…		…
620	if (ref $_[0]) {	834	if (ref $_[0]) {
621	_object_attach @_;	835	_object_attach @_;
622	} else {	836	} else {
623	_attach shift->_attach_registry, @_;	837	_attach shift->_attach_registry, @_;
624	}	838	}
		839	_recalc_want;
625	};	840	};
626		841
627	# all those should be optimised	842	# all those should be optimised
628	sub cf::attachable::detach {	843	sub cf::attachable::detach {
629	my ($obj, $name) = @_;	844	my ($obj, $name) = @_;
…		…
632	delete $obj->{_attachment}{$name};	847	delete $obj->{_attachment}{$name};
633	reattach ($obj);	848	reattach ($obj);
634	} else {	849	} else {
635	Carp::croak "cannot, currently, detach class attachments";	850	Carp::croak "cannot, currently, detach class attachments";
636	}	851	}
		852	_recalc_want;
637	};	853	};
638		854
639	sub cf::attachable::attached {	855	sub cf::attachable::attached {
640	my ($obj, $name) = @_;	856	my ($obj, $name) = @_;
641		857
…		…
656	";	872	";
657	die if $@;	873	die if $@;
658	}	874	}
659		875
660	our $override;	876	our $override;
661	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?
662		878
663	sub override {	879	sub override {
664	$override = 1;	880	$override = 1;
665	@invoke_results = ();	881	@INVOKE_RESULTS = (@_);
666	}	882	}
667		883
668	sub do_invoke {	884	sub do_invoke {
669	my $event = shift;	885	my $event = shift;
670	my $callbacks = shift;	886	my $callbacks = shift;
671		887
672	@invoke_results = ();	888	@INVOKE_RESULTS = ();
673		889
674	local $override;	890	local $override;
675		891
676	for (@$callbacks) {	892	for (@$callbacks) {
677	eval { &{$_->[1]} };	893	eval { &{$_->[1]} };
…		…
694		910
695	Generate an object-specific event with the given arguments.	911	Generate an object-specific event with the given arguments.
696		912
697	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
698	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
699	results (if you must, access C<@cf::invoke_results> directly).	915	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700		916
701	=back	917	=back
702		918
703	=cut	919	=cut
704		920
…		…
814	or return;	1030	or return;
815	$av = eval { (Storable::thaw $av)->{objs} };	1031	$av = eval { (Storable::thaw $av)->{objs} };
816	}	1032	}
817		1033
818	warn sprintf "loading %s (%d)\n",	1034	warn sprintf "loading %s (%d)\n",
819	$filename, length $data, scalar @{$av || []};#d#	1035	$filename, length $data, scalar @{$av || []};
820	return ($data, $av);	1036	return ($data, $av);
821	}	1037	}
		1038
		1039	=head2 COMMAND CALLBACKS
		1040
		1041	=over 4
		1042
		1043	=cut
822		1044
823	#############################################################################	1045	#############################################################################
824	# command handling &c	1046	# command handling &c
825		1047
826	=item cf::register_command $name => \&callback($ob,$args);	1048	=item cf::register_command $name => \&callback($ob,$args);
…		…
839	push @{ $COMMAND{$name} }, [$caller, $cb];	1061	push @{ $COMMAND{$name} }, [$caller, $cb];
840	}	1062	}
841		1063
842	=item cf::register_extcmd $name => \&callback($pl,$packet);	1064	=item cf::register_extcmd $name => \&callback($pl,$packet);
843		1065
844	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.
845		1071
846	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
847	called.	1073	called.
848		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
849	=cut	1086	=cut
850		1087
851	sub register_extcmd {	1088	sub register_extcmd {
852	my ($name, $cb) = @_;	1089	my ($name, $cb) = @_;
853		1090
854	$EXTCMD{$name} = $cb;	1091	$EXTCMD{$name} = $cb;
		1092	}
		1093
		1094	sub register_exticmd {
		1095	my ($name, $cb) = @_;
		1096
		1097	$EXTICMD{$name} = $cb;
855	}	1098	}
856		1099
857	cf::player->attach (	1100	cf::player->attach (
858	on_command => sub {	1101	on_command => sub {
859	my ($pl, $name, $params) = @_;	1102	my ($pl, $name, $params) = @_;
…		…
868	cf::override;	1111	cf::override;
869	},	1112	},
870	on_extcmd => sub {	1113	on_extcmd => sub {
871	my ($pl, $buf) = @_;	1114	my ($pl, $buf) = @_;
872		1115
873	my $msg = eval { from_json $buf };	1116	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874		1117
875	if (ref $msg) {	1118	if (ref $msg) {
876	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1119	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
877	if (my %reply = $cb->($pl, $msg)) {	1120	if (my %reply = $cb->($pl, $msg)) {
878	$pl->ext_reply ($msg->{msgid}, %reply);	1121	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
884		1127
885	cf::override;	1128	cf::override;
886	},	1129	},
887	);	1130	);
888		1131
889	sub load_extension {
890	my ($path) = @_;
891
892	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
893	my $base = $1;
894	my $pkg = $1;
895	$pkg =~ s/[^[:word:]]/_/g;
896	$pkg = "ext::$pkg";
897
898	warn "... loading '$path' into '$pkg'\n";
899
900	open my $fh, "<:utf8", $path
901	or die "$path: $!";
902
903	my $source =
904	"package $pkg; use strict; use utf8;\n"
905	. "#line 1 \"$path\"\n{\n"
906	. (do { local $/; <$fh> })
907	. "\n};\n1";
908
909	unless (eval $source) {
910	my $msg = $@ ? "$path: $@\n"
911	: "extension disabled.\n";
912	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
913	warn $@;
914	warn "mandatory extension failed to load, exiting.\n";
915	exit 1;
916	}
917	die $@;
918	}
919
920	push @EXTS, $pkg;
921	}
922
923	sub load_extensions {	1132	sub load_extensions {
		1133	cf::sync_job {
		1134	my %todo;
		1135
924	for my $ext (<$LIBDIR/*.ext>) {	1136	for my $path (<$LIBDIR/*.ext>) {
925	next unless -r $ext;	1137	next unless -r $path;
926	eval {	1138
927	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;
928	1	1196	}
929	} or warn "$ext not loaded: $@";	1197
		1198	skip:
		1199	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1200	unless $progress;
		1201	}
930	}	1202	};
931	}	1203	}
932		1204
933	#############################################################################	1205	#############################################################################
934		1206
		1207	=back
		1208
935	=head2 CORE EXTENSIONS	1209	=head2 CORE EXTENSIONS
936		1210
937	Functions and methods that extend core crossfire objects.	1211	Functions and methods that extend core crossfire objects.
938		1212
939	=cut	1213	=cut
…		…
951	Returns the given player object, loading it if necessary (might block).	1225	Returns the given player object, loading it if necessary (might block).
952		1226
953	=cut	1227	=cut
954		1228
955	sub playerdir($) {	1229	sub playerdir($) {
956	cf::localdir	1230	"$PLAYERDIR/"
957	. "/"
958	. cf::playerdir
959	. "/"
960	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1231	. (ref $_[0] ? $_[0]->ob->name : $_[0])
961	}	1232	}
962		1233
963	sub path($) {	1234	sub path($) {
964	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1235	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
965		1236
966	(playerdir $login) . "/$login.pl"	1237	(playerdir $login) . "/playerdata"
967	}	1238	}
968		1239
969	sub find_active($) {	1240	sub find_active($) {
970	$cf::PLAYER{$_[0]}	1241	$cf::PLAYER{$_[0]}
971	and $cf::PLAYER{$_[0]}->active	1242	and $cf::PLAYER{$_[0]}->active
…		…
984	my $login = $_[0];	1255	my $login = $_[0];
985		1256
986	my $guard = cf::lock_acquire "user_find:$login";	1257	my $guard = cf::lock_acquire "user_find:$login";
987		1258
988	$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
989	my $pl = load_pl path $login	1267	my $pl = load_pl path $login
990	or return;	1268	or return;
991	$cf::PLAYER{$login} = $pl	1269	$cf::PLAYER{$login} = $pl
992	}	1270	}
993	}	1271	}
…		…
1077	while and may block, so not sync_job-capable, ever.	1355	while and may block, so not sync_job-capable, ever.
1078		1356
1079	=cut	1357	=cut
1080		1358
1081	sub list_logins {	1359	sub list_logins {
1082	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1360	my $dirs = aio_readdir $PLAYERDIR
1083	or return [];	1361	or return [];
1084		1362
1085	my @logins;	1363	my @logins;
1086		1364
1087	for my $login (@$dirs) {	1365	for my $login (@$dirs) {
…		…
1122	}	1400	}
1123		1401
1124	\@paths	1402	\@paths
1125	}	1403	}
1126		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
1127	=item $player->ext_reply ($msgid, $msgtype, %msg)	1455	=item $player->ext_reply ($msgid, %msg)
1128		1456
1129	Sends an ext reply to the player.	1457	Sends an ext reply to the player.
1130		1458
1131	=cut	1459	=cut
1132		1460
1133	sub ext_reply($$$%) {	1461	sub ext_reply($$%) {
1134	my ($self, $id, %msg) = @_;	1462	my ($self, $id, %msg) = @_;
1135		1463
1136	$msg{msgid} = $id;	1464	$msg{msgid} = $id;
1137		1465	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1138	$self->send ("ext " . cf::to_json \%msg);
1139	}	1466	}
1140		1467
1141	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	}
1142		1508
1143	=back	1509	=back
1144
1145		1510
1146	=head3 cf::map	1511	=head3 cf::map
1147		1512
1148	=over 4	1513	=over 4
1149		1514
…		…
1204	my ($self, $merge) = @_;	1569	my ($self, $merge) = @_;
1205		1570
1206	# we have to keep some variables in memory intact	1571	# we have to keep some variables in memory intact
1207	local $self->{path};	1572	local $self->{path};
1208	local $self->{load_path};	1573	local $self->{load_path};
1209	local $self->{deny_save};
1210	local $self->{deny_reset};
1211		1574
1212	$self->SUPER::thawer_merge ($merge);	1575	$self->SUPER::thawer_merge ($merge);
1213	}	1576	}
1214		1577
1215	sub normalise {	1578	sub normalise {
…		…
1262	$self->init; # pass $1 etc.	1625	$self->init; # pass $1 etc.
1263	return $self;	1626	return $self;
1264	}	1627	}
1265	}	1628	}
1266		1629
1267	Carp::carp "unable to resolve path '$path' (base '$base').";	1630	Carp::cluck "unable to resolve path '$path' (base '$base').";
1268	()	1631	()
1269	}	1632	}
1270		1633
1271	sub init {	1634	sub init {
1272	my ($self) = @_;	1635	my ($self) = @_;
…		…
1287		1650
1288	# the original (read-only) location	1651	# the original (read-only) location
1289	sub load_path {	1652	sub load_path {
1290	my ($self) = @_;	1653	my ($self) = @_;
1291		1654
1292	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1655	"$MAPDIR/$self->{path}.map"
1293	}	1656	}
1294		1657
1295	# the temporary/swap location	1658	# the temporary/swap location
1296	sub save_path {	1659	sub save_path {
1297	my ($self) = @_;	1660	my ($self) = @_;
1298		1661
1299	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1662	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1300	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1663	"$TMPDIR/$path.map"
1301	}	1664	}
1302		1665
1303	# the unique path, undef == no special unique path	1666	# the unique path, undef == no special unique path
1304	sub uniq_path {	1667	sub uniq_path {
1305	my ($self) = @_;	1668	my ($self) = @_;
1306		1669
1307	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1670	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1308	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1671	"$UNIQUEDIR/$path"
1309	}	1672	}
1310		1673
1311	# and all this just because we cannot iterate over	1674	# and all this just because we cannot iterate over
1312	# all maps in C++...	1675	# all maps in C++...
1313	sub change_all_map_light {	1676	sub change_all_map_light {
1314	my ($change) = @_;	1677	my ($change) = @_;
1315		1678
1316	$_->change_map_light ($change)	1679	$_->change_map_light ($change)
1317	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;
1318	}	1689	}
1319		1690
1320	sub unlink_save {	1691	sub unlink_save {
1321	my ($self) = @_;	1692	my ($self) = @_;
1322		1693
…		…
1380	$self->load_header_orig	1751	$self->load_header_orig
1381	or return;	1752	or return;
1382	$self->prepare_orig;	1753	$self->prepare_orig;
1383	}	1754	}
1384		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
1385	1	1762	1
1386	}	1763	}
1387		1764
1388	sub find;	1765	sub find;
1389	sub find {	1766	sub find {
…		…
1401	$map->{last_save} = $cf::RUNTIME;	1778	$map->{last_save} = $cf::RUNTIME;
1402		1779
1403	$map->load_header	1780	$map->load_header
1404	or return;	1781	or return;
1405		1782
1406	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1783	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1407	# doing this can freeze the server in a sync job, obviously	1784	# doing this can freeze the server in a sync job, obviously
1408	#$cf::WAIT_FOR_TICK->wait;	1785	#$cf::WAIT_FOR_TICK->wait;
1409	$map->reset;	1786	$map->reset;
1410	undef $guard;	1787	undef $guard;
1411	return find $path;	1788	return find $path;
…		…
1422	my ($self) = @_;	1799	my ($self) = @_;
1423		1800
1424	local $self->{deny_reset} = 1; # loading can take a long time	1801	local $self->{deny_reset} = 1; # loading can take a long time
1425		1802
1426	my $path = $self->{path};	1803	my $path = $self->{path};
		1804
		1805	{
1427	my $guard = cf::lock_acquire "map_load:$path";	1806	my $guard = cf::lock_acquire "map_load:$path";
1428		1807
1429	return if $self->in_memory != cf::MAP_SWAPPED;	1808	return if $self->in_memory != cf::MAP_SWAPPED;
1430		1809
1431	$self->in_memory (cf::MAP_LOADING);	1810	$self->in_memory (cf::MAP_LOADING);
1432		1811
1433	$self->alloc;	1812	$self->alloc;
1434		1813
1435	$self->pre_load;	1814	$self->pre_load;
1436
1437	$self->_load_objects ($self->{load_path}, 1)
1438	or return;
1439
1440	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1441	if delete $self->{load_original};
1442
1443	if (my $uniq = $self->uniq_path) {
1444	utf8::encode $uniq;
1445	if (aio_open $uniq, O_RDONLY, 0) {
1446	$self->clear_unique_items;
1447	$self->_load_objects ($uniq, 0);
1448	}
1449	}
1450
1451	Coro::cede;
1452
1453	# now do the right thing for maps
1454	$self->link_multipart_objects;
1455
1456	unless ($self->{deny_activate}) {
1457	$self->decay_objects;
1458	$self->fix_auto_apply;
1459	$self->update_buttons;
1460	Coro::cede;	1815	Coro::cede;
1461	$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;
1462	$self->difficulty ($self->estimate_difficulty)	1834	$self->difficulty ($self->estimate_difficulty)
1463	unless $self->difficulty;	1835	unless $self->difficulty;
1464	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;
1465	$self->activate;	1845	$self->activate;
		1846	}
		1847
		1848	$self->in_memory (cf::MAP_IN_MEMORY);
1466	}	1849	}
1467		1850
1468	$self->post_load;	1851	$self->post_load;
1469
1470	$self->in_memory (cf::MAP_IN_MEMORY);
1471	}	1852	}
1472		1853
1473	sub customise_for {	1854	sub customise_for {
1474	my ($self, $ob) = @_;	1855	my ($self, $ob) = @_;
1475		1856
1476	return find "~" . $ob->name . "/" . $self->{path}	1857	return find "~" . $ob->name . "/" . $self->{path}
1477	if $self->per_player;	1858	if $self->per_player;
		1859
		1860	# return find "?party/" . $ob->name . "/" . $self->{path}
		1861	# if $self->per_party;
1478		1862
1479	$self	1863	$self
1480	}	1864	}
1481		1865
1482	# 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
…		…
1529		1913
1530	undef $MAP_PREFETCH{$path};	1914	undef $MAP_PREFETCH{$path};
1531	$MAP_PREFETCHER ||= cf::async {	1915	$MAP_PREFETCHER ||= cf::async {
1532	while (%MAP_PREFETCH) {	1916	while (%MAP_PREFETCH) {
1533	for my $path (keys %MAP_PREFETCH) {	1917	for my $path (keys %MAP_PREFETCH) {
1534	my $map = find $path	1918	if (my $map = find $path) {
1535	or next;
1536	$map->load;	1919	$map->load;
		1920	}
1537		1921
1538	delete $MAP_PREFETCH{$path};	1922	delete $MAP_PREFETCH{$path};
1539	}	1923	}
1540	}	1924	}
1541	undef $MAP_PREFETCHER;	1925	undef $MAP_PREFETCHER;
…		…
1593		1977
1594	sub reset_at {	1978	sub reset_at {
1595	my ($self) = @_;	1979	my ($self) = @_;
1596		1980
1597	# TODO: safety, remove and allow resettable per-player maps	1981	# TODO: safety, remove and allow resettable per-player maps
1598	return 1e99 if $self->isa ("ext::map_per_player");#d#
1599	return 1e99 if $self->{deny_reset};	1982	return 1e99 if $self->{deny_reset};
1600		1983
1601	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1984	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1602	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;
1603		1986
…		…
1614	my ($self) = @_;	1997	my ($self) = @_;
1615		1998
1616	my $lock = cf::lock_acquire "map_data:$self->{path}";	1999	my $lock = cf::lock_acquire "map_data:$self->{path}";
1617		2000
1618	return if $self->players;	2001	return if $self->players;
1619	return if $self->isa ("ext::map_per_player");#d#
1620		2002
1621	warn "resetting map ", $self->path;#d#	2003	warn "resetting map ", $self->path;
1622		2004
1623	$self->in_memory (cf::MAP_SWAPPED);	2005	$self->in_memory (cf::MAP_SWAPPED);
1624		2006
1625	# need to save uniques path	2007	# need to save uniques path
1626	unless ($self->{deny_save}) {	2008	unless ($self->{deny_save}) {
…		…
1658	$cf::MAP{$self->path} = $self;	2040	$cf::MAP{$self->path} = $self;
1659		2041
1660	$self->reset; # polite request, might not happen	2042	$self->reset; # polite request, might not happen
1661	}	2043	}
1662		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
1663	=item cf::map::unique_maps	2081	=item cf::map::unique_maps
1664		2082
1665	Returns an arrayref of paths of all shared maps that have	2083	Returns an arrayref of paths of all shared maps that have
1666	instantiated unique items. May block.	2084	instantiated unique items. May block.
1667		2085
1668	=cut	2086	=cut
1669		2087
1670	sub unique_maps() {	2088	sub unique_maps() {
1671	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2089	[
1672	or return;	2090	map {
1673
1674	my @paths;
1675
1676	for (@$files) {
1677	utf8::decode $_;	2091	utf8::decode $_;
1678	next if /\.pst$/;	2092	/\.map$/
1679	next unless /^$PATH_SEP/o;	2093	? normalise $_
1680		2094	: ()
1681	push @paths, cf::map::normalise $_;	2095	} @{ aio_readdir $UNIQUEDIR or [] }
1682	}	2096	]
1683
1684	\@paths
1685	}	2097	}
1686		2098
1687	package cf;	2099	package cf;
1688		2100
1689	=back	2101	=back
…		…
1735		2147
1736	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2148	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1737		2149
1738	if ($self->{record_replies}) {	2150	if ($self->{record_replies}) {
1739	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2151	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2152
1740	} 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 {
1741	$msg = $npc->name . " says: $msg" if $npc;	2166	$msg = $npc->name . " says: $msg" if $npc;
1742	$self->message ($msg, $flags);	2167	$self->message ($msg, $flags);
		2168	}
1743	}	2169	}
1744	}	2170	}
1745		2171
1746	=item $player_object->may ("access")	2172	=item $player_object->may ("access")
1747		2173
…		…
1795	$self->deactivate_recursive;	2221	$self->deactivate_recursive;
1796		2222
1797	return if UNIVERSAL::isa $self->map, "ext::map_link";	2223	return if UNIVERSAL::isa $self->map, "ext::map_link";
1798		2224
1799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2225	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1800	if $self->map;	2226	if $self->map && $self->map->{path} ne "{link}";
1801		2227
1802	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2228	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1803	}	2229	}
1804		2230
1805	sub cf::object::player::leave_link {	2231	sub cf::object::player::leave_link {
1806	my ($self, $map, $x, $y) = @_;	2232	my ($self, $map, $x, $y) = @_;
		2233
		2234	return unless $self->contr->active;
1807		2235
1808	my $link_pos = delete $self->{_link_pos};	2236	my $link_pos = delete $self->{_link_pos};
1809		2237
1810	unless ($map) {	2238	unless ($map) {
1811	# restore original map position	2239	# restore original map position
…		…
1834		2262
1835	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2263	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1836	$self->enter_map ($map, $x, $y);	2264	$self->enter_map ($map, $x, $y);
1837	}	2265	}
1838		2266
1839	cf::player->attach (	2267	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1840	on_logout => sub {
1841	my ($pl) = @_;
1842		2268
1843	# abort map switching before logout	2269	Moves the player to the given map-path and coordinates by first freezing
1844	if ($pl->ob->{_link_pos}) {	2270	her, loading and preparing them map, calling the provided $check callback
1845	cf::sync_job {	2271	that has to return the map if sucecssful, and then unfreezes the player on
1846	$pl->ob->leave_link	2272	the new (success) or old (failed) map position. In either case, $done will
1847	};	2273	be called at the end of this process.
1848	}
1849	},
1850	on_login => sub {
1851	my ($pl) = @_;
1852		2274
1853	# try to abort aborted map switching on player login :)
1854	# should happen only on crashes
1855	if ($pl->ob->{_link_pos}) {
1856	$pl->ob->enter_link;
1857	(async {
1858	$pl->ob->reply (undef,
1859	"There was an internal problem at your last logout, "
1860	. "the server will try to bring you to your intended destination in a second.",
1861	cf::NDI_RED);
1862	# we need this sleep as the login has a concurrent enter_exit running
1863	# and this sleep increases chances of the player not ending up in scorn
1864	Coro::Timer::sleep 1;
1865	$pl->ob->leave_link;
1866	})->prio (2);
1867	}
1868	},
1869	);
1870
1871	=item $player_object->goto ($path, $x, $y)
1872
1873	=cut	2275	=cut
		2276
		2277	our $GOTOGEN;
1874		2278
1875	sub cf::object::player::goto {	2279	sub cf::object::player::goto {
1876	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;
1877		2284
1878	$self->enter_link;	2285	$self->enter_link;
1879		2286
1880	(async {	2287	(async {
1881	my $map = eval {	2288	my $map = eval {
1882	my $map = cf::map::find $path;	2289	my $map = cf::map::find $path;
		2290
		2291	if ($map) {
1883	$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
1884	$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 $@;
1885	} or	2304	}
1886	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1887		2305
		2306	if ($gen == $self->{_goto_generation}) {
		2307	delete $self->{_goto_generation};
1888	$self->leave_link ($map, $x, $y);	2308	$self->leave_link ($map, $x, $y);
		2309	}
		2310
		2311	$done->() if $done;
1889	})->prio (1);	2312	})->prio (1);
1890	}	2313	}
1891		2314
1892	=item $player_object->enter_exit ($exit_object)	2315	=item $player_object->enter_exit ($exit_object)
1893		2316
…		…
1932		2355
1933	$rmp->{random_seed} ||= $exit->random_seed;	2356	$rmp->{random_seed} ||= $exit->random_seed;
1934		2357
1935	my $data = cf::to_json $rmp;	2358	my $data = cf::to_json $rmp;
1936	my $md5 = Digest::MD5::md5_hex $data;	2359	my $md5 = Digest::MD5::md5_hex $data;
1937	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2360	my $meta = "$RANDOMDIR/$md5.meta";
1938		2361
1939	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2362	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1940	aio_write $fh, 0, (length $data), $data, 0;	2363	aio_write $fh, 0, (length $data), $data, 0;
1941	undef $fh;	2364	undef $fh;
1942	aio_rename "$meta~", $meta;	2365	aio_rename "$meta~", $meta;
…		…
1951		2374
1952	return unless $self->type == cf::PLAYER;	2375	return unless $self->type == cf::PLAYER;
1953		2376
1954	if ($exit->slaying eq "/!") {	2377	if ($exit->slaying eq "/!") {
1955	#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
1956	cf::sync_job { prepare_random_map $exit };	2381	cf::sync_job { prepare_random_map $exit };
1957	}	2382	}
1958		2383
1959	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;
1960	my $hp = $exit->stats->hp;	2385	my $hp = $exit->stats->hp;
1961	my $sp = $exit->stats->sp;	2386	my $sp = $exit->stats->sp;
1962		2387
1963	$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);
1964		2393
1965	(async {	2394	(async {
1966	$self->deactivate_recursive; # just to be sure	2395	$self->deactivate_recursive; # just to be sure
1967	unless (eval {	2396	unless (eval {
1968	$self->goto ($slaying, $hp, $sp);	2397	$self->goto ($slaying, $hp, $sp);
1969		2398
1970	1;	2399	1;
1971	}) {	2400	}) {
1972	$self->message ("Something went wrong deep within the crossfire server. "	2401	$self->message ("Something went wrong deep within the crossfire server. "
1973	. "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. "
1974	. "Please report this to the dungeon master!",	2403	. "Please report this to the dungeon master!",
1975	cf::NDI_UNIQUE | cf::NDI_RED);	2404	cf::NDI_UNIQUE | cf::NDI_RED);
1976		2405
1977	warn "ERROR in enter_exit: $@";	2406	warn "ERROR in enter_exit: $@";
1978	$self->leave_link;	2407	$self->leave_link;
1979	}	2408	}
1980	})->prio (1);	2409	})->prio (1);
…		…
1993		2422
1994	sub cf::client::send_drawinfo {	2423	sub cf::client::send_drawinfo {
1995	my ($self, $text, $flags) = @_;	2424	my ($self, $text, $flags) = @_;
1996		2425
1997	utf8::encode $text;	2426	utf8::encode $text;
1998	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2427	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1999	}	2428	}
2000		2429
		2430	=item $client->send_msg ($color, $type, $msg, [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, $color, $type, $msg, @extra) = @_;
		2441
		2442	$msg = $self->pl->expand_cfpod ($msg);
		2443
		2444	return unless @extra || length $msg;
		2445
		2446	if ($self->can_msg) {
		2447	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2448	} else {
		2449	# replace some tags by gcfclient-compatible ones
		2450	for ($msg) {
		2451	1 while
		2452	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2453	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2454	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2455	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2456	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2457	}
		2458
		2459	if ($color >= 0) {
		2460	if (0 && $msg =~ /\[/) {
		2461	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2462	} else {
		2463	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2464	$self->send_packet ("drawinfo $color $msg")
		2465	}
		2466	}
		2467	}
		2468	}
		2469
		2470	=item $client->ext_event ($type, %msg)
		2471
		2472	Sends an ext event to the client.
		2473
		2474	=cut
		2475
		2476	sub cf::client::ext_event($$%) {
		2477	my ($self, $type, %msg) = @_;
		2478
		2479	return unless $self->extcmd;
		2480
		2481	$msg{msgtype} = "event_$type";
		2482	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2483	}
2001		2484
2002	=item $success = $client->query ($flags, "text", \&cb)	2485	=item $success = $client->query ($flags, "text", \&cb)
2003		2486
2004	Queues a query to the client, calling the given callback with	2487	Queues a query to the client, calling the given callback with
2005	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2488	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2006	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2489	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2007		2490
2008	Queries can fail, so check the return code. Or don't, as queries will become	2491	Queries can fail, so check the return code. Or don't, as queries will
2009	reliable at some point in the future.	2492	become reliable at some point in the future.
2010		2493
2011	=cut	2494	=cut
2012		2495
2013	sub cf::client::query {	2496	sub cf::client::query {
2014	my ($self, $flags, $text, $cb) = @_;	2497	my ($self, $flags, $text, $cb) = @_;
…		…
2022	utf8::encode $text;	2505	utf8::encode $text;
2023	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2506	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2024		2507
2025	$self->send_packet ($self->{query_queue}[0][0])	2508	$self->send_packet ($self->{query_queue}[0][0])
2026	if @{ $self->{query_queue} } == 1;	2509	if @{ $self->{query_queue} } == 1;
		2510
		2511	1
2027	}	2512	}
2028		2513
2029	cf::client->attach (	2514	cf::client->attach (
		2515	on_connect => sub {
		2516	my ($ns) = @_;
		2517
		2518	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2519	},
2030	on_reply => sub {	2520	on_reply => sub {
2031	my ($ns, $msg) = @_;	2521	my ($ns, $msg) = @_;
2032		2522
2033	# this weird shuffling is so that direct followup queries	2523	# this weird shuffling is so that direct followup queries
2034	# get handled first	2524	# get handled first
…		…
2046	} else {	2536	} else {
2047	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2537	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2048	}	2538	}
2049	}	2539	}
2050	},	2540	},
		2541	on_exticmd => sub {
		2542	my ($ns, $buf) = @_;
		2543
		2544	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2545
		2546	if (ref $msg) {
		2547	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2548	if (my %reply = $cb->($ns, $msg)) {
		2549	$reply{msgid} = $msg->{msgid};
		2550	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2551	}
		2552	}
		2553	} else {
		2554	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2555	}
		2556
		2557	cf::override;
		2558	},
2051	);	2559	);
2052		2560
2053	=item $client->async (\&cb)	2561	=item $client->async (\&cb)
2054		2562
2055	Create a new coroutine, running the specified callback. The coroutine will	2563	Create a new coroutine, running the specified callback. The coroutine will
…		…
2102		2610
2103	# here we export the classes and methods available to script code	2611	# here we export the classes and methods available to script code
2104		2612
2105	=pod	2613	=pod
2106		2614
2107	The following fucntions and emthods are available within a safe environment:	2615	The following functions and methods are available within a safe environment:
2108		2616
2109	cf::object contr pay_amount pay_player map	2617	cf::object
		2618	contr pay_amount pay_player map x y force_find force_add
		2619	insert remove
		2620
2110	cf::object::player player	2621	cf::object::player
2111	cf::player peaceful	2622	player
2112	cf::map trigger	2623
		2624	cf::player
		2625	peaceful
		2626
		2627	cf::map
		2628	trigger
2113		2629
2114	=cut	2630	=cut
2115		2631
2116	for (	2632	for (
2117	["cf::object" => qw(contr pay_amount pay_player map)],	2633	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2634	insert remove)],
2118	["cf::object::player" => qw(player)],	2635	["cf::object::player" => qw(player)],
2119	["cf::player" => qw(peaceful)],	2636	["cf::player" => qw(peaceful)],
2120	["cf::map" => qw(trigger)],	2637	["cf::map" => qw(trigger)],
2121	) {	2638	) {
2122	no strict 'refs';	2639	no strict 'refs';
…		…
2193	=back	2710	=back
2194		2711
2195	=cut	2712	=cut
2196		2713
2197	#############################################################################	2714	#############################################################################
2198
2199	=head2 EXTENSION DATABASE SUPPORT
2200
2201	Crossfire maintains a very simple database for extension use. It can
2202	currently store anything that can be serialised using Storable, which
2203	excludes objects.
2204
2205	The parameter C<$family> should best start with the name of the extension
2206	using it, it should be unique.
2207
2208	=over 4
2209
2210	=item $value = cf::db_get $family => $key
2211
2212	Returns a single value from the database.
2213
2214	=item cf::db_put $family => $key => $value
2215
2216	Stores the given C<$value> in the family.
2217
2218	=cut
2219
2220	our $DB;
2221
2222	sub db_init {
2223	unless ($DB) {
2224	$DB = BDB::db_create $DB_ENV;
2225
2226	cf::sync_job {
2227	eval {
2228	$DB->set_flags (BDB::CHKSUM);
2229
2230	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2231	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2232	cf::cleanup "db_open(db): $!" if $!;
2233	};
2234	cf::cleanup "db_open(db): $@" if $@;
2235	};
2236
2237	my $path = cf::localdir . "/database.pst";
2238	if (stat $path) {
2239	cf::sync_job {
2240	my $pst = Storable::retrieve $path;
2241
2242	cf::db_put (board => data => $pst->{board});
2243	cf::db_put (guildrules => data => $pst->{guildrules});
2244	cf::db_put (rent => balance => $pst->{rent}{balance});
2245	BDB::db_env_txn_checkpoint $DB_ENV;
2246
2247	unlink $path;
2248	};
2249	}
2250	}
2251	}
2252
2253	sub db_get($$) {
2254	my $key = "$_[0]/$_[1]";
2255
2256	cf::sync_job {
2257	BDB::db_get $DB, undef, $key, my $data;
2258
2259	$! ? ()
2260	: Compress::LZF::sthaw $data
2261	}
2262	}
2263
2264	sub db_put($$$) {
2265	BDB::dbreq_pri 4;
2266	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2267	}
2268
2269	#############################################################################
2270	# the server's init and main functions	2715	# the server's init and main functions
2271		2716
2272	sub load_faces {	2717	sub load_facedata($) {
2273	my $path = sprintf "%s/faces", cf::datadir;	2718	my ($path) = @_;
2274		2719
2275	warn "loading faces from $path\n";	2720	warn "loading facedata from $path\n";
2276		2721
2277	my $faces;	2722	my $facedata;
2278	0 < aio_load $path, $faces	2723	0 < aio_load $path, $facedata
2279	or die "$path: $!";	2724	or die "$path: $!";
2280		2725
2281	Coro::cede;
2282	$faces = Storable::thaw $faces;	2726	$facedata = Coro::Storable::thaw $facedata;
2283	Coro::cede;
2284		2727
		2728	$facedata->{version} == 2
		2729	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2730
		2731	{
		2732	my $faces = $facedata->{faceinfo};
		2733
2285	while (my ($face, $info) = each %$faces) {	2734	while (my ($face, $info) = each %$faces) {
2286	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2735	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2287	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2736	cf::face::set_visibility $idx, $info->{visibility};
		2737	cf::face::set_magicmap $idx, $info->{magicmap};
2288	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2738	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2289	Coro::cede;	2739	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2740
		2741	cf::cede_to_tick;
		2742	}
		2743
		2744	while (my ($face, $info) = each %$faces) {
		2745	next unless $info->{smooth};
		2746	my $idx = cf::face::find $face
		2747	or next;
		2748	if (my $smooth = cf::face::find $info->{smooth}) {
		2749	cf::face::set_smooth $idx, $smooth;
		2750	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2751	} else {
		2752	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2753	}
		2754
		2755	cf::cede_to_tick;
		2756	}
		2757	}
		2758
		2759	{
		2760	my $anims = $facedata->{animinfo};
		2761
		2762	while (my ($anim, $info) = each %$anims) {
		2763	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2764	cf::cede_to_tick;
		2765	}
		2766
		2767	cf::anim::invalidate_all; # d'oh
		2768	}
		2769
		2770	{
		2771	# TODO: for gcfclient pleasure, we should give resources
		2772	# that gcfclient doesn't grok a >10000 face index.
		2773	my $res = $facedata->{resource};
		2774	my $enc = JSON::XS->new->utf8->canonical;
		2775
		2776	while (my ($name, $info) = each %$res) {
		2777	my $meta = $enc->encode ({
		2778	name => $name,
		2779	type => $info->{type},
		2780	copyright => $info->{copyright}, #TODO#
		2781	});
		2782
		2783	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2784
		2785	if ($name =~ /\.jpg$/) {
		2786	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2787	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2788	} else {
		2789	my $data = pack "(w/a*)*", $meta, $info->{data};
		2790	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2791
		2792	cf::face::set_type $idx, 1;
		2793	cf::face::set_data $idx, 0, $data, $chk;
		2794	}
		2795
		2796	cf::cede_to_tick;
		2797	}
2290	}	2798	}
2291		2799
2292	1	2800	1
2293	}	2801	}
2294		2802
		2803	sub reload_regions {
		2804	load_resource_file "$MAPDIR/regions"
		2805	or die "unable to load regions file\n";
		2806
		2807	for (cf::region::list) {
		2808	$_->{match} = qr/$_->{match}/
		2809	if exists $_->{match};
		2810	}
		2811	}
		2812
		2813	sub reload_facedata {
		2814	load_facedata "$DATADIR/facedata"
		2815	or die "unable to load facedata\n";
		2816	}
		2817
		2818	sub reload_archetypes {
		2819	load_resource_file "$DATADIR/archetypes"
		2820	or die "unable to load archetypes\n";
		2821	#d# NEED to laod twice to resolve forward references
		2822	# this really needs to be done in an extra post-pass
		2823	# (which needs to be synchronous, so solve it differently)
		2824	load_resource_file "$DATADIR/archetypes"
		2825	or die "unable to load archetypes\n";
		2826	}
		2827
		2828	sub reload_treasures {
		2829	load_resource_file "$DATADIR/treasures"
		2830	or die "unable to load treasurelists\n";
		2831	}
		2832
2295	sub reload_resources {	2833	sub reload_resources {
2296	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2834	warn "reloading resource files...\n";
2297	or die "unable to load regions file\n";#d#	2835
		2836	reload_regions;
2298	load_faces	2837	reload_facedata;
2299	or die "unable to load faces\n";#d#	2838	#reload_archetypes;#d#
		2839	reload_archetypes;
		2840	reload_treasures;
		2841
		2842	warn "finished reloading resource files\n";
2300	}	2843	}
2301		2844
2302	sub init {	2845	sub init {
2303	reload_resources;	2846	reload_resources;
2304	}	2847	}
2305		2848
2306	sub cfg_load {	2849	sub cfg_load {
2307	open my $fh, "<:utf8", cf::confdir . "/config"	2850	open my $fh, "<:utf8", "$CONFDIR/config"
2308	or return;	2851	or return;
2309		2852
2310	local $/;	2853	local $/;
2311	*CFG = YAML::Syck::Load <$fh>;	2854	*CFG = YAML::Syck::Load <$fh>;
2312		2855
…		…
2357	},	2900	},
2358	);	2901	);
2359	}	2902	}
2360	}	2903	}
2361		2904
		2905	sub write_runtime {
		2906	my $runtime = "$LOCALDIR/runtime";
		2907
		2908	# first touch the runtime file to show we are still running:
		2909	# the fsync below can take a very very long time.
		2910
		2911	IO::AIO::aio_utime $runtime, undef, undef;
		2912
		2913	my $guard = cf::lock_acquire "write_runtime";
		2914
		2915	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2916	or return;
		2917
		2918	my $value = $cf::RUNTIME + 90 + 10;
		2919	# 10 is the runtime save interval, for a monotonic clock
		2920	# 60 allows for the watchdog to kill the server.
		2921
		2922	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2923	and return;
		2924
		2925	# always fsync - this file is important
		2926	aio_fsync $fh
		2927	and return;
		2928
		2929	# touch it again to show we are up-to-date
		2930	aio_utime $fh, undef, undef;
		2931
		2932	close $fh
		2933	or return;
		2934
		2935	aio_rename "$runtime~", $runtime
		2936	and return;
		2937
		2938	warn "runtime file written.\n";
		2939
		2940	1
		2941	}
		2942
2362	sub emergency_save() {	2943	sub emergency_save() {
2363	my $freeze_guard = cf::freeze_mainloop;	2944	my $freeze_guard = cf::freeze_mainloop;
2364		2945
2365	warn "enter emergency perl save\n";	2946	warn "enter emergency perl save\n";
2366		2947
…		…
2397		2978
2398	warn Carp::longmess "post_cleanup backtrace"	2979	warn Carp::longmess "post_cleanup backtrace"
2399	if $make_core;	2980	if $make_core;
2400	}	2981	}
2401		2982
2402	sub reload() {	2983	sub do_reload_perl() {
2403	# can/must only be called in main	2984	# can/must only be called in main
2404	if ($Coro::current != $Coro::main) {	2985	if ($Coro::current != $Coro::main) {
2405	warn "can only reload from main coroutine";	2986	warn "can only reload from main coroutine";
2406	return;	2987	return;
2407	}	2988	}
…		…
2441	%EXT_CORO = ();	3022	%EXT_CORO = ();
2442		3023
2443	warn "removing commands";	3024	warn "removing commands";
2444	%COMMAND = ();	3025	%COMMAND = ();
2445		3026
2446	warn "removing ext commands";	3027	warn "removing ext/exti commands";
2447	%EXTCMD = ();	3028	%EXTCMD = ();
		3029	%EXTICMD = ();
2448		3030
2449	warn "unloading/nuking all extensions";	3031	warn "unloading/nuking all extensions";
2450	for my $pkg (@EXTS) {	3032	for my $pkg (@EXTS) {
2451	warn "... unloading $pkg";	3033	warn "... unloading $pkg";
2452		3034
…		…
2482	Symbol::delete_package "safe::$_"	3064	Symbol::delete_package "safe::$_"
2483	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3065	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2484		3066
2485	warn "unloading cf.pm \"a bit\"";	3067	warn "unloading cf.pm \"a bit\"";
2486	delete $INC{"cf.pm"};	3068	delete $INC{"cf.pm"};
		3069	delete $INC{"cf/pod.pm"};
2487		3070
2488	# don't, removes xs symbols, too,	3071	# don't, removes xs symbols, too,
2489	# and global variables created in xs	3072	# and global variables created in xs
2490	#Symbol::delete_package __PACKAGE__;	3073	#Symbol::delete_package __PACKAGE__;
2491		3074
…		…
2506	warn "reattaching attachments to maps";	3089	warn "reattaching attachments to maps";
2507	reattach $_ for values %MAP;	3090	reattach $_ for values %MAP;
2508	warn "reattaching attachments to players";	3091	warn "reattaching attachments to players";
2509	reattach $_ for values %PLAYER;	3092	reattach $_ for values %PLAYER;
2510		3093
2511	warn "loading reloadable resources";
2512	reload_resources;
2513
2514	warn "leaving sync_job";	3094	warn "leaving sync_job";
2515		3095
2516	1	3096	1
2517	} or do {	3097	} or do {
2518	warn $@;	3098	warn $@;
…		…
2523	warn "reloaded";	3103	warn "reloaded";
2524	};	3104	};
2525		3105
2526	our $RELOAD_WATCHER; # used only during reload	3106	our $RELOAD_WATCHER; # used only during reload
2527		3107
		3108	sub reload_perl() {
		3109	# doing reload synchronously and two reloads happen back-to-back,
		3110	# coro crashes during coro_state_free->destroy here.
		3111
		3112	$RELOAD_WATCHER ||= Event->timer (
		3113	reentrant => 0,
		3114	after => 0,
		3115	data => WF_AUTOCANCEL,
		3116	cb => sub {
		3117	do_reload_perl;
		3118	undef $RELOAD_WATCHER;
		3119	},
		3120	);
		3121	}
		3122
2528	register_command "reload" => sub {	3123	register_command "reload" => sub {
2529	my ($who, $arg) = @_;	3124	my ($who, $arg) = @_;
2530		3125
2531	if ($who->flag (FLAG_WIZ)) {	3126	if ($who->flag (FLAG_WIZ)) {
2532	$who->message ("reloading server.");	3127	$who->message ("reloading server.");
2533		3128	async { reload_perl };
2534	# doing reload synchronously and two reloads happen back-to-back,
2535	# coro crashes during coro_state_free->destroy here.
2536
2537	$RELOAD_WATCHER ||= Event->timer (
2538	reentrant => 0,
2539	after => 0,
2540	data => WF_AUTOCANCEL,
2541	cb => sub {
2542	reload;
2543	undef $RELOAD_WATCHER;
2544	},
2545	);
2546	}	3129	}
2547	};	3130	};
2548		3131
2549	unshift @INC, $LIBDIR;	3132	unshift @INC, $LIBDIR;
2550		3133
2551	my $bug_warning = 0;	3134	my $bug_warning = 0;
2552		3135
		3136	our @WAIT_FOR_TICK;
		3137	our @WAIT_FOR_TICK_BEGIN;
		3138
		3139	sub wait_for_tick {
		3140	return unless $TICK_WATCHER->is_active;
		3141	return if $Coro::current == $Coro::main;
		3142
		3143	my $signal = new Coro::Signal;
		3144	push @WAIT_FOR_TICK, $signal;
		3145	$signal->wait;
		3146	}
		3147
		3148	sub wait_for_tick_begin {
		3149	return unless $TICK_WATCHER->is_active;
		3150	return if $Coro::current == $Coro::main;
		3151
		3152	my $signal = new Coro::Signal;
		3153	push @WAIT_FOR_TICK_BEGIN, $signal;
		3154	$signal->wait;
		3155	}
		3156
		3157	my $min = 1e6;#d#
		3158	my $avg = 10;
2553	$TICK_WATCHER = Event->timer (	3159	$TICK_WATCHER = Event->timer (
2554	reentrant => 0,	3160	reentrant => 0,
2555	parked => 1,	3161	parked => 1,
2556	prio => 0,	3162	prio => 0,
2557	at => $NEXT_TICK || $TICK,	3163	at => $NEXT_TICK || $TICK,
…		…
2561	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3167	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2562	unless ++$bug_warning > 10;	3168	unless ++$bug_warning > 10;
2563	return;	3169	return;
2564	}	3170	}
2565		3171
2566	$NOW = Event::time;	3172	$NOW = $tick_start = Event::time;
2567		3173
2568	cf::server_tick; # one server iteration	3174	cf::server_tick; # one server iteration
		3175
		3176	0 && sync_job {#d#
		3177	for(1..10) {
		3178	my $t = Event::time;
		3179	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3180	or die;
		3181
		3182	$map->width (50);
		3183	$map->height (50);
		3184	$map->alloc;
		3185	$map->_load_objects ("/tmp/x.map", 1);
		3186	my $t = Event::time - $t;
		3187
		3188	#next unless $t < 0.0013;#d#
		3189	if ($t < $min) {
		3190	$min = $t;
		3191	}
		3192	$avg = $avg * 0.99 + $t * 0.01;
		3193	}
		3194	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3195	exit 0;
		3196	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3197	};
		3198
2569	$RUNTIME += $TICK;	3199	$RUNTIME += $TICK;
2570	$NEXT_TICK += $TICK;	3200	$NEXT_TICK += $TICK;
2571		3201
2572	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3202	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2573	$NEXT_RUNTIME_WRITE = $NOW + 10;	3203	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2575	write_runtime	3205	write_runtime
2576	or warn "ERROR: unable to write runtime file: $!";	3206	or warn "ERROR: unable to write runtime file: $!";
2577	};	3207	};
2578	}	3208	}
2579		3209
2580	$WAIT_FOR_TICK->broadcast;
2581	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2582
2583	# my $AFTER = Event::time;	3210	# my $AFTER = Event::time;
2584	# warn $AFTER - $NOW;#d#	3211	# warn $AFTER - $NOW;#d#
2585		3212
		3213	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3214	$sig->send;
		3215	}
		3216	while (my $sig = shift @WAIT_FOR_TICK) {
		3217	$sig->send;
		3218	}
		3219
		3220	$NOW = Event::time;
		3221
2586	# if we are delayed by four ticks or more, skip them all	3222	# if we are delayed by four ticks or more, skip them all
2587	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3223	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2588		3224
2589	$TICK_WATCHER->at ($NEXT_TICK);	3225	$TICK_WATCHER->at ($NEXT_TICK);
2590	$TICK_WATCHER->start;	3226	$TICK_WATCHER->start;
		3227
		3228	$LOAD = ($NOW - $tick_start) / $TICK;
		3229	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3230
		3231	_post_tick;
		3232
		3233
2591	},	3234	},
2592	);	3235	);
2593		3236
2594	{	3237	{
2595	BDB::max_poll_time $TICK * 0.1;	3238	BDB::max_poll_time $TICK * 0.1;
…		…
2623		3266
2624	cf::sync_job {	3267	cf::sync_job {
2625	eval {	3268	eval {
2626	BDB::db_env_open	3269	BDB::db_env_open
2627	$DB_ENV,	3270	$DB_ENV,
2628	$BDB_ENV_DIR,	3271	$BDBDIR,
2629	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3272	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2630	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3273	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2631	0666;	3274	0666;
2632		3275
2633	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3276	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2634		3277
2635	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3278	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2636	$DB_ENV->set_lk_detect;	3279	$DB_ENV->set_lk_detect;
2637	};	3280	};
2638		3281
…		…
2654	prio => 6,	3297	prio => 6,
2655	cb => \&IO::AIO::poll_cb,	3298	cb => \&IO::AIO::poll_cb,
2656	);	3299	);
2657	}	3300	}
2658		3301
		3302	my $_log_backtrace;
		3303
		3304	sub _log_backtrace {
		3305	my ($msg, @addr) = @_;
		3306
		3307	$msg =~ s/\n//;
		3308
		3309	# limit the # of concurrent backtraces
		3310	if ($_log_backtrace < 2) {
		3311	++$_log_backtrace;
		3312	async {
		3313	my @bt = fork_call {
		3314	@addr = map { sprintf "%x", $_ } @addr;
		3315	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3316	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3317	or die "addr2line: $!";
		3318
		3319	my @funcs;
		3320	my @res = <$fh>;
		3321	chomp for @res;
		3322	while (@res) {
		3323	my ($func, $line) = splice @res, 0, 2, ();
		3324	push @funcs, "[$func] $line";
		3325	}
		3326
		3327	@funcs
		3328	};
		3329
		3330	LOG llevInfo, "[ABT] $msg\n";
		3331	LOG llevInfo, "[ABT] $_\n" for @bt;
		3332	--$_log_backtrace;
		3333	};
		3334	} else {
		3335	LOG llevInfo, "[ABT] $msg\n";
		3336	LOG llevInfo, "[ABT] [suppressed]\n";
		3337	}
		3338	}
		3339
		3340	# load additional modules
		3341	use cf::pod;
		3342
2659	END { cf::emergency_save }	3343	END { cf::emergency_save }
2660		3344
2661	1	3345	1
2662		3346

Diff Legend

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