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.198 by root, Sun Jan 28 01:58:37 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 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.64 ();
		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;
		24	use Coro::Util ();
19		25
		26	use JSON::XS ();
		27	use BDB ();
20	use Data::Dumper;	28	use Data::Dumper;
21	use Digest::MD5;	29	use Digest::MD5;
22	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
23	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
26		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		44
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
33		47
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
36	our %COMMAND = ();	52	our %COMMAND = ();
37	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
38		54
39	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
43		60
		61	our $RELOAD; # number of reloads so far
44	our @EVENT;	62	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		63
47	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	77	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	80	our $NEXT_TICK;
52	our $NOW;	81	our $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_WATCHER;
		85	our $DB_ENV;
53		86
54	our %CFG;	87	our %CFG;
55		88
56	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	90	our $RUNTIME;
58		91
59	our %PLAYER; # all users	92	our %PLAYER; # all users
60	our %MAP; # all maps	93	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		95
67	# used to convert map paths into valid unix filenames by replacing / by ∕	96	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
		102
70	binmode STDOUT;	103	binmode STDOUT;
71	binmode STDERR;	104	binmode STDERR;
72		105
73	# read virtual server time, if available	106	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
78	}	111	}
79		112
80	mkdir cf::localdir;	113	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		115
86	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
		117
		118	sub cf::map::normalise;
87		119
88	#############################################################################	120	#############################################################################
89		121
90	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
91		123
…		…
98	=item $cf::RUNTIME	130	=item $cf::RUNTIME
99		131
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	132	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	133	every server tick.
102		134
103	=item $cf::LIBDIR	135	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		136	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		137	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		138
105	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	140	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		141	unique-items directory, player file directory, random maps directory and
		142	database environment.
107		143
108	=item $cf::NOW	144	=item $cf::NOW
109		145
110	The time of the last (current) server tick.	146	The time of the last (current) server tick.
111		147
112	=item $cf::TICK	148	=item $cf::TICK
113		149
114	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
115		161
116	=item %cf::CFG	162	=item %cf::CFG
117		163
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	165	from wherever your confdir points to.
120		166
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		168
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	170	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
127		178
128	=back	179	=back
129		180
130	=cut	181	=cut
131		182
132	BEGIN {	183	BEGIN {
133	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	185	my $msg = join "", @_;
135	utf8::encode $msg;
136		186
137	$msg .= "\n"	187	$msg .= "\n"
138	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
139		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
140	LOG llevError, $msg;	193	LOG llevError, $msg;
141	};	194	};
142	}	195	}
143		196
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		204
151	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	206	# within the Safe compartment.
153	for my $pkg (qw(	207	for my $pkg (qw(
154	cf::global cf::attachable	208	cf::global cf::attachable
…		…
162	}	216	}
163		217
164	$Event::DIED = sub {	218	$Event::DIED = sub {
165	warn "error in event callback: @_";	219	warn "error in event callback: @_";
166	};	220	};
		221
		222	#############################################################################
167		223
168	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
169		225
170	=over 4	226	=over 4
171		227
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	247	$d
192	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
193	}	249	}
194		250
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
198		252
199	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
200		254
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
209		256
210	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
211		258
212	=cut	259	=cut
213		260
214	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
216	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
218		265
219	=item cf::lock_wait $string	266	=item cf::lock_wait $string
220		267
221	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
222		269
…		…
225	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
228	returned.	275	returned.
229		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
230	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
232		286
233	=cut	287	=cut
234		288
235	our %LOCK;	289	our %LOCK;
236		290
…		…
256	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
258	}	312	}
259	}	313	}
260		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
261	sub freeze_mainloop {	321	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
263		323
264	my $guard = Coro::guard {	324	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	325	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	326	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
270	$guard	328	$guard
		329	}
		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
271	}	385	}
272		386
273	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
274		388
275	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		394
281	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
282		396
283	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
284		398
285	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
288		403
289	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
292	fast or be very important.	407	fast or be very important.
…		…
295		410
296	sub sync_job(&) {	411	sub sync_job(&) {
297	my ($job) = @_;	412	my ($job) = @_;
298		413
299	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
300	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
302		419
303	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
315		432
316	while ($busy) {	433	while ($busy) {
317	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
318	}	435	}
319		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
		443
320	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
321	} else {	445	} else {
322	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
323		447
324	$job->()	448	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
344		468
345	$coro	469	$coro
346	}	470	}
347		471
348	sub write_runtime {	472	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		473
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
352	or return;	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
353		478
354	my $value = $cf::RUNTIME + 90 + 10;	479	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		480
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	481	sub fork_call(&@) {
359	and return;	482	my ($cb, @args) = @_;
360		483
361	aio_fsync $fh	484	# we seemingly have to make a local copy of the whole thing,
362	and return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
363		487
364	close $fh	488	my @res = Coro::Util::fork_eval {
365	or return;	489	reset_signals;
		490	&$cb
		491	}, @args;
366		492
367	aio_rename "$runtime~", $runtime	493	wantarray ? @res : $res[-1]
368	and return;	494	}
369		495
		496	=item $value = cf::db_get $family => $key
		497
		498	Returns a single value from the environment database.
		499
		500	=item cf::db_put $family => $key => $value
		501
		502	Stores the given C<$value> in the family. It can currently store binary
		503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		504
		505	=cut
		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
370	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
		610	}
		611
		612	=item cf::datalog type => key => value, ...
		613
		614	Log a datalog packet of the given type with the given key-value pairs.
		615
		616	=cut
		617
		618	sub datalog($@) {
		619	my ($type, %kv) = @_;
		620	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
371	}	621	}
372		622
373	=back	623	=back
374		624
375	=cut	625	=cut
…		…
382	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
383	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
384		634
385	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
386	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
387	crossfire+).	637	Crossfire TRT).
388		638
389	=over 4	639	=over 4
390		640
391	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
392		642
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
556		806
557	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		811
562	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	813	my $pkg = shift @arg;
564		814
565	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
595	}	845	}
596		846
597	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
598	} else {	848	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	850	}
601		851
602	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
603	}	853	}
604		854
…		…
606	if (ref $_[0]) {	856	if (ref $_[0]) {
607	_object_attach @_;	857	_object_attach @_;
608	} else {	858	} else {
609	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
610	}	860	}
		861	_recalc_want;
611	};	862	};
612		863
613	# all those should be optimised	864	# all those should be optimised
614	sub cf::attachable::detach {	865	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
619	reattach ($obj);	870	reattach ($obj);
620	} else {	871	} else {
621	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
622	}	873	}
		874	_recalc_want;
623	};	875	};
624		876
625	sub cf::attachable::attached {	877	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
627		879
…		…
642	";	894	";
643	die if $@;	895	die if $@;
644	}	896	}
645		897
646	our $override;	898	our $override;
647	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
648		900
649	sub override {	901	sub override {
650	$override = 1;	902	$override = 1;
651	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
652	}	904	}
653		905
654	sub do_invoke {	906	sub do_invoke {
655	my $event = shift;	907	my $event = shift;
656	my $callbacks = shift;	908	my $callbacks = shift;
657		909
658	@invoke_results = ();	910	@INVOKE_RESULTS = ();
659		911
660	local $override;	912	local $override;
661		913
662	for (@$callbacks) {	914	for (@$callbacks) {
663	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
680		932
681	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
682		934
683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
684	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
685	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		938
687	=back	939	=back
688		940
689	=cut	941	=cut
690		942
691	#############################################################################	943	#############################################################################
692	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
693		956
694	sub reattach {	957	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	959	my ($obj) = @_;
697		960
…		…
750	$filename, length $$rdata, scalar @$objs;	1013	$filename, length $$rdata, scalar @$objs;
751		1014
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1015	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1016	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1017	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1018	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1019	close $fh;
757		1020
758	if (@$objs) {	1021	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1022	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	1023	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1024	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1025	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1026	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1027	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1028	aio_rename "$filename.pst~", "$filename.pst";
766	}	1029	}
767	} else {	1030	} else {
768	aio_unlink "$filename.pst";	1031	aio_unlink "$filename.pst";
…		…
800	or return;	1063	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1065	}
803		1066
804	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1069	return ($data, $av);
807	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
808		1077
809	#############################################################################	1078	#############################################################################
810	# command handling &c	1079	# command handling &c
811		1080
812	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1095	}
827		1096
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1098
830	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
831		1104
832	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
833	called.	1106	called.
834		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
835	=cut	1119	=cut
836		1120
837	sub register_extcmd {	1121	sub register_extcmd {
838	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
839		1123
840	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
841	}	1131	}
842		1132
843	cf::player->attach (	1133	cf::player->attach (
844	on_command => sub {	1134	on_command => sub {
845	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1144	cf::override;
855	},	1145	},
856	on_extcmd => sub {	1146	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
858		1148
859	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1150
861	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
864	$pl->ext_reply ($msg->{msgid}, %reply);
865	}
866	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
867	} else {	1166	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1168	}
870		1169
871	cf::override;	1170	cf::override;
872	},	1171	},
873	);	1172	);
874		1173
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
910	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1179	next unless -r $path;
912	eval {	1180
913	load_extension $ext;	1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
914	1	1238	}
915	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
916	}	1244	};
917	}	1245	}
918		1246
919	#############################################################################	1247	#############################################################################
920		1248
		1249	=back
		1250
