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

Diff Legend

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