921	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
922		1252
923	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
924		1254
925	=cut	1255	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
938		1268
939	=cut	1269	=cut
940		1270
941	sub playerdir($) {	1271	sub playerdir($) {
942	cf::localdir	1272	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1274	}
948		1275
949	sub path($) {	1276	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1278
952	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
953	}	1280	}
954		1281
955	sub find_active($) {	1282	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1297	my $login = $_[0];
971		1298
972	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
973		1300
974	$cf::PLAYER{$_[0]} || do {	1301	$cf::PLAYER{$_[0]} || do {
		1302	# rename old playerfiles to new ones
		1303	#TODO: remove when no longer required
		1304	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1305	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1306	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1307	aio_unlink +(playerdir $login) . "/$login.pl";
		1308
975	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
976	or return;	1310	or return;
977	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
978	}	1312	}
979	}	1313	}
…		…
991		1325
992	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
994		1328
995	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
996	Coro::cede;	1330	cf::cede_to_tick;
997	}	1331	}
998		1332
999	sub new($) {	1333	sub new($) {
1000	my ($login) = @_;	1334	my ($login) = @_;
1001		1335
…		…
1007	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1008		1342
1009	$self	1343	$self
1010	}	1344	}
1011		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
		1354	}
		1355
1012	=item $pl->quit_character	1356	=item $pl->quit_character
1013		1357
1014	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
1015	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1016		1360
1017	=cut	1361	=cut
1018		1362
1019	sub quit_character {	1363	sub quit_character {
1020	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1021		1367
1022	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1023	$pl->password ("*"); # this should lock out the player until we nuked the dir	1369	$pl->password ("*"); # this should lock out the player until we nuked the dir
1024		1370
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1380	$pl->destroy;
		1381
		1382	my $prefix = qr<^~\Q$name\E/>;
		1383
		1384	# nuke player maps
		1385	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1386
1035	IO::AIO::aio_rmtree $temp;	1387	IO::AIO::aio_rmtree $temp;
		1388	}
		1389
		1390	=item $pl->kick
		1391
		1392	Kicks a player out of the game. This destroys the connection.
		1393
		1394	=cut
		1395
		1396	sub kick {
		1397	my ($pl, $kicker) = @_;
		1398
		1399	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1400	$pl->killer ("kicked");
		1401	$pl->ns->destroy;
1036	}	1402	}
1037		1403
1038	=item cf::player::list_logins	1404	=item cf::player::list_logins
1039		1405
1040	Returns am arrayref of all valid playernames in the system, can take a	1406	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1042		1408
1043	=cut	1409	=cut
1044		1410
1045	sub list_logins {	1411	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1413	or return [];
1048		1414
1049	my @logins;	1415	my @logins;
1050		1416
1051	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1068	=cut	1434	=cut
1069		1435
1070	sub maps($) {	1436	sub maps($) {
1071	my ($pl) = @_;	1437	my ($pl) = @_;
1072		1438
		1439	$pl = ref $pl ? $pl->ob->name : $pl;
		1440
1073	my $files = aio_readdir playerdir $pl	1441	my $files = aio_readdir playerdir $pl
1074	or return;	1442	or return;
1075		1443
1076	my @paths;	1444	my @paths;
1077		1445
1078	for (@$files) {	1446	for (@$files) {
1079	utf8::decode $_;	1447	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1448	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1449	next unless /^$PATH_SEP/o;
1082		1450
1083	s/\.map$//;	1451	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1452	}
1086		1453
1087	\@paths	1454	\@paths
1088	}	1455	}
1089		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1091		1508
1092	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1093		1510
1094	=cut	1511	=cut
1095		1512
1096	sub ext_reply($$$%) {	1513	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1098		1515
1099	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1517	}
1103		1518
1104	package cf;	1519	=item $player->ext_msg ($type, @msg)
		1520
		1521	Sends an ext event to the client.
		1522
		1523	=cut
		1524
		1525	sub ext_msg($$@) {
		1526	my ($self, $type, @msg) = @_;
		1527
		1528	$self->ns->ext_msg ($type, @msg);
		1529	}
		1530
		1531	=head3 cf::region
		1532
		1533	=over 4
		1534
		1535	=cut
		1536
		1537	package cf::region;
		1538
		1539	=item cf::region::find_by_path $path
		1540
		1541	Tries to decuce the likely region for a map knowing only its path.
		1542
		1543	=cut
		1544
		1545	sub find_by_path($) {
		1546	my ($path) = @_;
		1547
		1548	my ($match, $specificity);
		1549
		1550	for my $region (list) {
		1551	if ($region->{match} && $path =~ $region->{match}) {
		1552	($match, $specificity) = ($region, $region->specificity)
		1553	if $region->specificity > $specificity;
		1554	}
		1555	}
		1556
		1557	$match
		1558	}
1105		1559
1106	=back	1560	=back
1107
1108		1561
1109	=head3 cf::map	1562	=head3 cf::map
1110		1563
1111	=over 4	1564	=over 4
1112		1565
…		…
1167	my ($self, $merge) = @_;	1620	my ($self, $merge) = @_;
1168		1621
1169	# we have to keep some variables in memory intact	1622	# we have to keep some variables in memory intact
1170	local $self->{path};	1623	local $self->{path};
1171	local $self->{load_path};	1624	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1625
1175	$self->SUPER::thawer_merge ($merge);	1626	$self->SUPER::thawer_merge ($merge);
1176	}	1627	}
1177		1628
1178	sub normalise {	1629	sub normalise {
1179	my ($path, $base) = @_;	1630	my ($path, $base) = @_;
1180		1631
1181	$path = "$path"; # make sure its a string	1632	$path = "$path"; # make sure its a string
		1633
		1634	$path =~ s/\.map$//;
1182		1635
1183	# map plan:	1636	# map plan:
1184	#	1637	#
1185	# /! non-realised random map exit (special hack!)	1638	# /! non-realised random map exit (special hack!)
1186	# {... are special paths that are not being touched	1639	# {... are special paths that are not being touched
…		…
1223	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1224	return $self;	1677	return $self;
1225	}	1678	}
1226	}	1679	}
1227		1680
1228	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1229	()	1682	()
1230	}	1683	}
1231		1684
1232	sub init {	1685	sub init {
1233	my ($self) = @_;	1686	my ($self) = @_;
…		…
1248		1701
1249	# the original (read-only) location	1702	# the original (read-only) location
1250	sub load_path {	1703	sub load_path {
1251	my ($self) = @_;	1704	my ($self) = @_;
1252		1705
1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1706	"$MAPDIR/$self->{path}.map"
1254	}	1707	}
1255		1708
1256	# the temporary/swap location	1709	# the temporary/swap location
1257	sub save_path {	1710	sub save_path {
1258	my ($self) = @_;	1711	my ($self) = @_;
1259		1712
1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1714	"$TMPDIR/$path.map"
1262	}	1715	}
1263		1716
1264	# the unique path, undef == no special unique path	1717	# the unique path, undef == no special unique path
1265	sub uniq_path {	1718	sub uniq_path {
1266	my ($self) = @_;	1719	my ($self) = @_;
1267		1720
1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1722	"$UNIQUEDIR/$path"
1270	}	1723	}
1271		1724
1272	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1273	# all maps in C++...	1726	# all maps in C++...
1274	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1276		1729
1277	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1278	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1279	}	1732	}
1280		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
1281	sub unlink_save {	1742	sub unlink_save {
1282	my ($self) = @_;	1743	my ($self) = @_;
1283		1744
1284	utf8::encode (my $save = $self->save_path);	1745	utf8::encode (my $save = $self->save_path);
1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1288		1749
1289	sub load_header_from($) {	1750	sub load_header_from($) {
1290	my ($self, $path) = @_;	1751	my ($self, $path) = @_;
1291		1752
1292	utf8::encode $path;	1753	utf8::encode $path;
1293	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
1294	or return;	1755	# or return;
1295		1756
1296	$self->_load_header ($path)	1757	$self->_load_header ($path)
1297	or return;	1758	or return;
1298		1759
1299	$self->{load_path} = $path;	1760	$self->{load_path} = $path;
…		…
1341	$self->load_header_orig	1802	$self->load_header_orig
1342	or return;	1803	or return;
1343	$self->prepare_orig;	1804	$self->prepare_orig;
1344	}	1805	}
1345		1806
		1807	$self->{deny_reset} = 1
		1808	if $self->no_reset;
		1809
		1810	$self->default_region (cf::region::find_by_path $self->{path})
		1811	unless $self->default_region;
		1812
1346	1	1813	1
1347	}	1814	}
1348		1815
1349	sub find;	1816	sub find;
1350	sub find {	1817	sub find {
…		…
1362	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1363		1830
1364	$map->load_header	1831	$map->load_header
1365	or return;	1832	or return;
1366		1833
1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368	# doing this can freeze the server in a sync job, obviously	1835	# doing this can freeze the server in a sync job, obviously
1369	#$cf::WAIT_FOR_TICK->wait;	1836	#$cf::WAIT_FOR_TICK->wait;
1370	$map->reset;	1837	$map->reset;
1371	undef $guard;	1838	undef $guard;
1372	return find $path;	1839	return find $path;
…		…
1383	my ($self) = @_;	1850	my ($self) = @_;
1384		1851
1385	local $self->{deny_reset} = 1; # loading can take a long time	1852	local $self->{deny_reset} = 1; # loading can take a long time
1386		1853
1387	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1388	my $guard = cf::lock_acquire "map_load:$path";	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1389		1859
1390	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1391		1861
1392	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1393		1863
1394	$self->alloc;	1864	$self->alloc;
1395		1865
1396	$self->pre_load;	1866	$self->pre_load;
		1867	cf::cede_to_tick;
1397		1868
1398	$self->_load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1399	or return;	1870	or return;
1400		1871
1401	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1402	if delete $self->{load_original};	1873	if delete $self->{load_original};
1403		1874
1404	if (my $uniq = $self->uniq_path) {	1875	if (my $uniq = $self->uniq_path) {
1405	utf8::encode $uniq;	1876	utf8::encode $uniq;
1406	if (aio_open $uniq, O_RDONLY, 0) {	1877	if (aio_open $uniq, O_RDONLY, 0) {
1407	$self->clear_unique_items;	1878	$self->clear_unique_items;
1408	$self->_load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1409	}	1880	}
1410	}	1881	}
1411		1882
1412	Coro::cede;	1883	cf::cede_to_tick;
1413
1414	# now do the right thing for maps	1884	# now do the right thing for maps
1415	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1416
1417	unless ($self->{deny_activate}) {
1418	$self->decay_objects;
1419	$self->fix_auto_apply;
1420	$self->update_buttons;
1421	Coro::cede;
1422	$self->set_darkness_map;
1423	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1424	unless $self->difficulty;	1887	unless $self->difficulty;
1425	Coro::cede;	1888	cf::cede_to_tick;
		1889
		1890	unless ($self->{deny_activate}) {
		1891	$self->decay_objects;
		1892	$self->fix_auto_apply;
		1893	$self->update_buttons;
		1894	cf::cede_to_tick;
		1895	$self->set_darkness_map;
		1896	cf::cede_to_tick;
1426	$self->activate;	1897	$self->activate;
		1898	}
		1899
		1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
		1902
		1903	$self->in_memory (cf::MAP_IN_MEMORY);
1427	}	1904	}
1428		1905
1429	$self->post_load;	1906	$self->post_load;
1430
1431	$self->in_memory (cf::MAP_IN_MEMORY);
1432	}	1907	}
1433		1908
1434	sub customise_for {	1909	sub customise_for {
1435	my ($self, $ob) = @_;	1910	my ($self, $ob) = @_;
1436		1911
1437	return find "~" . $ob->name . "/" . $self->{path}	1912	return find "~" . $ob->name . "/" . $self->{path}
1438	if $self->per_player;	1913	if $self->per_player;
1439		1914
		1915	# return find "?party/" . $ob->name . "/" . $self->{path}
		1916	# if $self->per_party;
		1917
1440	$self	1918	$self
1441	}	1919	}
1442		1920
1443	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1444	sub load_diag {	1922	sub load_neighbours {
1445	my ($map) = @_;	1923	my ($map) = @_;
1446		1924
1447	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1448		1926
1449	for (0 .. 3) {	1927	for (0 .. 3) {
1450	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1451	or next;	1929	or next;
1452	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1453	or next;	1931	or next;
1454	$neigh->load;	1932	$neigh->load;
1455		1933
		1934	push @neigh,
1456	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1457	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1458	}	1937	}
1459		1938
1460	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1461	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1462	or next;	1942	or next;
1463	$neigh->load;	1943	$neigh->load;
1464	}	1944	}
1465	}	1945	}
1466		1946
…		…
1471	}	1951	}
1472		1952
1473	sub do_load_sync {	1953	sub do_load_sync {
1474	my ($map) = @_;	1954	my ($map) = @_;
1475		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1476	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1477	}	1960	}
1478		1961
1479	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
1480	our $MAP_PREFETCHER = undef;	1963	our $MAP_PREFETCHER = undef;
1481		1964
1482	sub find_async {	1965	sub find_async {
1483	my ($path, $origin) = @_;	1966	my ($path, $origin, $load) = @_;
1484		1967
1485	$path = normalise $path, $origin && $origin->{path};	1968	$path = normalise $path, $origin && $origin->{path};
1486		1969
1487	if (my $map = $cf::MAP{$path}) {	1970	if (my $map = $cf::MAP{$path}) {
1488	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1489	}	1972	}
1490		1973
1491	undef $MAP_PREFETCH{$path};	1974	$MAP_PREFETCH{$path} |= $load;
		1975
1492	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1493	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1494	for my $path (keys %MAP_PREFETCH) {	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1495	my $map = find $path	1979	if (my $map = find $k) {
1496	or next;
1497	$map->load;	1980	$map->load if $v;
		1981	}
1498		1982
1499	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$k};
1500	}	1984	}
1501	}	1985	}
1502	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1503	};	1987	};
1504	$MAP_PREFETCHER->prio (6);	1988	$MAP_PREFETCHER->prio (6);
…		…
1507	}	1991	}
1508		1992
1509	sub save {	1993	sub save {
1510	my ($self) = @_;	1994	my ($self) = @_;
1511		1995
1512	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1513		1997
1514	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1515		1999
1516	return unless $self->dirty;	2000	return unless $self->dirty;
1517		2001
…		…
1540	my ($self) = @_;	2024	my ($self) = @_;
1541		2025
1542	# save first because save cedes	2026	# save first because save cedes
1543	$self->save;	2027	$self->save;
1544		2028
1545	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1546		2030
1547	return if $self->players;	2031	return if $self->players;
1548	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1549	return if $self->{deny_save};	2033	return if $self->{deny_save};
1550		2034
…		…
1554		2038
1555	sub reset_at {	2039	sub reset_at {
1556	my ($self) = @_;	2040	my ($self) = @_;
1557		2041
1558	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1559	return 1e99 if $self->isa ("ext::map_per_player");#d#
1560	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1561		2044
1562	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1563	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1564		2047
…		…
1575	my ($self) = @_;	2058	my ($self) = @_;
1576		2059
1577	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2061
1579	return if $self->players;	2062	return if $self->players;
1580	return if $self->isa ("ext::map_per_player");#d#
1581		2063
1582	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1583		2075
1584	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
1585		2077
1586	$self->in_memory (cf::MAP_SWAPPED);
1587	$self->clear;	2078	$self->clear;
1588		2079
1589	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1590		2081
1591	$self->unlink_save;	2082	$self->unlink_save;
…		…
1610	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1611		2102
1612	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1613	}	2104	}
1614		2105
		2106	=item $maps = cf::map::tmp_maps
		2107
		2108	Returns an arrayref with all map paths of currently instantiated and saved
		2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
		2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
		2123
		2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
1615	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1616		2143
1617	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1618	instantiated unique items. May block.	2145	instantiated unique items. May block.
1619		2146
1620	=cut	2147	=cut
1621		2148
1622	sub unique_maps() {	2149	sub unique_maps() {
1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2150	[
1624	or return;	2151	map {
1625
1626	my @paths;
1627
1628	for (@$files) {
1629	utf8::decode $_;	2152	utf8::decode $_;
1630	next if /\.pst$/;
1631	next unless /^$PATH_SEP/o;
1632
1633	s/\.map$//;	2153	/\.map$/
1634	push @paths, $_;	2154	? normalise $_
		2155	: ()
		2156	} @{ aio_readdir $UNIQUEDIR or [] }
1635	}	2157	]
1636
1637	\@paths
1638	}	2158	}
1639		2159
1640	package cf;	2160	package cf;
1641		2161
1642	=back	2162	=back
…		…
1688		2208
1689	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1690		2210
1691	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1692	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1693	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $dialog = $pl->{npc_dialog};
		2219	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2220
		2221	} else {
1694	$msg = $npc->name . " says: $msg" if $npc;	2222	$msg = $npc->name . " says: $msg" if $npc;
1695	$self->message ($msg, $flags);	2223	$self->message ($msg, $flags);
		2224	}
1696	}	2225	}
		2226	}
		2227
		2228	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2229
		2230	=cut
		2231
		2232	sub cf::object::send_msg {
		2233	my $pl = shift->contr
		2234	or return;
		2235	$pl->send_msg (@_);
1697	}	2236	}
1698		2237
1699	=item $player_object->may ("access")	2238	=item $player_object->may ("access")
1700		2239
1701	Returns wether the given player is authorized to access resource "access"	2240	Returns wether the given player is authorized to access resource "access"
…		…
1748	$self->deactivate_recursive;	2287	$self->deactivate_recursive;
1749		2288
1750	return if UNIVERSAL::isa $self->map, "ext::map_link";	2289	return if UNIVERSAL::isa $self->map, "ext::map_link";
1751		2290
1752	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2291	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1753	if $self->map;	2292	if $self->map && $self->map->{path} ne "{link}";
1754		2293
1755	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2294	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1756	}	2295	}
1757		2296
1758	sub cf::object::player::leave_link {	2297	sub cf::object::player::leave_link {
1759	my ($self, $map, $x, $y) = @_;	2298	my ($self, $map, $x, $y) = @_;
		2299
		2300	return unless $self->contr->active;
1760		2301
1761	my $link_pos = delete $self->{_link_pos};	2302	my $link_pos = delete $self->{_link_pos};
1762		2303
1763	unless ($map) {	2304	unless ($map) {
1764	# restore original map position	2305	# restore original map position
…		…
1778	# use -1 or undef as default coordinates, not 0, 0	2319	# use -1 or undef as default coordinates, not 0, 0
1779	($x, $y) = ($map->enter_x, $map->enter_y)	2320	($x, $y) = ($map->enter_x, $map->enter_y)
1780	if $x <=0 && $y <= 0;	2321	if $x <=0 && $y <= 0;
1781		2322
1782	$map->load;	2323	$map->load;
1783	$map->load_diag;	2324	$map->load_neighbours;
1784		2325
1785	return unless $self->contr->active;	2326	return unless $self->contr->active;
1786	$self->activate_recursive;	2327	$self->activate_recursive;
		2328
		2329	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1787	$self->enter_map ($map, $x, $y);	2330	$self->enter_map ($map, $x, $y);
1788	}	2331	}
1789		2332
1790	cf::player->attach (	2333	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1791	on_logout => sub {
1792	my ($pl) = @_;
1793		2334
1794	# abort map switching before logout	2335	Moves the player to the given map-path and coordinates by first freezing
1795	if ($pl->ob->{_link_pos}) {	2336	her, loading and preparing them map, calling the provided $check callback
1796	cf::sync_job {	2337	that has to return the map if sucecssful, and then unfreezes the player on
1797	$pl->ob->leave_link	2338	the new (success) or old (failed) map position. In either case, $done will
1798	};	2339	be called at the end of this process.
1799	}
1800	},
1801	on_login => sub {
1802	my ($pl) = @_;
1803		2340
1804	# try to abort aborted map switching on player login :)
1805	# should happen only on crashes
1806	if ($pl->ob->{_link_pos}) {
1807	$pl->ob->enter_link;
1808	(async {
1809	# we need this sleep as the login has a concurrent enter_exit running
1810	# and this sleep increases chances of the player not ending up in scorn
1811	$pl->ob->reply (undef,
1812	"There was an internal problem at your last logout, "
1813	. "the server will try to bring you to your intended destination in a second.",
1814	cf::NDI_RED);
1815	Coro::Timer::sleep 1;
1816	$pl->ob->leave_link;
1817	})->prio (2);
1818	}
1819	},
1820	);
1821
1822	=item $player_object->goto ($path, $x, $y)
1823
1824	=cut	2341	=cut
		2342
		2343	our $GOTOGEN;
1825		2344
1826	sub cf::object::player::goto {	2345	sub cf::object::player::goto {
1827	my ($self, $path, $x, $y) = @_;	2346	my ($self, $path, $x, $y, $check, $done) = @_;
		2347
		2348	# do generation counting so two concurrent goto's will be executed in-order
		2349	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1828		2350
1829	$self->enter_link;	2351	$self->enter_link;
1830		2352
1831	(async {	2353	(async {
1832	my $map = eval {	2354	my $map = eval {
1833	my $map = cf::map::find $path;	2355	my $map = cf::map::find $path;
		2356
		2357	if ($map) {
1834	$map = $map->customise_for ($self) if $map;	2358	$map = $map->customise_for ($self);
		2359	$map = $check->($map) if $check && $map;
		2360	} else {
		2361	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2362	}
		2363
1835	$map	2364	$map
		2365	};
		2366
		2367	if ($@) {
		2368	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	LOG llevError | logBacktrace, Carp::longmess $@;
1836	} or	2370	}
1837	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1838		2371
		2372	if ($gen == $self->{_goto_generation}) {
		2373	delete $self->{_goto_generation};
1839	$self->leave_link ($map, $x, $y);	2374	$self->leave_link ($map, $x, $y);
		2375	}
		2376
		2377	$done->() if $done;
1840	})->prio (1);	2378	})->prio (1);
1841	}	2379	}
1842		2380
1843	=item $player_object->enter_exit ($exit_object)	2381	=item $player_object->enter_exit ($exit_object)
1844		2382
…		…
1883		2421
1884	$rmp->{random_seed} ||= $exit->random_seed;	2422	$rmp->{random_seed} ||= $exit->random_seed;
1885		2423
1886	my $data = cf::to_json $rmp;	2424	my $data = cf::to_json $rmp;
1887	my $md5 = Digest::MD5::md5_hex $data;	2425	my $md5 = Digest::MD5::md5_hex $data;
1888	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2426	my $meta = "$RANDOMDIR/$md5.meta";
1889		2427
1890	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2428	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1891	aio_write $fh, 0, (length $data), $data, 0;	2429	aio_write $fh, 0, (length $data), $data, 0;
1892	undef $fh;	2430	undef $fh;
1893	aio_rename "$meta~", $meta;	2431	aio_rename "$meta~", $meta;
…		…
1902		2440
1903	return unless $self->type == cf::PLAYER;	2441	return unless $self->type == cf::PLAYER;
1904		2442
1905	if ($exit->slaying eq "/!") {	2443	if ($exit->slaying eq "/!") {
1906	#TODO: this should de-fi-ni-te-ly not be a sync-job	2444	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2445	# the problem is that $exit might not survive long enough
		2446	# so it needs to be done right now, right here
1907	cf::sync_job { prepare_random_map $exit };	2447	cf::sync_job { prepare_random_map $exit };
1908	}	2448	}
1909		2449
1910	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2450	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1911	my $hp = $exit->stats->hp;	2451	my $hp = $exit->stats->hp;
1912	my $sp = $exit->stats->sp;	2452	my $sp = $exit->stats->sp;
1913		2453
1914	$self->enter_link;	2454	$self->enter_link;
		2455
		2456	# if exit is damned, update players death & WoR home-position
		2457	$self->contr->savebed ($slaying, $hp, $sp)
		2458	if $exit->flag (FLAG_DAMNED);
1915		2459
1916	(async {	2460	(async {
1917	$self->deactivate_recursive; # just to be sure	2461	$self->deactivate_recursive; # just to be sure
1918	unless (eval {	2462	unless (eval {
1919	$self->goto ($slaying, $hp, $sp);	2463	$self->goto ($slaying, $hp, $sp);
1920		2464
1921	1;	2465	1;
1922	}) {	2466	}) {
1923	$self->message ("Something went wrong deep within the crossfire server. "	2467	$self->message ("Something went wrong deep within the crossfire server. "
1924	. "I'll try to bring you back to the map you were before. "	2468	. "I'll try to bring you back to the map you were before. "
1925	. "Please report this to the dungeon master!",	2469	. "Please report this to the dungeon master!",
1926	cf::NDI_UNIQUE | cf::NDI_RED);	2470	cf::NDI_UNIQUE | cf::NDI_RED);
1927		2471
1928	warn "ERROR in enter_exit: $@";	2472	warn "ERROR in enter_exit: $@";
1929	$self->leave_link;	2473	$self->leave_link;
1930	}	2474	}
1931	})->prio (1);	2475	})->prio (1);
…		…
1944		2488
1945	sub cf::client::send_drawinfo {	2489	sub cf::client::send_drawinfo {
1946	my ($self, $text, $flags) = @_;	2490	my ($self, $text, $flags) = @_;
1947		2491
1948	utf8::encode $text;	2492	utf8::encode $text;
1949	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2493	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1950	}	2494	}
1951		2495
		2496	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2497
		2498	Send a drawinfo or msg packet to the client, formatting the msg for the
		2499	client if neccessary. C<$type> should be a string identifying the type of
		2500	the message, with C<log> being the default. If C<$color> is negative, suppress
		2501	the message unless the client supports the msg packet.
		2502
		2503	=cut
		2504
		2505	sub cf::client::send_msg {
		2506	my ($self, $channel, $msg, $color, @extra) = @_;
		2507
		2508	$msg = $self->pl->expand_cfpod ($msg);
		2509
		2510	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2511
		2512	if (ref $channel) {
		2513	# send meta info to client, if not yet sent
		2514	unless (exists $self->{channel}{$channel->{id}}) {
		2515	$self->{channel}{$channel->{id}} = $channel;
		2516	$self->ext_msg (channel_info => $channel);
		2517	}
		2518
		2519	$channel = $channel->{id};
		2520	}
		2521
		2522	return unless @extra || length $msg;
		2523
		2524	if ($self->can_msg) {
		2525	# default colour, mask it out
		2526	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2527	if $color & cf::NDI_DEF;
		2528
		2529	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2530	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2531	} else {
		2532	if ($color >= 0) {
		2533	# replace some tags by gcfclient-compatible ones
		2534	for ($msg) {
		2535	1 while
		2536	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2537	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2538	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2539	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2540	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2541	}
		2542
		2543	$color &= cf::NDI_COLOR_MASK;
		2544
		2545	utf8::encode $msg;
		2546
		2547	if (0 && $msg =~ /\[/) {
		2548	# COMMAND/INFO
		2549	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2550	} else {
		2551	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2552	$self->send_packet ("drawinfo $color $msg")
		2553	}
		2554	}
		2555	}
		2556	}
		2557
		2558	=item $client->ext_msg ($type, @msg)
		2559
		2560	Sends an ext event to the client.
		2561
		2562	=cut
		2563
		2564	sub cf::client::ext_msg($$@) {
		2565	my ($self, $type, @msg) = @_;
		2566
		2567	if ($self->extcmd == 2) {
		2568	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2569	} elsif ($self->extcmd == 1) { # TODO: remove
		2570	push @msg, msgtype => "event_$type";
		2571	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2572	}
		2573	}
		2574
		2575	=item $client->ext_reply ($msgid, @msg)
		2576
		2577	Sends an ext reply to the client.
		2578
		2579	=cut
		2580
		2581	sub cf::client::ext_reply($$@) {
		2582	my ($self, $id, @msg) = @_;
		2583
		2584	if ($self->extcmd == 2) {
		2585	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2586	} elsif ($self->extcmd == 1) {
		2587	#TODO: version 1, remove
		2588	unshift @msg, msgtype => "reply", msgid => $id;
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2590	}
		2591	}
1952		2592
1953	=item $success = $client->query ($flags, "text", \&cb)	2593	=item $success = $client->query ($flags, "text", \&cb)
1954		2594
1955	Queues a query to the client, calling the given callback with	2595	Queues a query to the client, calling the given callback with
1956	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2596	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1957	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2597	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1958		2598
1959	Queries can fail, so check the return code. Or don't, as queries will become	2599	Queries can fail, so check the return code. Or don't, as queries will
1960	reliable at some point in the future.	2600	become reliable at some point in the future.
1961		2601
1962	=cut	2602	=cut
1963		2603
1964	sub cf::client::query {	2604	sub cf::client::query {
1965	my ($self, $flags, $text, $cb) = @_;	2605	my ($self, $flags, $text, $cb) = @_;
…		…
1973	utf8::encode $text;	2613	utf8::encode $text;
1974	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2614	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1975		2615
1976	$self->send_packet ($self->{query_queue}[0][0])	2616	$self->send_packet ($self->{query_queue}[0][0])
1977	if @{ $self->{query_queue} } == 1;	2617	if @{ $self->{query_queue} } == 1;
		2618
		2619	1
1978	}	2620	}
1979		2621
1980	cf::client->attach (	2622	cf::client->attach (
		2623	on_connect => sub {
		2624	my ($ns) = @_;
		2625
		2626	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2627	},
1981	on_reply => sub {	2628	on_reply => sub {
1982	my ($ns, $msg) = @_;	2629	my ($ns, $msg) = @_;
1983		2630
1984	# this weird shuffling is so that direct followup queries	2631	# this weird shuffling is so that direct followup queries
1985	# get handled first	2632	# get handled first
1986	my $queue = delete $ns->{query_queue}	2633	my $queue = delete $ns->{query_queue}
1987	or return; # be conservative, not sure how that can happen, but we saw a crash here	2634	or return; # be conservative, not sure how that can happen, but we saw a crash here
1988		2635
1989	(shift @$queue)->[1]->($msg);	2636	(shift @$queue)->[1]->($msg);
		2637	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1990		2638
1991	push @{ $ns->{query_queue} }, @$queue;	2639	push @{ $ns->{query_queue} }, @$queue;
1992		2640
1993	if (@{ $ns->{query_queue} } == @$queue) {	2641	if (@{ $ns->{query_queue} } == @$queue) {
1994	if (@$queue) {	2642	if (@$queue) {
…		…
1996	} else {	2644	} else {
1997	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2645	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1998	}	2646	}
1999	}	2647	}
2000	},	2648	},
		2649	on_exticmd => sub {
		2650	my ($ns, $buf) = @_;
		2651
		2652	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2653
		2654	if (ref $msg) {
		2655	my ($type, $reply, @payload) =
		2656	"ARRAY" eq ref $msg
		2657	? @$msg
		2658	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2659
		2660	my @reply;
		2661
		2662	if (my $cb = $EXTICMD{$type}) {
		2663	@reply = $cb->($ns, @payload);
		2664	}
		2665
		2666	$ns->ext_reply ($reply, @reply)
		2667	if $reply;
		2668
		2669	} else {
		2670	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2671	}
		2672
		2673	cf::override;
		2674	},
2001	);	2675	);
2002		2676
2003	=item $client->async (\&cb)	2677	=item $client->async (\&cb)
2004		2678
2005	Create a new coroutine, running the specified callback. The coroutine will	2679	Create a new coroutine, running the specified callback. The coroutine will
…		…
2046	our $safe = new Safe "safe";	2720	our $safe = new Safe "safe";
2047	our $safe_hole = new Safe::Hole;	2721	our $safe_hole = new Safe::Hole;
2048		2722
2049	$SIG{FPE} = 'IGNORE';	2723	$SIG{FPE} = 'IGNORE';
2050		2724
2051	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2725	$safe->permit_only (Opcode::opset qw(
		2726	:base_core :base_mem :base_orig :base_math
		2727	grepstart grepwhile mapstart mapwhile
		2728	sort time
		2729	));
2052		2730
2053	# here we export the classes and methods available to script code	2731	# here we export the classes and methods available to script code
2054		2732
2055	=pod	2733	=pod
2056		2734
2057	The following fucntions and emthods are available within a safe environment:	2735	The following functions and methods are available within a safe environment:
2058		2736
2059	cf::object contr pay_amount pay_player map	2737	cf::object
		2738	contr pay_amount pay_player map x y force_find force_add
		2739	insert remove name archname title slaying race decrease_ob_nr
		2740
2060	cf::object::player player	2741	cf::object::player
2061	cf::player peaceful	2742	player
2062	cf::map trigger	2743
		2744	cf::player
		2745	peaceful
		2746
		2747	cf::map
		2748	trigger
2063		2749
2064	=cut	2750	=cut
2065		2751
2066	for (	2752	for (
2067	["cf::object" => qw(contr pay_amount pay_player map)],	2753	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2754	insert remove inv name archname title slaying race
		2755	decrease_ob_nr)],
2068	["cf::object::player" => qw(player)],	2756	["cf::object::player" => qw(player)],
2069	["cf::player" => qw(peaceful)],	2757	["cf::player" => qw(peaceful)],
2070	["cf::map" => qw(trigger)],	2758	["cf::map" => qw(trigger)],
2071	) {	2759	) {
2072	no strict 'refs';	2760	no strict 'refs';
…		…
2143	=back	2831	=back
2144		2832
2145	=cut	2833	=cut
2146		2834
2147	#############################################################################	2835	#############################################################################
		2836	# the server's init and main functions
2148		2837
2149	=head2 EXTENSION DATABASE SUPPORT	2838	sub load_facedata($) {
		2839	my ($path) = @_;
2150		2840
2151	Crossfire maintains a very simple database for extension use. It can	2841	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2152	currently store anything that can be serialised using Storable, which
2153	excludes objects.
2154		2842
2155	The parameter C<$family> should best start with the name of the extension	2843	warn "loading facedata from $path\n";
2156	using it, it should be unique.
2157		2844
2158	=over 4	2845	my $facedata;
		2846	0 < aio_load $path, $facedata
		2847	or die "$path: $!";
2159		2848
2160	=item $hashref = cf::db_get $family	2849	$facedata = Coro::Storable::thaw $facedata;
2161		2850
2162	Return a hashref for use by the extension C<$family>, which can be	2851	$facedata->{version} == 2
2163	modified. After modifications, you have to call C<cf::db_dirty> or	2852	or cf::cleanup "$path: version mismatch, cannot proceed.";
2164	C<cf::db_sync>.
2165		2853
2166	=item $value = cf::db_get $family => $key	2854	# patch in the exptable
2167		2855	$facedata->{resource}{"res/exp_table"} = {
2168	Returns a single value from the database	2856	type => FT_RSRC,
2169		2857	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2170	=item cf::db_put $family => $hashref
2171
2172	Stores the given family hashref into the database. Updates are delayed, if
2173	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2174
2175	=item cf::db_put $family => $key => $value
2176
2177	Stores the given C<$value> in the family hash. Updates are delayed, if you
2178	want the data to be synced to disk immediately, use C<cf::db_sync>.
2179
2180	=item cf::db_dirty
2181
2182	Marks the database as dirty, to be updated at a later time.
2183
2184	=item cf::db_sync
2185
2186	Immediately write the database to disk I<if it is dirty>.
2187
2188	=cut
2189
2190	our $DB;
2191
2192	{
2193	my $path = cf::localdir . "/database.pst";
2194
2195	sub db_load() {
2196	$DB = stat $path ? Storable::retrieve $path : { };
2197	}	2858	};
		2859	cf::cede_to_tick;
2198		2860
2199	my $pid;
2200
2201	sub db_save() {
2202	waitpid $pid, 0 if $pid;
2203	if (0 == ($pid = fork)) {
2204	$DB->{_meta}{version} = 1;
2205	Storable::nstore $DB, "$path~";
2206	rename "$path~", $path;
2207	cf::_exit 0 if defined $pid;
2208	}
2209	}	2861	{
		2862	my $faces = $facedata->{faceinfo};
2210		2863
2211	my $dirty;	2864	while (my ($face, $info) = each %$faces) {
		2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
		2868	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2869	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2212		2870
2213	sub db_sync() {	2871	cf::cede_to_tick;
2214	db_save if $dirty;
2215	undef $dirty;
2216	}
2217
2218	my $idle = Event->idle (
2219	reentrant => 0,
2220	min => 10,
2221	max => 20,
2222	repeat => 0,
2223	data => WF_AUTOCANCEL,
2224	cb => \&db_sync,
2225	);
2226
2227	sub db_dirty() {
2228	$dirty = 1;
2229	$idle->start;
2230	}
2231
2232	sub db_get($;$) {
2233	@_ >= 2
2234	? $DB->{$_[0]}{$_[1]}
2235	: ($DB->{$_[0]} ||= { })
2236	}
2237
2238	sub db_put($$;$) {
2239	if (@_ >= 3) {
2240	$DB->{$_[0]}{$_[1]} = $_[2];
2241	} else {
2242	$DB->{$_[0]} = $_[1];
2243	}
2244	db_dirty;
2245	}
2246
2247	cf::global->attach (
2248	prio => 10000,
2249	on_cleanup => sub {
2250	db_sync;
2251	},	2872	}
2252	);
2253	}
2254		2873
2255	#############################################################################	2874	while (my ($face, $info) = each %$faces) {
2256	# the server's main()	2875	next unless $info->{smooth};
		2876	my $idx = cf::face::find $face
		2877	or next;
		2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
		2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2881	} else {
		2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2883	}
2257		2884
2258	sub cfg_load {	2885	cf::cede_to_tick;
		2886	}
		2887	}
		2888
		2889	{
		2890	my $anims = $facedata->{animinfo};
		2891
		2892	while (my ($anim, $info) = each %$anims) {
		2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2894	cf::cede_to_tick;
		2895	}
		2896
		2897	cf::anim::invalidate_all; # d'oh
		2898	}
		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904
		2905	my $soundconf = delete $res->{"res/sound.conf"};
		2906
		2907	while (my ($name, $info) = each %$res) {
		2908	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2909	my $data;
		2910
		2911	if ($info->{type} & 1) {
		2912	# prepend meta info
		2913
		2914	my $meta = $enc->encode ({
		2915	name => $name,
		2916	%{ $info->{meta} || {} },
		2917	});
		2918
		2919	$data = pack "(w/a*)*", $meta, $info->{data};
		2920	} else {
		2921	$data = $info->{data};
		2922	}
		2923
		2924	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2925	cf::face::set_type $idx, $info->{type};
		2926
		2927	cf::cede_to_tick;
		2928	}
		2929
		2930	if ($soundconf) {
		2931	$soundconf = $enc->decode (delete $soundconf->{data});
		2932
		2933	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2934	my $sound = $soundconf->{compat}[$_]
		2935	or next;
		2936
		2937	my $face = cf::face::find "sound/$sound->[1]";
		2938	cf::sound::set $sound->[0] => $face;
		2939	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2940	}
		2941
		2942	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2943	my $face = cf::face::find "sound/$v";
		2944	cf::sound::set $k => $face;
		2945	}
		2946	}
		2947	}
		2948
		2949	1
		2950	}
		2951
		2952	register_exticmd fx_want => sub {
		2953	my ($ns, $want) = @_;
		2954
		2955	while (my ($k, $v) = each %$want) {
		2956	$ns->fx_want ($k, $v);
		2957	}
		2958	};
		2959
		2960	sub reload_regions {
		2961	load_resource_file "$MAPDIR/regions"
		2962	or die "unable to load regions file\n";
		2963
		2964	for (cf::region::list) {
		2965	$_->{match} = qr/$_->{match}/
		2966	if exists $_->{match};
		2967	}
		2968	}
		2969
		2970	sub reload_facedata {
		2971	load_facedata "$DATADIR/facedata"
		2972	or die "unable to load facedata\n";
		2973	}
		2974
		2975	sub reload_archetypes {
		2976	load_resource_file "$DATADIR/archetypes"
		2977	or die "unable to load archetypes\n";
		2978	#d# NEED to laod twice to resolve forward references
		2979	# this really needs to be done in an extra post-pass
		2980	# (which needs to be synchronous, so solve it differently)
		2981	load_resource_file "$DATADIR/archetypes"
		2982	or die "unable to load archetypes\n";
		2983	}
		2984
		2985	sub reload_treasures {
		2986	load_resource_file "$DATADIR/treasures"
		2987	or die "unable to load treasurelists\n";
		2988	}
		2989
		2990	sub reload_resources {
		2991	warn "reloading resource files...\n";
		2992
		2993	reload_regions;
		2994	reload_facedata;
		2995	#reload_archetypes;#d#
		2996	reload_archetypes;
		2997	reload_treasures;
		2998
		2999	warn "finished reloading resource files\n";
		3000	}
		3001
		3002	sub init {
		3003	reload_resources;
		3004	}
		3005
		3006	sub reload_config {
2259	open my $fh, "<:utf8", cf::confdir . "/config"	3007	open my $fh, "<:utf8", "$CONFDIR/config"
2260	or return;	3008	or return;
2261		3009
2262	local $/;	3010	local $/;
2263	*CFG = YAML::Syck::Load <$fh>;	3011	*CFG = YAML::Syck::Load <$fh>;
2264		3012
…		…
2283	(async {	3031	(async {
2284	Event::one_event;	3032	Event::one_event;
2285	})->prio (Coro::PRIO_MAX);	3033	})->prio (Coro::PRIO_MAX);
2286	};	3034	};
2287		3035
2288	cfg_load;	3036	reload_config;
2289	db_load;	3037	db_init;
2290	load_extensions;	3038	load_extensions;
2291		3039
2292	$TICK_WATCHER->start;	3040	$TICK_WATCHER->start;
2293	Event::loop;	3041	Event::loop;
2294	}	3042	}
…		…
2309	},	3057	},
2310	);	3058	);
2311	}	3059	}
2312	}	3060	}
2313		3061
		3062	sub write_runtime {
		3063	my $runtime = "$LOCALDIR/runtime";
		3064
		3065	# first touch the runtime file to show we are still running:
		3066	# the fsync below can take a very very long time.
		3067
		3068	IO::AIO::aio_utime $runtime, undef, undef;
		3069
		3070	my $guard = cf::lock_acquire "write_runtime";
		3071
		3072	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3073	or return;
		3074
		3075	my $value = $cf::RUNTIME + 90 + 10;
		3076	# 10 is the runtime save interval, for a monotonic clock
		3077	# 60 allows for the watchdog to kill the server.
		3078
		3079	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3080	and return;
		3081
		3082	# always fsync - this file is important
		3083	aio_fsync $fh
		3084	and return;
		3085
		3086	# touch it again to show we are up-to-date
		3087	aio_utime $fh, undef, undef;
		3088
		3089	close $fh
		3090	or return;
		3091
		3092	aio_rename "$runtime~", $runtime
		3093	and return;
		3094
		3095	warn "runtime file written.\n";
		3096
		3097	1
		3098	}
		3099
2314	sub emergency_save() {	3100	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	3101	my $freeze_guard = cf::freeze_mainloop;
2316		3102
2317	warn "enter emergency perl save\n";	3103	warn "enter emergency perl save\n";
2318		3104
…		…
2333	my $map = $cf::MAP{$path} or next;	3119	my $map = $cf::MAP{$path} or next;
2334	$map->valid or next;	3120	$map->valid or next;
2335	$map->save;	3121	$map->save;
2336	}	3122	}
2337	warn "end emergency map save\n";	3123	warn "end emergency map save\n";
		3124
		3125	warn "begin emergency database checkpoint\n";
		3126	BDB::db_env_txn_checkpoint $DB_ENV;
		3127	warn "end emergency database checkpoint\n";
2338	};	3128	};
2339		3129
2340	warn "leave emergency perl save\n";	3130	warn "leave emergency perl save\n";
2341	}	3131	}
2342		3132
		3133	sub post_cleanup {
		3134	my ($make_core) = @_;
		3135
		3136	warn Carp::longmess "post_cleanup backtrace"
		3137	if $make_core;
		3138	}
		3139
2343	sub reload() {	3140	sub do_reload_perl() {
2344	# can/must only be called in main	3141	# can/must only be called in main
2345	if ($Coro::current != $Coro::main) {	3142	if ($Coro::current != $Coro::main) {
2346	warn "can only reload from main coroutine";	3143	warn "can only reload from main coroutine";
2347	return;	3144	return;
2348	}	3145	}
2349		3146
2350	warn "reloading...";	3147	warn "reloading...";
2351		3148
2352	warn "cancelling server ticker";	3149	warn "entering sync_job";
2353	$TICK_WATCHER->cancel;
2354		3150
		3151	cf::sync_job {
		3152	cf::write_runtime; # external watchdog should not bark
2355	cf::emergency_save;	3153	cf::emergency_save;
		3154	cf::write_runtime; # external watchdog should not bark
2356		3155
2357	eval {	3156	warn "syncing database to disk";
		3157	BDB::db_env_txn_checkpoint $DB_ENV;
		3158
2358	# if anything goes wrong in here, we should simply crash as we already saved	3159	# if anything goes wrong in here, we should simply crash as we already saved
2359
2360	warn "syncing database to disk";
2361	cf::db_sync;
2362		3160
2363	warn "cancelling all WF_AUTOCANCEL watchers";	3161	warn "cancelling all WF_AUTOCANCEL watchers";
2364	for (Event::all_watchers) {	3162	for (Event::all_watchers) {
2365	$_->cancel if $_->data & WF_AUTOCANCEL;	3163	$_->cancel if $_->data & WF_AUTOCANCEL;
2366	}	3164	}
2367		3165
2368	warn "flushing outstanding aio requests";	3166	warn "flushing outstanding aio requests";
2369	for (;;) {	3167	for (;;) {
		3168	BDB::flush;
2370	IO::AIO::flush;	3169	IO::AIO::flush;
2371	Coro::cede;	3170	Coro::cede;
2372	last unless IO::AIO::nreqs;	3171	last unless IO::AIO::nreqs || BDB::nreqs;
2373	warn "iterate...";	3172	warn "iterate...";
2374	}	3173	}
		3174
		3175	++$RELOAD;
2375		3176
2376	warn "cancelling all extension coros";	3177	warn "cancelling all extension coros";
2377	$_->cancel for values %EXT_CORO;	3178	$_->cancel for values %EXT_CORO;
2378	%EXT_CORO = ();	3179	%EXT_CORO = ();
2379		3180
2380	warn "removing commands";	3181	warn "removing commands";
2381	%COMMAND = ();	3182	%COMMAND = ();
2382		3183
2383	warn "removing ext commands";	3184	warn "removing ext/exti commands";
2384	%EXTCMD = ();	3185	%EXTCMD = ();
		3186	%EXTICMD = ();
2385		3187
2386	warn "unloading/nuking all extensions";	3188	warn "unloading/nuking all extensions";
2387	for my $pkg (@EXTS) {	3189	for my $pkg (@EXTS) {
2388	warn "... unloading $pkg";	3190	warn "... unloading $pkg";
2389		3191
…		…
2419	Symbol::delete_package "safe::$_"	3221	Symbol::delete_package "safe::$_"
2420	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3222	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2421		3223
2422	warn "unloading cf.pm \"a bit\"";	3224	warn "unloading cf.pm \"a bit\"";
2423	delete $INC{"cf.pm"};	3225	delete $INC{"cf.pm"};
		3226	delete $INC{"cf/pod.pm"};
2424		3227
2425	# don't, removes xs symbols, too,	3228	# don't, removes xs symbols, too,
2426	# and global variables created in xs	3229	# and global variables created in xs
2427	#Symbol::delete_package __PACKAGE__;	3230	#Symbol::delete_package __PACKAGE__;
2428		3231
…		…
2431	warn "reloading cf.pm";	3234	warn "reloading cf.pm";
2432	require cf;	3235	require cf;
2433	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3236	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2434		3237
2435	warn "loading config and database again";	3238	warn "loading config and database again";
2436	cf::cfg_load;	3239	cf::reload_config;
2437	cf::db_load;
2438		3240
2439	warn "loading extensions";	3241	warn "loading extensions";
2440	cf::load_extensions;	3242	cf::load_extensions;
2441		3243
2442	warn "reattaching attachments to objects/players";	3244	warn "reattaching attachments to objects/players";
2443	_global_reattach;	3245	_global_reattach; # objects, sockets
2444	warn "reattaching attachments to maps";	3246	warn "reattaching attachments to maps";
2445	reattach $_ for values %MAP;	3247	reattach $_ for values %MAP;
		3248	warn "reattaching attachments to players";
		3249	reattach $_ for values %PLAYER;
2446		3250
2447	warn "restarting server ticker";	3251	warn "leaving sync_job";
2448		3252
2449	$TICK_WATCHER->start;	3253	1
2450	};	3254	} or do {
2451
2452	if ($@) {
2453	warn $@;	3255	warn $@;
2454	warn "error while reloading, exiting.";	3256	warn "error while reloading, exiting.";
2455	exit 1;	3257	exit 1;
2456	}	3258	};
2457		3259
2458	warn "reloaded";	3260	warn "reloaded";
2459	};	3261	};
2460		3262
2461	our $RELOAD_WATCHER; # used only during reload	3263	our $RELOAD_WATCHER; # used only during reload
2462		3264
		3265	sub reload_perl() {
		3266	# doing reload synchronously and two reloads happen back-to-back,
		3267	# coro crashes during coro_state_free->destroy here.
		3268
		3269	$RELOAD_WATCHER ||= Event->timer (
		3270	reentrant => 0,
		3271	after => 0,
		3272	data => WF_AUTOCANCEL,
		3273	cb => sub {
		3274	do_reload_perl;
		3275	undef $RELOAD_WATCHER;
		3276	},
		3277	);
		3278	}
		3279
2463	register_command "reload" => sub {	3280	register_command "reload" => sub {
2464	my ($who, $arg) = @_;	3281	my ($who, $arg) = @_;
2465		3282
2466	if ($who->flag (FLAG_WIZ)) {	3283	if ($who->flag (FLAG_WIZ)) {
2467	$who->message ("reloading server.");	3284	$who->message ("reloading server.");
2468		3285	async { reload_perl };
2469	# doing reload synchronously and two reloads happen back-to-back,
2470	# coro crashes during coro_state_free->destroy here.
2471
2472	$RELOAD_WATCHER ||= Event->timer (
2473	reentrant => 0,
2474	after => 0,
2475	data => WF_AUTOCANCEL,
2476	cb => sub {
2477	reload;
2478	undef $RELOAD_WATCHER;
2479	},
2480	);
2481	}	3286	}
2482	};	3287	};
2483		3288
2484	unshift @INC, $LIBDIR;	3289	unshift @INC, $LIBDIR;
2485		3290
2486	my $bug_warning = 0;	3291	my $bug_warning = 0;
2487		3292
		3293	our @WAIT_FOR_TICK;
		3294	our @WAIT_FOR_TICK_BEGIN;
		3295
		3296	sub wait_for_tick {
		3297	return unless $TICK_WATCHER->is_active;
		3298	return if $Coro::current == $Coro::main;
		3299
		3300	my $signal = new Coro::Signal;
		3301	push @WAIT_FOR_TICK, $signal;
		3302	$signal->wait;
		3303	}
		3304
		3305	sub wait_for_tick_begin {
		3306	return unless $TICK_WATCHER->is_active;
		3307	return if $Coro::current == $Coro::main;
		3308
		3309	my $signal = new Coro::Signal;
		3310	push @WAIT_FOR_TICK_BEGIN, $signal;
		3311	$signal->wait;
		3312	}
		3313
		3314	my $min = 1e6;#d#
		3315	my $avg = 10;
2488	$TICK_WATCHER = Event->timer (	3316	$TICK_WATCHER = Event->timer (
2489	reentrant => 0,	3317	reentrant => 0,
2490	parked => 1,	3318	parked => 1,
2491	prio => 0,	3319	prio => 0,
2492	at => $NEXT_TICK || $TICK,	3320	at => $NEXT_TICK || $TICK,
…		…
2496	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3324	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2497	unless ++$bug_warning > 10;	3325	unless ++$bug_warning > 10;
2498	return;	3326	return;
2499	}	3327	}
2500		3328
2501	$NOW = Event::time;	3329	$NOW = $tick_start = Event::time;
2502		3330
2503	cf::server_tick; # one server iteration	3331	cf::server_tick; # one server iteration
		3332
		3333	0 && sync_job {#d#
		3334	for(1..10) {
		3335	my $t = Event::time;
		3336	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3337	or die;
		3338
		3339	$map->width (50);
		3340	$map->height (50);
		3341	$map->alloc;
		3342	$map->_load_objects ("/tmp/x.map", 1);
		3343	my $t = Event::time - $t;
		3344
		3345	#next unless $t < 0.0013;#d#
		3346	if ($t < $min) {
		3347	$min = $t;
		3348	}
		3349	$avg = $avg * 0.99 + $t * 0.01;
		3350	}
		3351	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3352	exit 0;
		3353	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3354	};
		3355
2504	$RUNTIME += $TICK;	3356	$RUNTIME += $TICK;
2505	$NEXT_TICK += $TICK;	3357	$NEXT_TICK += $TICK;
2506		3358
2507	$WAIT_FOR_TICK->broadcast;	3359	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2508	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3360	$NEXT_RUNTIME_WRITE = $NOW + 10;
2509		3361	Coro::async_pool {
2510	Event::sweep;	3362	write_runtime
2511	Coro::cede_notself;	3363	or warn "ERROR: unable to write runtime file: $!";
		3364	};
2512		3365	}
		3366
2513	# my $AFTER = Event::time;	3367	# my $AFTER = Event::time;
2514	# warn $AFTER - $NOW;#d#	3368	# warn $AFTER - $NOW;#d#
2515		3369
		3370	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3371	$sig->send;
		3372	}
		3373	while (my $sig = shift @WAIT_FOR_TICK) {
		3374	$sig->send;
		3375	}
		3376
		3377	$NOW = Event::time;
		3378
2516	# if we are delayed by four ticks or more, skip them all	3379	# if we are delayed by four ticks or more, skip them all
2517	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3380	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2518		3381
2519	$TICK_WATCHER->at ($NEXT_TICK);	3382	$TICK_WATCHER->at ($NEXT_TICK);
2520	$TICK_WATCHER->start;	3383	$TICK_WATCHER->start;
		3384
		3385	$LOAD = ($NOW - $tick_start) / $TICK;
		3386	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3387
		3388	_post_tick;
		3389
		3390
2521	},	3391	},
2522	);	3392	);
2523		3393
		3394	{
		3395	BDB::max_poll_time $TICK * 0.1;
		3396	$BDB_POLL_WATCHER = Event->io (
		3397	reentrant => 0,
		3398	fd => BDB::poll_fileno,
		3399	poll => 'r',
		3400	prio => 0,
		3401	data => WF_AUTOCANCEL,
		3402	cb => \&BDB::poll_cb,
		3403	);
		3404	BDB::min_parallel 8;
		3405
		3406	BDB::set_sync_prepare {
		3407	my $status;
		3408	my $current = $Coro::current;
		3409	(
		3410	sub {
		3411	$status = $!;
		3412	$current->ready; undef $current;
		3413	},
		3414	sub {
		3415	Coro::schedule while defined $current;
		3416	$! = $status;
		3417	},
		3418	)
		3419	};
		3420
		3421	unless ($DB_ENV) {
		3422	$DB_ENV = BDB::db_env_create;
		3423
		3424	cf::sync_job {
		3425	eval {
		3426	BDB::db_env_open
		3427	$DB_ENV,
		3428	$BDBDIR,
		3429	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3430	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3431	0666;
		3432
		3433	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3434
		3435	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3436	$DB_ENV->set_lk_detect;
		3437	};
		3438
		3439	cf::cleanup "db_env_open(db): $@" if $@;
		3440	};
		3441	}
		3442	}
		3443
		3444	{
		3445	IO::AIO::min_parallel 8;
		3446
		3447	undef $Coro::AIO::WATCHER;
2524	IO::AIO::max_poll_time $TICK * 0.1;	3448	IO::AIO::max_poll_time $TICK * 0.1;
2525
2526	undef $Coro::AIO::WATCHER;
2527	$AIO_POLL_WATCHER = Event->io (	3449	$AIO_POLL_WATCHER = Event->io (
2528	reentrant => 0,	3450	reentrant => 0,
		3451	data => WF_AUTOCANCEL,
2529	fd => IO::AIO::poll_fileno,	3452	fd => IO::AIO::poll_fileno,
2530	poll => 'r',	3453	poll => 'r',
2531	prio => 6,	3454	prio => 6,
2532	data => WF_AUTOCANCEL,
2533	cb => \&IO::AIO::poll_cb,	3455	cb => \&IO::AIO::poll_cb,
2534	);	3456	);
		3457	}
2535		3458
2536	$WRITE_RUNTIME_WATCHER = Event->timer (	3459	my $_log_backtrace;
2537	reentrant => 0,	3460
2538	data => WF_AUTOCANCEL,	3461	sub _log_backtrace {
2539	after => 1,	3462	my ($msg, @addr) = @_;
2540	interval => 10,	3463
2541	prio => 6, # keep it lowest so it acts like a watchdog	3464	$msg =~ s/\n//;
2542	cb => Coro::unblock_sub {	3465
2543	write_runtime	3466	# limit the # of concurrent backtraces
2544	or warn "ERROR: unable to write runtime file: $!";	3467	if ($_log_backtrace < 2) {
		3468	++$_log_backtrace;
		3469	async {
		3470	my @bt = fork_call {
		3471	@addr = map { sprintf "%x", $_ } @addr;
		3472	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3473	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3474	or die "addr2line: $!";
		3475
		3476	my @funcs;
		3477	my @res = <$fh>;
		3478	chomp for @res;
		3479	while (@res) {
		3480	my ($func, $line) = splice @res, 0, 2, ();
		3481	push @funcs, "[$func] $line";
		3482	}
		3483
		3484	@funcs
		3485	};
		3486
		3487	LOG llevInfo, "[ABT] $msg\n";
		3488	LOG llevInfo, "[ABT] $_\n" for @bt;
		3489	--$_log_backtrace;
		3490	};
		3491	} else {
		3492	LOG llevInfo, "[ABT] $msg\n";
		3493	LOG llevInfo, "[ABT] [suppressed]\n";
2545	},	3494	}
2546	);	3495	}
		3496
		3497	# load additional modules
		3498	use cf::pod;
2547		3499
2548	END { cf::emergency_save }	3500	END { cf::emergency_save }
2549		3501
2550	1	3502	1
2551		3503

Diff Legend

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