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.153 by root, Mon Jan 8 23:36:16 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 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.3 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use JSON::XS 1.4 ();
		26	use BDB ();
		27	use Data::Dumper;
20	use Digest::MD5;	28	use Digest::MD5;
21	use Fcntl;	29	use Fcntl;
		30	use YAML::Syck ();
22	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
23	use YAML::Syck ();
24	use Time::HiRes;	32	use Time::HiRes;
		33	use Compress::LZF;
		34	use Digest::MD5 ();
25		35
		36	# configure various modules to our taste
		37	#
		38	$Storable::canonical = 1; # reduce rsync transfers
		39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		40	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		41
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	42	$Event::Eval = 1; # no idea why this is required, but it is
27		43
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
30		46
31	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		48
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		50
35	our %COMMAND = ();	51	our %COMMAND = ();
36	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
		53
		54	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
		57	our %EXT_CORO = (); # coroutines bound to extensions
		58	our %EXT_MAP = (); # pluggable maps
38		59
		60	our $RELOAD; # number of reloads so far
39	our @EVENT;	61	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		62
42	our $TICK = MAX_TIME * 1e-6;	63	our $CONFDIR = confdir;
		64	our $DATADIR = datadir;
		65	our $LIBDIR = "$DATADIR/ext";
		66	our $PODDIR = "$DATADIR/pod";
		67	our $MAPDIR = "$DATADIR/" . mapdir;
		68	our $LOCALDIR = localdir;
		69	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		70	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		71	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		72	our $RANDOMDIR = "$LOCALDIR/random";
		73	our $BDBDIR = "$LOCALDIR/db";
		74
		75	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	76	our $TICK_WATCHER;
		77	our $AIO_POLL_WATCHER;
		78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	79	our $NEXT_TICK;
45	our $NOW;	80	our $NOW;
		81	our $USE_FSYNC = 1; # use fsync to write maps - default off
		82
		83	our $BDB_POLL_WATCHER;
		84	our $DB_ENV;
46		85
47	our %CFG;	86	our %CFG;
48		87
49	our $UPTIME; $UPTIME ||= time;	88	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	89	our $RUNTIME;
51		90
52	our %PLAYER; # all users	91	our %PLAYER; # all users
53	our %MAP; # all maps	92	our %MAP; # all maps
54	our $LINK_MAP; # the special {link} map	93	our $LINK_MAP; # the special {link} map, which is always available
55	our $RANDOM_MAPS = cf::localdir . "/random";	94
56	our %EXT_CORO; # coroutines bound to extensions	95	# used to convert map paths into valid unix filenames by replacing / by ∕
		96	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		97
		98	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		99	our $LOADAVG; # same thing, but with alpha-smoothing
		100	our $tick_start; # for load detecting purposes
57		101
58	binmode STDOUT;	102	binmode STDOUT;
59	binmode STDERR;	103	binmode STDERR;
60		104
61	# read virtual server time, if available	105	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
66	}	110	}
67		111
68	mkdir cf::localdir;	112	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		114
74	# a special map that is always available
75	our $LINK_MAP;
76	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
		116
		117	sub cf::map::normalise;
77		118
78	#############################################################################	119	#############################################################################
79		120
80	=head2 GLOBAL VARIABLES	121	=head2 GLOBAL VARIABLES
81		122
…		…
88	=item $cf::RUNTIME	129	=item $cf::RUNTIME
89		130
90	The time this server has run, starts at 0 and is increased by $cf::TICK on	131	The time this server has run, starts at 0 and is increased by $cf::TICK on
91	every server tick.	132	every server tick.
92		133
93	=item $cf::LIBDIR	134	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		135	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		136	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
94		137
95	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
96	be found. It will be added to C<@INC> automatically.	139	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		140	unique-items directory, player file directory, random maps directory and
		141	database environment.
97		142
98	=item $cf::NOW	143	=item $cf::NOW
99		144
100	The time of the last (current) server tick.	145	The time of the last (current) server tick.
101		146
102	=item $cf::TICK	147	=item $cf::TICK
103		148
104	The interval between server ticks, in seconds.	149	The interval between server ticks, in seconds.
		150
		151	=item $cf::LOADAVG
		152
		153	The current CPU load on the server (alpha-smoothed), as a value between 0
		154	(none) and 1 (overloaded), indicating how much time is spent on processing
		155	objects per tick. Healthy values are < 0.5.
		156
		157	=item $cf::LOAD
		158
		159	The raw value load value from the last tick.
105		160
106	=item %cf::CFG	161	=item %cf::CFG
107		162
108	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
109	from wherever your confdir points to.	164	from wherever your confdir points to.
		165
		166	=item cf::wait_for_tick, cf::wait_for_tick_begin
		167
		168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		169	returns directly I<after> the tick processing (and consequently, can only wake one process
		170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
110		177
111	=back	178	=back
112		179
113	=cut	180	=cut
114		181
115	BEGIN {	182	BEGIN {
116	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
117	my $msg = join "", @_;	184	my $msg = join "", @_;
118	utf8::encode $msg;
119		185
120	$msg .= "\n"	186	$msg .= "\n"
121	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
122		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
123	LOG llevError, $msg;	192	LOG llevError, $msg;
124	};	193	};
125	}	194	}
126		195
127	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
132	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
133		203
134	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
135	# within the Safe compartment.	205	# within the Safe compartment.
136	for my $pkg (qw(	206	for my $pkg (qw(
137	cf::global cf::attachable	207	cf::global cf::attachable
…		…
146		216
147	$Event::DIED = sub {	217	$Event::DIED = sub {
148	warn "error in event callback: @_";	218	warn "error in event callback: @_";
149	};	219	};
150		220
151	my %ext_pkg;	221	#############################################################################
152	my @exts;
153	my @hook;
154		222
155	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
156		224
157	=over 4	225	=over 4
158		226
159	=cut	227	=item dumpval $ref
160		228
161	use JSON::Syck (); # TODO# replace by JSON::PC once working	229	=cut
		230
		231	sub dumpval {
		232	eval {
		233	local $SIG{__DIE__};
		234	my $d;
		235	if (1) {
		236	$d = new Data::Dumper([$_[0]], ["*var"]);
		237	$d->Terse(1);
		238	$d->Indent(2);
		239	$d->Quotekeys(0);
		240	$d->Useqq(1);
		241	#$d->Bless(...);
		242	$d->Seen($_[1]) if @_ > 1;
		243	$d = $d->Dump();
		244	}
		245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		246	$d
		247	} || "[unable to dump $_[0]: '$@']";
		248	}
162		249
163	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
164		251
165	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
166		253
167	=cut
168
169	sub from_json($) {
170	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171	JSON::Syck::Load $_[0]
172	}
173
174	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
175		255
176	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
177		257
178	=cut	258	=cut
179		259
180	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
181	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
182	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
183	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
184		264
185	=item cf::lock_wait $string	265	=item cf::lock_wait $string
186		266
187	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
188		268
…		…
194	returned.	274	returned.
195		275
196	Lock names should begin with a unique identifier (for example, cf::map::find	276	Lock names should begin with a unique identifier (for example, cf::map::find
197	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
198		278
		279	=item $locked = cf::lock_active $string
		280
		281	Return true if the lock is currently active, i.e. somebody has locked it.
		282
199	=cut	283	=cut
200		284
201	our %LOCK;	285	our %LOCK;
202		286
203	sub lock_wait($) {	287	sub lock_wait($) {
…		…
222	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
223	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
224	}	308	}
225	}	309	}
226		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
		315	}
		316
227	sub freeze_mainloop {	317	sub freeze_mainloop {
228	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
229		319
230	my $guard = Coro::guard { $TICK_WATCHER->start };	320	my $guard = Coro::guard {
		321	$TICK_WATCHER->start;
		322	};
231	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
232	$guard	324	$guard
		325	}
		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
233	}	381	}
234		382
235	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
236		384
237	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
…		…
242		390
243	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
244		392
245	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
246		394
247	The design of crossfire+ requires that the main coro ($Coro::main) is	395	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
248	always able to handle events or runnable, as crossfire+ is only partly	396	is always able to handle events or runnable, as Crossfire TRT is only
249	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
250		399
251	If it must be done, put the blocking parts into C<sync_job>. This will run	400	If it must be done, put the blocking parts into C<sync_job>. This will run
252	the given BLOCK in another coroutine while waiting for the result. The	401	the given BLOCK in another coroutine while waiting for the result. The
253	server will be frozen during this time, so the block should either finish	402	server will be frozen during this time, so the block should either finish
254	fast or be very important.	403	fast or be very important.
…		…
257		406
258	sub sync_job(&) {	407	sub sync_job(&) {
259	my ($job) = @_;	408	my ($job) = @_;
260		409
261	if ($Coro::current == $Coro::main) {	410	if ($Coro::current == $Coro::main) {
		411	my $time = Event::time;
		412
262	# this is the main coro, too bad, we have to block	413	# this is the main coro, too bad, we have to block
263	# till the operation succeeds, freezing the server :/	414	# till the operation succeeds, freezing the server :/
264		415
265	# TODO: use suspend/resume instead	416	# TODO: use suspend/resume instead
266	# (but this is cancel-safe)	417	# (but this is cancel-safe)
…		…
277		428
278	while ($busy) {	429	while ($busy) {
279	Coro::cede or Event::one_event;	430	Coro::cede or Event::one_event;
280	}	431	}
281		432
		433	$time = Event::time - $time;
		434
		435	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		436	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		437
		438	$tick_start += $time; # do not account sync jobs to server load
		439
282	wantarray ? @res : $res[0]	440	wantarray ? @res : $res[0]
283	} else {	441	} else {
284	# we are in another coroutine, how wonderful, everything just works	442	# we are in another coroutine, how wonderful, everything just works
285		443
286	$job->()	444	$job->()
287	}	445	}
288	}	446	}
289		447
290	=item $coro = cf::async_ext { BLOCK }	448	=item $coro = cf::async_ext { BLOCK }
291		449
292	Like async, but this coro is automcatially being canceled when the	450	Like async, but this coro is automatically being canceled when the
293	extension calling this is being unloaded.	451	extension calling this is being unloaded.
294		452
295	=cut	453	=cut
296		454
297	sub async_ext(&) {	455	sub async_ext(&) {
…		…
305	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
306		464
307	$coro	465	$coro
308	}	466	}
309		467
310	sub write_runtime {	468	=item fork_call { }, $args
311	my $runtime = cf::localdir . "/runtime";
312		469
313	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	470	Executes the given code block with the given arguments in a seperate
314	or return;	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
315		474
316	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	475	=cut
317	(aio_write $fh, 0, (length $value), $value, 0) <= 0
318	and return;
319		476
320	aio_fsync $fh	477	sub _store_scalar {
321	and return;	478	open my $fh, ">", \my $buf
322		479	or die "fork_call: cannot open fh-to-buf in child : $!";
		480	Storable::store_fd $_[0], $fh;
323	close $fh	481	close $fh;
324	or return;
325		482
326	aio_rename "$runtime~", $runtime	483	$buf
327	and return;	484	}
328		485
		486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
329	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
		644	}
		645
		646	=item cf::datalog type => key => value, ...
		647
		648	Log a datalog packet of the given type with the given key-value pairs.
		649
		650	=cut
		651
		652	sub datalog($@) {
		653	my ($type, %kv) = @_;
		654	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
330	}	655	}
331		656
332	=back	657	=back
333		658
334	=cut	659	=cut
335
336	#############################################################################
337
338	package cf::path;
339
340	sub new {
341	my ($class, $path, $base) = @_;
342
343	$path = $path->as_string if ref $path;
344
345	my $self = bless { }, $class;
346
347	# {... are special paths that are not touched
348	# ?xxx/... are special absolute paths
349	# ?random/... random maps
350	# /! non-realised random map exit
351	# /... normal maps
352	# ~/... per-player maps without a specific player (DO NOT USE)
353	# ~user/... per-player map of a specific user
354
355	if ($path =~ /^{/) {
356	# fine as it is
357	} elsif ($path =~ s{^\?random/}{}) {
358	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
359	$self->{random} = cf::from_json $data;
360	} else {
361	if ($path =~ s{^~([^/]+)?}{}) {
362	$self->{user_rel} = 1;
363
364	if (defined $1) {
365	$self->{user} = $1;
366	} elsif ($base =~ m{^~([^/]+)/}) {
367	$self->{user} = $1;
368	} else {
369	warn "cannot resolve user-relative path without user <$path,$base>\n";
370	}
371	} elsif ($path =~ /^\//) {
372	# already absolute
373	} else {
374	$base =~ s{[^/]+/?$}{};
375	return $class->new ("$base/$path");
376	}
377
378	for ($path) {
379	redo if s{/\.?/}{/};
380	redo if s{/[^/]+/\.\./}{/};
381	}
382	}
383
384	$self->{path} = $path;
385
386	$self
387	}
388
389	# the name / primary key / in-game path
390	sub as_string {
391	my ($self) = @_;
392
393	$self->{user_rel} ? "~$self->{user}$self->{path}"
394	: $self->{random} ? "?random/$self->{path}"
395	: $self->{path}
396	}
397
398	# the displayed name, this is a one way mapping
399	sub visible_name {
400	my ($self) = @_;
401
402	# if (my $rmp = $self->{random}) {
403	# # todo: be more intelligent about this
404	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
405	# } else {
406	$self->as_string
407	# }
408	}
409
410	# escape the /'s in the path
411	sub _escaped_path {
412	# ∕ is U+2215
413	(my $path = $_[0]{path}) =~ s/\//∕/g;
414	$path
415	}
416
417	# the original (read-only) location
418	sub load_path {
419	my ($self) = @_;
420
421	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
422	}
423
424	# the temporary/swap location
425	sub save_path {
426	my ($self) = @_;
427
428	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
429	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
430	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
431	}
432
433	# the unique path, might be eq to save_path
434	sub uniq_path {
435	my ($self) = @_;
436
437	$self->{user_rel} || $self->{random}
438	? undef
439	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
440	}
441
442	# return random map parameters, or undef
443	sub random_map_params {
444	my ($self) = @_;
445
446	$self->{random}
447	}
448
449	# this is somewhat ugly, but style maps do need special treatment
450	sub is_style_map {
451	$_[0]{path} =~ m{^/styles/}
452	}
453
454	package cf;
455		660
456	#############################################################################	661	#############################################################################
457		662
458	=head2 ATTACHABLE OBJECTS	663	=head2 ATTACHABLE OBJECTS
459		664
…		…
461	attach callbacks/event handlers (a collection of which is called an "attachment")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
462	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
463		668
464	In the following description, CLASS can be any of C<global>, C<object>	669	In the following description, CLASS can be any of C<global>, C<object>
465	C<player>, C<client> or C<map> (i.e. the attachable objects in	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
466	crossfire+).	671	Crossfire TRT).
467		672
468	=over 4	673	=over 4
469		674
470	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
471		676
…		…
585	our @CB_TYPE = (); # registry for type (cf-object class) based events	790	our @CB_TYPE = (); # registry for type (cf-object class) based events
586	our @CB_MAP = ();	791	our @CB_MAP = ();
587		792
588	my %attachment;	793	my %attachment;
589		794
		795	sub cf::attachable::thawer_merge {
		796	# simply override everything except _meta
		797	local $_[0]{_meta};
		798	%{$_[0]} = %{$_[1]};
		799	}
		800
590	sub _attach_cb($$$$) {	801	sub _attach_cb($$$$) {
591	my ($registry, $event, $prio, $cb) = @_;	802	my ($registry, $event, $prio, $cb) = @_;
592		803
593	use sort 'stable';	804	use sort 'stable';
594		805
…		…
628	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
629		840
630	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
631	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
632	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
633	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
634		845
635	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
636	my $pkg = shift @arg;	847	my $pkg = shift @arg;
637		848
638	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
667	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
668	}	879	}
669		880
670	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
671	} else {	882	} else {
672	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
673	}	884	}
674		885
675	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
676	}	887	}
677		888
…		…
679	if (ref $_[0]) {	890	if (ref $_[0]) {
680	_object_attach @_;	891	_object_attach @_;
681	} else {	892	} else {
682	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
683	}	894	}
		895	_recalc_want;
684	};	896	};
685		897
686	# all those should be optimised	898	# all those should be optimised
687	sub cf::attachable::detach {	899	sub cf::attachable::detach {
688	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
691	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
692	reattach ($obj);	904	reattach ($obj);
693	} else {	905	} else {
694	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
695	}	907	}
		908	_recalc_want;
696	};	909	};
697		910
698	sub cf::attachable::attached {	911	sub cf::attachable::attached {
699	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
700		913
…		…
715	";	928	";
716	die if $@;	929	die if $@;
717	}	930	}
718		931
719	our $override;	932	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		934
722	sub override {	935	sub override {
723	$override = 1;	936	$override = 1;
724	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
725	}	938	}
726		939
727	sub do_invoke {	940	sub do_invoke {
728	my $event = shift;	941	my $event = shift;
729	my $callbacks = shift;	942	my $callbacks = shift;
730		943
731	@invoke_results = ();	944	@INVOKE_RESULTS = ();
732		945
733	local $override;	946	local $override;
734		947
735	for (@$callbacks) {	948	for (@$callbacks) {
736	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
753		966
754	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
755		968
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757	removed in future versions), and there is no public API to access override	970	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		972
760	=back	973	=back
761		974
762	=cut	975	=cut
763		976
764	#############################################################################	977	#############################################################################
765	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
766		990
767	sub reattach {	991	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	993	my ($obj) = @_;
		994
		995	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
770		996
771	my $registry = $obj->registry;	997	my $registry = $obj->registry;
772		998
773	@$registry = ();	999	@$registry = ();
774		1000
…		…
821	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
822		1048
823	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
824	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
825	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
826	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
827	close $fh;	1053	close $fh;
828		1054
829	if (@$objs) {	1055	if (@$objs) {
830	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1056	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
831	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
832	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
833	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
834	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
835	close $fh;	1061	close $fh;
836	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
837	}	1063	}
838	} else {	1064	} else {
839	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
871	or return;	1097	or return;
872	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
873	}	1099	}
874		1100
875	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
876	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
877	return ($data, $av);	1103	return ($data, $av);
878	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
879		1111
880	#############################################################################	1112	#############################################################################
881	# command handling &c	1113	# command handling &c
882		1114
883	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
896	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
897	}	1129	}
898		1130
899	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
900		1132
901	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
902		1138
903	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
904	called.	1140	called.
905		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
906	=cut	1153	=cut
907		1154
908	sub register_extcmd {	1155	sub register_extcmd {
909	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
910		1157
911	my $caller = caller;
912	#warn "registering extcmd '$name' to '$caller'";
913
914	$EXTCMD{$name} = [$cb, $caller];	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
915	}	1165	}
916		1166
917	cf::player->attach (	1167	cf::player->attach (
918	on_command => sub {	1168	on_command => sub {
919	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1178	cf::override;
929	},	1179	},
930	on_extcmd => sub {	1180	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
932		1182
933	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1184
935	if (ref $msg) {	1185	if (ref $msg) {
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1186	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937	if (my %reply = $cb->[0]->($pl, $msg)) {	1187	if (my %reply = $cb->($pl, $msg)) {
938	$pl->ext_reply ($msg->{msgid}, %reply);	1188	$pl->ext_reply ($msg->{msgid}, %reply);
939	}	1189	}
940	}	1190	}
941	} else {	1191	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1192	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
944		1194
945	cf::override;	1195	cf::override;
946	},	1196	},
947	);	1197	);
948		1198
949	sub register {
950	my ($base, $pkg) = @_;
951
952	#TODO
953	}
954
955	sub load_extension {
956	my ($path) = @_;
957
958	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
959	my $base = $1;
960	my $pkg = $1;
961	$pkg =~ s/[^[:word:]]/_/g;
962	$pkg = "ext::$pkg";
963
964	warn "loading '$path' into '$pkg'\n";
965
966	open my $fh, "<:utf8", $path
967	or die "$path: $!";
968
969	my $source =
970	"package $pkg; use strict; use utf8;\n"
971	. "#line 1 \"$path\"\n{\n"
972	. (do { local $/; <$fh> })
973	. "\n};\n1";
974
975	eval $source
976	or die $@ ? "$path: $@\n"
977	: "extension disabled.\n";
978
979	push @exts, $pkg;
980	$ext_pkg{$base} = $pkg;
981
982	# no strict 'refs';
983	# @{"$pkg\::ISA"} = ext::;
984
985	register $base, $pkg;
986	}
987
988	sub unload_extension {
989	my ($pkg) = @_;
990
991	warn "removing extension $pkg\n";
992
993	# remove hooks
994	#TODO
995	# for my $idx (0 .. $#PLUGIN_EVENT) {
996	# delete $hook[$idx]{$pkg};
997	# }
998
999	# remove commands
1000	for my $name (keys %COMMAND) {
1001	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1002
1003	if (@cb) {
1004	$COMMAND{$name} = \@cb;
1005	} else {
1006	delete $COMMAND{$name};
1007	}
1008	}
1009
1010	# remove extcmds
1011	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1012	delete $EXTCMD{$name};
1013	}
1014
1015	if (my $cb = $pkg->can ("unload")) {
1016	eval {
1017	$cb->($pkg);
1018	1
1019	} or warn "$pkg unloaded, but with errors: $@";
1020	}
1021
1022	Symbol::delete_package $pkg;
1023	}
1024
1025	sub load_extensions {	1199	sub load_extensions {
		1200	cf::sync_job {
		1201	my %todo;
		1202
1026	for my $ext (<$LIBDIR/*.ext>) {	1203	for my $path (<$LIBDIR/*.ext>) {
1027	next unless -r $ext;	1204	next unless -r $path;
1028	eval {	1205
1029	load_extension $ext;	1206	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1207	my $base = $1;
		1208	my $pkg = $1;
		1209	$pkg =~ s/[^[:word:]]/_/g;
		1210	$pkg = "ext::$pkg";
		1211
		1212	open my $fh, "<:utf8", $path
		1213	or die "$path: $!";
		1214
		1215	my $source = do { local $/; <$fh> };
		1216
		1217	my %ext = (
		1218	path => $path,
		1219	base => $base,
		1220	pkg => $pkg,
		1221	);
		1222
		1223	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1224	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1225
		1226	$ext{source} =
		1227	"package $pkg; use strict; use utf8;\n"
		1228	. "#line 1 \"$path\"\n{\n"
		1229	. $source
		1230	. "\n};\n1";
		1231
		1232	$todo{$base} = \%ext;
		1233	}
		1234
		1235	my %done;
		1236	while (%todo) {
		1237	my $progress;
		1238
		1239	while (my ($k, $v) = each %todo) {
		1240	for (split /,\s*/, $v->{meta}{depends}) {
		1241	goto skip
		1242	unless exists $done{$_};
		1243	}
		1244
		1245	warn "... loading '$k' into '$v->{pkg}'\n";
		1246
		1247	unless (eval $v->{source}) {
		1248	my $msg = $@ ? "$v->{path}: $@\n"
		1249	: "$v->{base}: extension inactive.\n";
		1250
		1251	if (exists $v->{meta}{mandatory}) {
		1252	warn $msg;
		1253	warn "mandatory extension failed to load, exiting.\n";
		1254	exit 1;
		1255	}
		1256
		1257	warn $msg;
		1258	}
		1259
		1260	$done{$k} = delete $todo{$k};
		1261	push @EXTS, $v->{pkg};
		1262	$progress = 1;
1030	1	1263	}
1031	} or warn "$ext not loaded: $@";	1264
		1265	skip:
		1266	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1267	unless $progress;
		1268	}
1032	}	1269	};
1033	}	1270	}
1034		1271
1035	#############################################################################	1272	#############################################################################
1036	# load/save/clean perl data associated with a map
1037		1273
1038	*cf::mapsupport::on_clean = sub {	1274	=back
1039	my ($map) = @_;
1040
1041	my $path = $map->tmpname;
1042	defined $path or return;
1043
1044	unlink "$path.pst";
1045	};
1046
1047	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1048
1049	#############################################################################
1050	# load/save perl data associated with player->ob objects
1051
1052	sub all_objects(@) {
1053	@_, map all_objects ($_->inv), @_
1054	}
1055
1056	# TODO: compatibility cruft, remove when no longer needed
1057	cf::player->attach (
1058	on_load => sub {
1059	my ($pl, $path) = @_;
1060
1061	for my $o (all_objects $pl->ob) {
1062	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1063	$o->set_ob_key_value ("_perl_data");
1064
1065	%$o = %{ Storable::thaw pack "H*", $value };
1066	}
1067	}
1068	},
1069	);
1070
1071	#############################################################################
1072		1275
1073	=head2 CORE EXTENSIONS	1276	=head2 CORE EXTENSIONS
1074		1277
1075	Functions and methods that extend core crossfire objects.	1278	Functions and methods that extend core crossfire objects.
1076		1279
1077	=cut	1280	=cut
1078		1281
1079	package cf::player;	1282	package cf::player;
1080		1283
		1284	use Coro::AIO;
		1285
1081	=head3 cf::player	1286	=head3 cf::player
1082		1287
1083	=over 4	1288	=over 4
1084		1289
1085	=item cf::player::find $login	1290	=item cf::player::find $login
…		…
1087	Returns the given player object, loading it if necessary (might block).	1292	Returns the given player object, loading it if necessary (might block).
1088		1293
1089	=cut	1294	=cut
1090		1295
1091	sub playerdir($) {	1296	sub playerdir($) {
1092	cf::localdir	1297	"$PLAYERDIR/"
1093	. "/"
1094	. cf::playerdir
1095	. "/"
1096	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1298	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1097	}	1299	}
1098		1300
1099	sub path($) {	1301	sub path($) {
1100	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1302	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1101		1303
1102	(playerdir $login) . "/$login.pl"	1304	(playerdir $login) . "/playerdata"
1103	}	1305	}
1104		1306
1105	sub find_active($) {	1307	sub find_active($) {
1106	$cf::PLAYER{$_[0]}	1308	$cf::PLAYER{$_[0]}
1107	and $cf::PLAYER{$_[0]}->active	1309	and $cf::PLAYER{$_[0]}->active
…		…
1110		1312
1111	sub exists($) {	1313	sub exists($) {
1112	my ($login) = @_;	1314	my ($login) = @_;
1113		1315
1114	$cf::PLAYER{$login}	1316	$cf::PLAYER{$login}
1115	or cf::sync_job { !aio_stat $login }	1317	or cf::sync_job { !aio_stat path $login }
1116	}	1318	}
1117		1319
1118	sub find($) {	1320	sub find($) {
1119	return $cf::PLAYER{$_[0]} || do {	1321	return $cf::PLAYER{$_[0]} || do {
1120	my $login = $_[0];	1322	my $login = $_[0];
1121		1323
1122	my $guard = cf::lock_acquire "user_find:$login";	1324	my $guard = cf::lock_acquire "user_find:$login";
1123		1325
1124	$cf::PLAYER{$_[0]} || do {	1326	$cf::PLAYER{$_[0]} || do {
		1327	# rename old playerfiles to new ones
		1328	#TODO: remove when no longer required
		1329	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1330	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1331	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1332	aio_unlink +(playerdir $login) . "/$login.pl";
		1333
1125	my $pl = load_pl path $login	1334	my $pl = load_pl path $login
1126	or return;	1335	or return;
1127	$cf::PLAYER{$login} = $pl	1336	$cf::PLAYER{$login} = $pl
1128	}	1337	}
1129	}	1338	}
…		…
1137	my $path = path $pl;	1346	my $path = path $pl;
1138	my $guard = cf::lock_acquire "user_save:$path";	1347	my $guard = cf::lock_acquire "user_save:$path";
1139		1348
1140	return if $pl->{deny_save};	1349	return if $pl->{deny_save};
1141		1350
1142	Coro::AIO::aio_mkdir playerdir $pl, 0770;	1351	aio_mkdir playerdir $pl, 0770;
1143	$pl->{last_save} = $cf::RUNTIME;	1352	$pl->{last_save} = $cf::RUNTIME;
1144		1353
1145	$pl->save_pl ($path);	1354	$pl->save_pl ($path);
1146	Coro::cede;	1355	Coro::cede;
1147	}	1356	}
…		…
1157	$cf::PLAYER{$login} = $self;	1366	$cf::PLAYER{$login} = $self;
1158		1367
1159	$self	1368	$self
1160	}	1369	}
1161		1370
		1371	=item $pl->quit_character
		1372
		1373	Nukes the player without looking back. If logged in, the connection will
		1374	be destroyed. May block for a long time.
		1375
		1376	=cut
		1377
1162	sub quit_character {	1378	sub quit_character {
1163	my ($pl) = @_;	1379	my ($pl) = @_;
		1380
		1381	my $name = $pl->ob->name;
1164		1382
1165	$pl->{deny_save} = 1;	1383	$pl->{deny_save} = 1;
1166	$pl->password ("*"); # this should lock out the player until we nuked the dir	1384	$pl->password ("*"); # this should lock out the player until we nuked the dir
1167		1385
1168	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1386	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1170	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1388	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1171	$pl->ns->destroy if $pl->ns;	1389	$pl->ns->destroy if $pl->ns;
1172		1390
1173	my $path = playerdir $pl;	1391	my $path = playerdir $pl;
1174	my $temp = "$path~$cf::RUNTIME~deleting~";	1392	my $temp = "$path~$cf::RUNTIME~deleting~";
1175	Coro::AIO::aio_rename $path, $temp;	1393	aio_rename $path, $temp;
1176	delete $cf::PLAYER{$pl->ob->name};	1394	delete $cf::PLAYER{$pl->ob->name};
1177	$pl->destroy;	1395	$pl->destroy;
		1396
		1397	my $prefix = qr<^~\Q$name\E/>;
		1398
		1399	# nuke player maps
		1400	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1401
1178	IO::AIO::aio_rmtree $temp;	1402	IO::AIO::aio_rmtree $temp;
1179	}	1403	}
1180		1404
		1405	=item $pl->kick
		1406
		1407	Kicks a player out of the game. This destroys the connection.
		1408
		1409	=cut
		1410
		1411	sub kick {
		1412	my ($pl, $kicker) = @_;
		1413
		1414	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1415	$pl->killer ("kicked");
		1416	$pl->ns->destroy;
		1417	}
		1418
		1419	=item cf::player::list_logins
		1420
		1421	Returns am arrayref of all valid playernames in the system, can take a
		1422	while and may block, so not sync_job-capable, ever.
		1423
		1424	=cut
		1425
		1426	sub list_logins {
		1427	my $dirs = aio_readdir $PLAYERDIR
		1428	or return [];
		1429
		1430	my @logins;
		1431
		1432	for my $login (@$dirs) {
		1433	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1434	aio_read $fh, 0, 512, my $buf, 0 or next;
		1435	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1436
		1437	utf8::decode $login;
		1438	push @logins, $login;
		1439	}
		1440
		1441	\@logins
		1442	}
		1443
		1444	=item $player->maps
		1445
		1446	Returns an arrayref of map paths that are private for this
		1447	player. May block.
		1448
		1449	=cut
		1450
		1451	sub maps($) {
		1452	my ($pl) = @_;
		1453
		1454	$pl = ref $pl ? $pl->ob->name : $pl;
		1455
		1456	my $files = aio_readdir playerdir $pl
		1457	or return;
		1458
		1459	my @paths;
		1460
		1461	for (@$files) {
		1462	utf8::decode $_;
		1463	next if /\.(?:pl|pst)$/;
		1464	next unless /^$PATH_SEP/o;
		1465
		1466	push @paths, cf::map::normalise "~$pl/$_";
		1467	}
		1468
		1469	\@paths
		1470	}
		1471
		1472	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1473
		1474	Expand crossfire pod fragments into protocol xml.
		1475
		1476	=cut
		1477
		1478	sub expand_cfpod {
		1479	((my $self), (local $_)) = @_;
		1480
		1481	# escape & and <
		1482	s/&/&amp;/g;
		1483	s/(?<![BIUGH])</&lt;/g;
		1484
		1485	# this is buggy, it needs to properly take care of nested <'s
		1486
		1487	1 while
		1488	# replace B<>, I<>, U<> etc.
		1489	s/B<([^\>]*)>/<b>$1<\/b>/
		1490	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1491	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1492	# replace G<male|female> tags
		1493	|| s{G<([^>|]*)\|([^>]*)>}{
		1494	$self->gender ? $2 : $1
		1495	}ge
		1496	# replace H<hint text>
		1497	|| s{H<([^\>]*)>}
		1498	{
		1499	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1500	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1501	"")
		1502	[$self->{hintmode}]
		1503	}ge;
		1504
		1505	# create single paragraphs (very hackish)
		1506	s/(?<=\S)\n(?=\w)/ /g;
		1507
		1508	# compress some whitespace
		1509	s/\s+\n/\n/g; # ws line-ends
		1510	s/\n\n+/\n/g; # double lines
		1511	s/^\n+//; # beginning lines
		1512	s/\n+$//; # ending lines
		1513
		1514	$_
		1515	}
		1516
		1517	sub hintmode {
		1518	$_[0]{hintmode} = $_[1] if @_ > 1;
		1519	$_[0]{hintmode}
		1520	}
		1521
1181	=item $player->ext_reply ($msgid, $msgtype, %msg)	1522	=item $player->ext_reply ($msgid, %msg)
1182		1523
1183	Sends an ext reply to the player.	1524	Sends an ext reply to the player.
1184		1525
1185	=cut	1526	=cut
1186		1527
1187	sub ext_reply($$$%) {	1528	sub ext_reply($$%) {
1188	my ($self, $id, %msg) = @_;	1529	my ($self, $id, %msg) = @_;
1189		1530
1190	$msg{msgid} = $id;	1531	$msg{msgid} = $id;
1191		1532	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1192	$self->send ("ext " . cf::to_json \%msg);
1193	}	1533	}
1194		1534
1195	package cf;	1535	=item $player->ext_event ($type, %msg)
		1536
		1537	Sends an ext event to the client.
		1538
		1539	=cut
		1540
		1541	sub ext_event($$%) {
		1542	my ($self, $type, %msg) = @_;
		1543
		1544	$self->ns->ext_event ($type, %msg);
		1545	}
		1546
		1547	=head3 cf::region
		1548
		1549	=over 4
		1550
		1551	=cut
		1552
		1553	package cf::region;
		1554
		1555	=item cf::region::find_by_path $path
		1556
		1557	Tries to decuce the likely region for a map knowing only its path.
		1558
		1559	=cut
		1560
		1561	sub find_by_path($) {
		1562	my ($path) = @_;
		1563
		1564	my ($match, $specificity);
		1565
		1566	for my $region (list) {
		1567	if ($region->{match} && $path =~ $region->{match}) {
		1568	($match, $specificity) = ($region, $region->specificity)
		1569	if $region->specificity > $specificity;
		1570	}
		1571	}
		1572
		1573	$match
		1574	}
1196		1575
1197	=back	1576	=back
1198
1199		1577
1200	=head3 cf::map	1578	=head3 cf::map
1201		1579
1202	=over 4	1580	=over 4
1203		1581
…		…
1206	package cf::map;	1584	package cf::map;
1207		1585
1208	use Fcntl;	1586	use Fcntl;
1209	use Coro::AIO;	1587	use Coro::AIO;
1210		1588
		1589	use overload
		1590	'""' => \&as_string,
		1591	fallback => 1;
		1592
1211	our $MAX_RESET = 3600;	1593	our $MAX_RESET = 3600;
1212	our $DEFAULT_RESET = 3000;	1594	our $DEFAULT_RESET = 3000;
1213		1595
1214	sub generate_random_map {	1596	sub generate_random_map {
1215	my ($path, $rmp) = @_;	1597	my ($self, $rmp) = @_;
1216
1217	# mit "rum" bekleckern, nicht	1598	# mit "rum" bekleckern, nicht
1218	cf::map::_create_random_map	1599	$self->_create_random_map (
1219	$path,
1220	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1600	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1221	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1601	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1222	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1602	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1223	$rmp->{exit_on_final_map},	1603	$rmp->{exit_on_final_map},
1224	$rmp->{xsize}, $rmp->{ysize},	1604	$rmp->{xsize}, $rmp->{ysize},
1225	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1605	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1226	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1606	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1227	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1607	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1228	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1608	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1229	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1609	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1230	(cf::region::find $rmp->{region})	1610	(cf::region::find $rmp->{region}), $rmp->{custom}
		1611	)
		1612	}
		1613
		1614	=item cf::map->register ($regex, $prio)
		1615
		1616	Register a handler for the map path matching the given regex at the
		1617	givne priority (higher is better, built-in handlers have priority 0, the
		1618	default).
		1619
		1620	=cut
		1621
		1622	sub register {
		1623	my (undef, $regex, $prio) = @_;
		1624	my $pkg = caller;
		1625
		1626	no strict;
		1627	push @{"$pkg\::ISA"}, __PACKAGE__;
		1628
		1629	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1630	}
		1631
		1632	# also paths starting with '/'
		1633	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1634
		1635	sub thawer_merge {
		1636	my ($self, $merge) = @_;
		1637
		1638	# we have to keep some variables in memory intact
		1639	local $self->{path};
		1640	local $self->{load_path};
		1641
		1642	$self->SUPER::thawer_merge ($merge);
		1643	}
		1644
		1645	sub normalise {
		1646	my ($path, $base) = @_;
		1647
		1648	$path = "$path"; # make sure its a string
		1649
		1650	$path =~ s/\.map$//;
		1651
		1652	# map plan:
		1653	#
		1654	# /! non-realised random map exit (special hack!)
		1655	# {... are special paths that are not being touched
		1656	# ?xxx/... are special absolute paths
		1657	# ?random/... random maps
		1658	# /... normal maps
		1659	# ~user/... per-player map of a specific user
		1660
		1661	$path =~ s/$PATH_SEP/\//go;
		1662
		1663	# treat it as relative path if it starts with
		1664	# something that looks reasonable
		1665	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1666	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1667
		1668	$base =~ s{[^/]+/?$}{};
		1669	$path = "$base/$path";
		1670	}
		1671
		1672	for ($path) {
		1673	redo if s{//}{/};
		1674	redo if s{/\.?/}{/};
		1675	redo if s{/[^/]+/\.\./}{/};
		1676	}
		1677
		1678	$path
		1679	}
		1680
		1681	sub new_from_path {
		1682	my (undef, $path, $base) = @_;
		1683
		1684	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1685
		1686	$path = normalise $path, $base;
		1687
		1688	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1689	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1690	my $self = bless cf::map::new, $pkg;
		1691	$self->{path} = $path; $self->path ($path);
		1692	$self->init; # pass $1 etc.
		1693	return $self;
		1694	}
		1695	}
		1696
		1697	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1698	()
		1699	}
		1700
		1701	sub init {
		1702	my ($self) = @_;
		1703
		1704	$self
		1705	}
		1706
		1707	sub as_string {
		1708	my ($self) = @_;
		1709
		1710	"$self->{path}"
		1711	}
		1712
		1713	# the displayed name, this is a one way mapping
		1714	sub visible_name {
		1715	&as_string
		1716	}
		1717
		1718	# the original (read-only) location
		1719	sub load_path {
		1720	my ($self) = @_;
		1721
		1722	"$MAPDIR/$self->{path}.map"
		1723	}
		1724
		1725	# the temporary/swap location
		1726	sub save_path {
		1727	my ($self) = @_;
		1728
		1729	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1730	"$TMPDIR/$path.map"
		1731	}
		1732
		1733	# the unique path, undef == no special unique path
		1734	sub uniq_path {
		1735	my ($self) = @_;
		1736
		1737	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1738	"$UNIQUEDIR/$path"
1231	}	1739	}
1232		1740
1233	# and all this just because we cannot iterate over	1741	# and all this just because we cannot iterate over
1234	# all maps in C++...	1742	# all maps in C++...
1235	sub change_all_map_light {	1743	sub change_all_map_light {
…		…
1237		1745
1238	$_->change_map_light ($change)	1746	$_->change_map_light ($change)
1239	for grep $_->outdoor, values %cf::MAP;	1747	for grep $_->outdoor, values %cf::MAP;
1240	}	1748	}
1241		1749
		1750	sub decay_objects {
		1751	my ($self) = @_;
		1752
		1753	return if $self->{deny_reset};
		1754
		1755	$self->do_decay_objects;
		1756	}
		1757
		1758	sub unlink_save {
		1759	my ($self) = @_;
		1760
		1761	utf8::encode (my $save = $self->save_path);
		1762	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1763	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1764	}
		1765
1242	sub try_load_header($) {	1766	sub load_header_from($) {
1243	my ($path) = @_;	1767	my ($self, $path) = @_;
1244		1768
1245	utf8::encode $path;	1769	utf8::encode $path;
1246	aio_open $path, O_RDONLY, 0	1770	#aio_open $path, O_RDONLY, 0
		1771	# or return;
		1772
		1773	$self->_load_header ($path)
1247	or return;	1774	or return;
1248		1775
1249	my $map = cf::map::new	1776	$self->{load_path} = $path;
		1777
		1778	1
		1779	}
		1780
		1781	sub load_header_orig {
		1782	my ($self) = @_;
		1783
		1784	$self->load_header_from ($self->load_path)
		1785	}
		1786
		1787	sub load_header_temp {
		1788	my ($self) = @_;
		1789
		1790	$self->load_header_from ($self->save_path)
		1791	}
		1792
		1793	sub prepare_temp {
		1794	my ($self) = @_;
		1795
		1796	$self->last_access ((delete $self->{last_access})
		1797	|| $cf::RUNTIME); #d#
		1798	# safety
		1799	$self->{instantiate_time} = $cf::RUNTIME
		1800	if $self->{instantiate_time} > $cf::RUNTIME;
		1801	}
		1802
		1803	sub prepare_orig {
		1804	my ($self) = @_;
		1805
		1806	$self->{load_original} = 1;
		1807	$self->{instantiate_time} = $cf::RUNTIME;
		1808	$self->last_access ($cf::RUNTIME);
		1809	$self->instantiate;
		1810	}
		1811
		1812	sub load_header {
		1813	my ($self) = @_;
		1814
		1815	if ($self->load_header_temp) {
		1816	$self->prepare_temp;
		1817	} else {
		1818	$self->load_header_orig
1250	or return;	1819	or return;
		1820	$self->prepare_orig;
		1821	}
1251		1822
1252	# for better error messages only, will be overwritten	1823	$self->{deny_reset} = 1
1253	$map->path ($path);	1824	if $self->no_reset;
1254		1825
1255	$map->load_header ($path)	1826	$self->default_region (cf::region::find_by_path $self->{path})
1256	or return;	1827	unless $self->default_region;
1257		1828
1258	$map->{load_path} = $path;	1829	1
1259
1260	$map
1261	}	1830	}
1262		1831
1263	sub find;	1832	sub find;
1264	sub find {	1833	sub find {
1265	my ($path, $origin) = @_;	1834	my ($path, $origin) = @_;
1266		1835
1267	#warn "find<$path,$origin>\n";#d#
1268
1269	$path = new cf::path $path, $origin && $origin->path;	1836	$path = normalise $path, $origin && $origin->path;
1270	my $key = $path->as_string;
1271		1837
1272	cf::lock_wait "map_find:$key";	1838	cf::lock_wait "map_find:$path";
1273		1839
1274	$cf::MAP{$key} || do {	1840	$cf::MAP{$path} || do {
1275	my $guard = cf::lock_acquire "map_find:$key";	1841	my $guard = cf::lock_acquire "map_find:$path";
1276		1842	my $map = new_from_path cf::map $path
1277	# do it the slow way
1278	my $map = try_load_header $path->save_path;
1279
1280	Coro::cede;
1281
1282	if ($map) {
1283	$map->last_access ((delete $map->{last_access})
1284	|| $cf::RUNTIME); #d#
1285	# safety
1286	$map->{instantiate_time} = $cf::RUNTIME
1287	if $map->{instantiate_time} > $cf::RUNTIME;
1288	} else {
1289	if (my $rmp = $path->random_map_params) {
1290	$map = generate_random_map $key, $rmp;
1291	} else {
1292	$map = try_load_header $path->load_path;
1293	}
1294
1295	$map or return;	1843	or return;
1296		1844
1297	$map->{load_original} = 1;
1298	$map->{instantiate_time} = $cf::RUNTIME;
1299	$map->last_access ($cf::RUNTIME);
1300	$map->instantiate;
1301
1302	# per-player maps become, after loading, normal maps
1303	$map->per_player (0) if $path->{user_rel};
1304	}
1305
1306	$map->path ($key);
1307	$map->{path} = $path;
1308	$map->{last_save} = $cf::RUNTIME;	1845	$map->{last_save} = $cf::RUNTIME;
1309		1846
1310	Coro::cede;	1847	$map->load_header
		1848	or return;
1311		1849
1312	if ($map->should_reset) {	1850	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1851	# doing this can freeze the server in a sync job, obviously
		1852	#$cf::WAIT_FOR_TICK->wait;
1313	$map->reset;	1853	$map->reset;
1314	undef $guard;	1854	undef $guard;
1315	$map = find $path	1855	return find $path;
1316	or return;
1317	}	1856	}
1318		1857
1319	$cf::MAP{$key} = $map	1858	$cf::MAP{$path} = $map
1320	}	1859	}
1321	}	1860	}
		1861
		1862	sub pre_load { }
		1863	sub post_load { }
1322		1864
1323	sub load {	1865	sub load {
1324	my ($self) = @_;	1866	my ($self) = @_;
1325		1867
		1868	local $self->{deny_reset} = 1; # loading can take a long time
		1869
1326	my $path = $self->{path};	1870	my $path = $self->{path};
		1871
		1872	{
1327	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1873	my $guard = cf::lock_acquire "map_load:$path";
1328		1874
1329	return if $self->in_memory != cf::MAP_SWAPPED;	1875	return if $self->in_memory != cf::MAP_SWAPPED;
1330		1876
1331	$self->in_memory (cf::MAP_LOADING);	1877	$self->in_memory (cf::MAP_LOADING);
1332		1878
1333	$self->alloc;	1879	$self->alloc;
		1880
		1881	$self->pre_load;
		1882	Coro::cede;
		1883
1334	$self->load_objects ($self->{load_path}, 1)	1884	$self->_load_objects ($self->{load_path}, 1)
1335	or return;	1885	or return;
1336		1886
1337	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1887	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1338	if delete $self->{load_original};	1888	if delete $self->{load_original};
1339		1889
1340	if (my $uniq = $path->uniq_path) {	1890	if (my $uniq = $self->uniq_path) {
1341	utf8::encode $uniq;	1891	utf8::encode $uniq;
1342	if (aio_open $uniq, O_RDONLY, 0) {	1892	if (aio_open $uniq, O_RDONLY, 0) {
1343	$self->clear_unique_items;	1893	$self->clear_unique_items;
1344	$self->load_objects ($uniq, 0);	1894	$self->_load_objects ($uniq, 0);
1345	}	1895	}
1346	}	1896	}
1347		1897
1348	Coro::cede;	1898	Coro::cede;
1349
1350	# now do the right thing for maps	1899	# now do the right thing for maps
1351	$self->link_multipart_objects;	1900	$self->link_multipart_objects;
1352
1353	if ($self->{path}->is_style_map) {
1354	$self->{deny_save} = 1;
1355	$self->{deny_reset} = 1;
1356	} else {
1357	$self->fix_auto_apply;
1358	$self->decay_objects;
1359	$self->update_buttons;
1360	$self->set_darkness_map;
1361	$self->difficulty ($self->estimate_difficulty)	1901	$self->difficulty ($self->estimate_difficulty)
1362	unless $self->difficulty;	1902	unless $self->difficulty;
		1903	Coro::cede;
		1904
		1905	unless ($self->{deny_activate}) {
		1906	$self->decay_objects;
		1907	$self->fix_auto_apply;
		1908	$self->update_buttons;
		1909	Coro::cede;
		1910	$self->set_darkness_map;
		1911	Coro::cede;
1363	$self->activate;	1912	$self->activate;
1364	}	1913	}
1365		1914
1366	Coro::cede;
1367
1368	$self->in_memory (cf::MAP_IN_MEMORY);	1915	$self->in_memory (cf::MAP_IN_MEMORY);
		1916	}
		1917
		1918	$self->post_load;
		1919	}
		1920
		1921	sub customise_for {
		1922	my ($self, $ob) = @_;
		1923
		1924	return find "~" . $ob->name . "/" . $self->{path}
		1925	if $self->per_player;
		1926
		1927	# return find "?party/" . $ob->name . "/" . $self->{path}
		1928	# if $self->per_party;
		1929
		1930	$self
		1931	}
		1932
		1933	# find and load all maps in the 3x3 area around a map
		1934	sub load_diag {
		1935	my ($map) = @_;
		1936
		1937	my @diag; # diagonal neighbours
		1938
		1939	for (0 .. 3) {
		1940	my $neigh = $map->tile_path ($_)
		1941	or next;
		1942	$neigh = find $neigh, $map
		1943	or next;
		1944	$neigh->load;
		1945
		1946	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1947	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1948	}
		1949
		1950	for (@diag) {
		1951	my $neigh = find @$_
		1952	or next;
		1953	$neigh->load;
		1954	}
1369	}	1955	}
1370		1956
1371	sub find_sync {	1957	sub find_sync {
1372	my ($path, $origin) = @_;	1958	my ($path, $origin) = @_;
1373		1959
1374	cf::sync_job { cf::map::find $path, $origin }	1960	cf::sync_job { find $path, $origin }
1375	}	1961	}
1376		1962
1377	sub do_load_sync {	1963	sub do_load_sync {
1378	my ($map) = @_;	1964	my ($map) = @_;
1379		1965
1380	cf::sync_job { $map->load };	1966	cf::sync_job { $map->load };
1381	}	1967	}
1382		1968
		1969	our %MAP_PREFETCH;
		1970	our $MAP_PREFETCHER = undef;
		1971
		1972	sub find_async {
		1973	my ($path, $origin) = @_;
		1974
		1975	$path = normalise $path, $origin && $origin->{path};
		1976
		1977	if (my $map = $cf::MAP{$path}) {
		1978	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1979	}
		1980
		1981	undef $MAP_PREFETCH{$path};
		1982	$MAP_PREFETCHER ||= cf::async {
		1983	while (%MAP_PREFETCH) {
		1984	for my $path (keys %MAP_PREFETCH) {
		1985	if (my $map = find $path) {
		1986	$map->load;
		1987	}
		1988
		1989	delete $MAP_PREFETCH{$path};
		1990	}
		1991	}
		1992	undef $MAP_PREFETCHER;
		1993	};
		1994	$MAP_PREFETCHER->prio (6);
		1995
		1996	()
		1997	}
		1998
1383	sub save {	1999	sub save {
1384	my ($self) = @_;	2000	my ($self) = @_;
1385		2001
1386	my $lock = cf::lock_acquire "map_data:" . $self->path;	2002	my $lock = cf::lock_acquire "map_data:" . $self->path;
1387		2003
1388	$self->{last_save} = $cf::RUNTIME;	2004	$self->{last_save} = $cf::RUNTIME;
1389		2005
1390	return unless $self->dirty;	2006	return unless $self->dirty;
1391		2007
1392	my $save = $self->{path}->save_path; utf8::encode $save;	2008	my $save = $self->save_path; utf8::encode $save;
1393	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2009	my $uniq = $self->uniq_path; utf8::encode $uniq;
1394		2010
1395	$self->{load_path} = $save;	2011	$self->{load_path} = $save;
1396		2012
1397	return if $self->{deny_save};	2013	return if $self->{deny_save};
1398		2014
…		…
1401	cf::async {	2017	cf::async {
1402	$_->contr->save for $self->players;	2018	$_->contr->save for $self->players;
1403	};	2019	};
1404		2020
1405	if ($uniq) {	2021	if ($uniq) {
1406	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2022	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1407	$self->save_objects ($uniq, cf::IO_UNIQUES);	2023	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1408	} else {	2024	} else {
1409	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2025	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1410	}	2026	}
1411	}	2027	}
1412		2028
1413	sub swap_out {	2029	sub swap_out {
1414	my ($self) = @_;	2030	my ($self) = @_;
…		…
1428		2044
1429	sub reset_at {	2045	sub reset_at {
1430	my ($self) = @_;	2046	my ($self) = @_;
1431		2047
1432	# TODO: safety, remove and allow resettable per-player maps	2048	# TODO: safety, remove and allow resettable per-player maps
1433	return 1e99 if $self->{path}{user_rel};
1434	return 1e99 if $self->{deny_reset};	2049	return 1e99 if $self->{deny_reset};
1435		2050
1436	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2051	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1437	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2052	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1438		2053
…		…
1443	my ($self) = @_;	2058	my ($self) = @_;
1444		2059
1445	$self->reset_at <= $cf::RUNTIME	2060	$self->reset_at <= $cf::RUNTIME
1446	}	2061	}
1447		2062
1448	sub unlink_save {
1449	my ($self) = @_;
1450
1451	utf8::encode (my $save = $self->{path}->save_path);
1452	aioreq_pri 3; IO::AIO::aio_unlink $save;
1453	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1454	}
1455
1456	sub rename {
1457	my ($self, $new_path) = @_;
1458
1459	$self->unlink_save;
1460
1461	delete $cf::MAP{$self->path};
1462	$self->{path} = new cf::path $new_path;
1463	$self->path ($self->{path}->as_string);
1464	$cf::MAP{$self->path} = $self;
1465
1466	$self->save;
1467	}
1468
1469	sub reset {	2063	sub reset {
1470	my ($self) = @_;	2064	my ($self) = @_;
1471		2065
1472	my $lock = cf::lock_acquire "map_data:" . $self->path;	2066	my $lock = cf::lock_acquire "map_data:$self->{path}";
1473		2067
1474	return if $self->players;	2068	return if $self->players;
1475	return if $self->{path}{user_rel};#d#
1476		2069
1477	warn "resetting map ", $self->path;#d#	2070	warn "resetting map ", $self->path;
		2071
		2072	$self->in_memory (cf::MAP_SWAPPED);
		2073
		2074	# need to save uniques path
		2075	unless ($self->{deny_save}) {
		2076	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2077
		2078	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2079	if $uniq;
		2080	}
1478		2081
1479	delete $cf::MAP{$self->path};	2082	delete $cf::MAP{$self->path};
		2083
		2084	$self->clear;
1480		2085
1481	$_->clear_links_to ($self) for values %cf::MAP;	2086	$_->clear_links_to ($self) for values %cf::MAP;
1482		2087
1483	$self->unlink_save;	2088	$self->unlink_save;
1484	$self->destroy;	2089	$self->destroy;
…		…
1487	my $nuke_counter = "aaaa";	2092	my $nuke_counter = "aaaa";
1488		2093
1489	sub nuke {	2094	sub nuke {
1490	my ($self) = @_;	2095	my ($self) = @_;
1491		2096
		2097	delete $cf::MAP{$self->path};
		2098
		2099	$self->unlink_save;
		2100
		2101	bless $self, "cf::map";
		2102	delete $self->{deny_reset};
1492	$self->{deny_save} = 1;	2103	$self->{deny_save} = 1;
1493	$self->reset_timeout (1);	2104	$self->reset_timeout (1);
1494	$self->rename ("{nuke}/" . ($nuke_counter++));	2105	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2106
		2107	$cf::MAP{$self->path} = $self;
		2108
1495	$self->reset; # polite request, might not happen	2109	$self->reset; # polite request, might not happen
1496	}	2110	}
1497		2111
1498	sub customise_for {	2112	=item $maps = cf::map::tmp_maps
1499	my ($map, $ob) = @_;
1500		2113
1501	if ($map->per_player) {	2114	Returns an arrayref with all map paths of currently instantiated and saved
1502	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2115	maps. May block.
		2116
		2117	=cut
		2118
		2119	sub tmp_maps() {
1503	}	2120	[
1504		2121	map {
1505	$map	2122	utf8::decode $_;
		2123	/\.map$/
		2124	? normalise $_
		2125	: ()
		2126	} @{ aio_readdir $TMPDIR or [] }
		2127	]
1506	}	2128	}
1507		2129
1508	sub emergency_save {	2130	=item $maps = cf::map::random_maps
1509	my $freeze_guard = cf::freeze_mainloop;
1510		2131
1511	warn "enter emergency perl save\n";	2132	Returns an arrayref with all map paths of currently instantiated and saved
		2133	random maps. May block.
1512		2134
1513	cf::sync_job {	2135	=cut
1514	warn "begin emergency player save\n";
1515	$_->save for values %cf::PLAYER;
1516	warn "end emergency player save\n";
1517		2136
1518	warn "begin emergency map save\n";	2137	sub random_maps() {
1519	$_->save for values %cf::MAP;	2138	[
1520	warn "end emergency map save\n";	2139	map {
1521	};	2140	utf8::decode $_;
		2141	/\.map$/
		2142	? normalise "?random/$_"
		2143	: ()
		2144	} @{ aio_readdir $RANDOMDIR or [] }
		2145	]
		2146	}
1522		2147
1523	warn "leave emergency perl save\n";	2148	=item cf::map::unique_maps
		2149
		2150	Returns an arrayref of paths of all shared maps that have
		2151	instantiated unique items. May block.
		2152
		2153	=cut
		2154
		2155	sub unique_maps() {
		2156	[
		2157	map {
		2158	utf8::decode $_;
		2159	/\.map$/
		2160	? normalise $_
		2161	: ()
		2162	} @{ aio_readdir $UNIQUEDIR or [] }
		2163	]
1524	}	2164	}
1525		2165
1526	package cf;	2166	package cf;
1527		2167
1528	=back	2168	=back
1529		2169
		2170	=head3 cf::object
		2171
		2172	=cut
		2173
		2174	package cf::object;
		2175
		2176	=over 4
		2177
		2178	=item $ob->inv_recursive
		2179
		2180	Returns the inventory of the object _and_ their inventories, recursively.
		2181
		2182	=cut
		2183
		2184	sub inv_recursive_;
		2185	sub inv_recursive_ {
		2186	map { $_, inv_recursive_ $_->inv } @_
		2187	}
		2188
		2189	sub inv_recursive {
		2190	inv_recursive_ inv $_[0]
		2191	}
		2192
		2193	package cf;
		2194
		2195	=back
1530		2196
1531	=head3 cf::object::player	2197	=head3 cf::object::player
1532		2198
1533	=over 4	2199	=over 4
1534		2200
…		…
1548		2214
1549	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2215	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1550		2216
1551	if ($self->{record_replies}) {	2217	if ($self->{record_replies}) {
1552	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2218	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2219
1553	} else {	2220	} else {
		2221	my $pl = $self->contr;
		2222
		2223	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2224	my $diag = $pl->{npc_dialog};
		2225	$diag->{pl}->ext_reply (
		2226	$diag->{id},
		2227	msgtype => "reply",
		2228	msg => $diag->{pl}->expand_cfpod ($msg),
		2229	add_topics => []
		2230	);
		2231
		2232	} else {
1554	$msg = $npc->name . " says: $msg" if $npc;	2233	$msg = $npc->name . " says: $msg" if $npc;
1555	$self->message ($msg, $flags);	2234	$self->message ($msg, $flags);
		2235	}
1556	}	2236	}
1557	}	2237	}
1558		2238
1559	=item $player_object->may ("access")	2239	=item $player_object->may ("access")
1560		2240
…		…
1574		2254
1575	=item $player_object->enter_link	2255	=item $player_object->enter_link
1576		2256
1577	Freezes the player and moves him/her to a special map (C<{link}>).	2257	Freezes the player and moves him/her to a special map (C<{link}>).
1578		2258
1579	The player should be reaosnably safe there for short amounts of time. You	2259	The player should be reasonably safe there for short amounts of time. You
1580	I<MUST> call C<leave_link> as soon as possible, though.	2260	I<MUST> call C<leave_link> as soon as possible, though.
1581		2261
		2262	Will never block.
		2263
1582	=item $player_object->leave_link ($map, $x, $y)	2264	=item $player_object->leave_link ($map, $x, $y)
1583		2265
1584	Moves the player out of the specila link map onto the given map. If the	2266	Moves the player out of the special C<{link}> map onto the specified
1585	map is not valid (or omitted), the player will be moved back to the	2267	map. If the map is not valid (or omitted), the player will be moved back
1586	location he/she was before the call to C<enter_link>, or, if that fails,	2268	to the location he/she was before the call to C<enter_link>, or, if that
1587	to the emergency map position.	2269	fails, to the emergency map position.
1588		2270
1589	Might block.	2271	Might block.
1590		2272
1591	=cut	2273	=cut
		2274
		2275	sub link_map {
		2276	unless ($LINK_MAP) {
		2277	$LINK_MAP = cf::map::find "{link}"
		2278	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2279	$LINK_MAP->load;
		2280	}
		2281
		2282	$LINK_MAP
		2283	}
1592		2284
1593	sub cf::object::player::enter_link {	2285	sub cf::object::player::enter_link {
1594	my ($self) = @_;	2286	my ($self) = @_;
1595		2287
1596	$self->deactivate_recursive;	2288	$self->deactivate_recursive;
1597		2289
1598	return if $self->map == $LINK_MAP;	2290	return if UNIVERSAL::isa $self->map, "ext::map_link";
1599		2291
1600	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2292	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1601	if $self->map;	2293	if $self->map && $self->map->{path} ne "{link}";
1602		2294
1603	$self->enter_map ($LINK_MAP, 20, 20);	2295	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1604	}	2296	}
1605		2297
1606	sub cf::object::player::leave_link {	2298	sub cf::object::player::leave_link {
1607	my ($self, $map, $x, $y) = @_;	2299	my ($self, $map, $x, $y) = @_;
		2300
		2301	return unless $self->contr->active;
1608		2302
1609	my $link_pos = delete $self->{_link_pos};	2303	my $link_pos = delete $self->{_link_pos};
1610		2304
1611	unless ($map) {	2305	unless ($map) {
1612	# restore original map position	2306	# restore original map position
…		…
1626	# use -1 or undef as default coordinates, not 0, 0	2320	# use -1 or undef as default coordinates, not 0, 0
1627	($x, $y) = ($map->enter_x, $map->enter_y)	2321	($x, $y) = ($map->enter_x, $map->enter_y)
1628	if $x <=0 && $y <= 0;	2322	if $x <=0 && $y <= 0;
1629		2323
1630	$map->load;	2324	$map->load;
		2325	$map->load_diag;
1631		2326
1632	return unless $self->contr->active;	2327	return unless $self->contr->active;
1633	$self->activate_recursive;	2328	$self->activate_recursive;
		2329
		2330	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1634	$self->enter_map ($map, $x, $y);	2331	$self->enter_map ($map, $x, $y);
1635	}	2332	}
1636		2333
1637	cf::player->attach (	2334	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1638	on_logout => sub {
1639	my ($pl) = @_;
1640		2335
1641	# abort map switching before logout	2336	Moves the player to the given map-path and coordinates by first freezing
1642	if ($pl->ob->{_link_pos}) {	2337	her, loading and preparing them map, calling the provided $check callback
1643	cf::sync_job {	2338	that has to return the map if sucecssful, and then unfreezes the player on
1644	$pl->ob->leave_link	2339	the new (success) or old (failed) map position. In either case, $done will
1645	};	2340	be called at the end of this process.
1646	}
1647	},
1648	on_login => sub {
1649	my ($pl) = @_;
1650		2341
1651	# try to abort aborted map switching on player login :)
1652	# should happen only on crashes
1653	if ($pl->ob->{_link_pos}) {
1654	$pl->ob->enter_link;
1655	(async {
1656	# we need this sleep as the login has a concurrent enter_exit running
1657	# and this sleep increases chances of the player not ending up in scorn
1658	$pl->ob->reply (undef,
1659	"There was an internal problem at your last logout, "
1660	. "the server will try to bring you to your intended destination in a second.",
1661	cf::NDI_RED);
1662	Coro::Timer::sleep 1;
1663	$pl->ob->leave_link;
1664	})->prio (2);
1665	}
1666	},
1667	);
1668
1669	=item $player_object->goto ($path, $x, $y)
1670
1671	=cut	2342	=cut
		2343
		2344	our $GOTOGEN;
1672		2345
1673	sub cf::object::player::goto {	2346	sub cf::object::player::goto {
1674	my ($self, $path, $x, $y) = @_;	2347	my ($self, $path, $x, $y, $check, $done) = @_;
1675		2348
1676	$path = new cf::path $path;	2349	# do generation counting so two concurrent goto's will be executed in-order
1677	$path ne "/" or Carp::cluck ("oy");#d#	2350	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1678		2351
1679	$self->enter_link;	2352	$self->enter_link;
1680		2353
1681	(async {	2354	(async {
		2355	my $map = eval {
1682	my $map = cf::map::find $path->as_string;	2356	my $map = cf::map::find $path;
		2357
		2358	if ($map) {
1683	$map = $map->customise_for ($self) if $map;	2359	$map = $map->customise_for ($self);
1684		2360	$map = $check->($map) if $check && $map;
1685	# warn "entering ", $map->path, " at ($x, $y)\n"	2361	} else {
1686	# if $map;
1687
1688	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2362	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2363	}
1689		2364
		2365	$map
		2366	};
		2367
		2368	if ($@) {
		2369	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2370	LOG llevError | logBacktrace, Carp::longmess $@;
		2371	}
		2372
		2373	if ($gen == $self->{_goto_generation}) {
		2374	delete $self->{_goto_generation};
1690	$self->leave_link ($map, $x, $y);	2375	$self->leave_link ($map, $x, $y);
		2376	}
		2377
		2378	$done->() if $done;
1691	})->prio (1);	2379	})->prio (1);
1692	}	2380	}
1693		2381
1694	=item $player_object->enter_exit ($exit_object)	2382	=item $player_object->enter_exit ($exit_object)
1695		2383
…		…
1697		2385
1698	sub parse_random_map_params {	2386	sub parse_random_map_params {
1699	my ($spec) = @_;	2387	my ($spec) = @_;
1700		2388
1701	my $rmp = { # defaults	2389	my $rmp = { # defaults
1702	xsize => 10,	2390	xsize => (cf::rndm 15, 40),
1703	ysize => 10,	2391	ysize => (cf::rndm 15, 40),
		2392	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2393	#layout => string,
1704	};	2394	};
1705		2395
1706	for (split /\n/, $spec) {	2396	for (split /\n/, $spec) {
1707	my ($k, $v) = split /\s+/, $_, 2;	2397	my ($k, $v) = split /\s+/, $_, 2;
1708		2398
…		…
1712	$rmp	2402	$rmp
1713	}	2403	}
1714		2404
1715	sub prepare_random_map {	2405	sub prepare_random_map {
1716	my ($exit) = @_;	2406	my ($exit) = @_;
		2407
		2408	my $guard = cf::lock_acquire "exit_prepare:$exit";
1717		2409
1718	# all this does is basically replace the /! path by	2410	# all this does is basically replace the /! path by
1719	# a new random map path (?random/...) with a seed	2411	# a new random map path (?random/...) with a seed
1720	# that depends on the exit object	2412	# that depends on the exit object
1721		2413
1722	my $rmp = parse_random_map_params $exit->msg;	2414	my $rmp = parse_random_map_params $exit->msg;
1723		2415
1724	if ($exit->map) {	2416	if ($exit->map) {
1725	$rmp->{region} = $exit->map->region_name;	2417	$rmp->{region} = $exit->region->name;
1726	$rmp->{origin_map} = $exit->map->path;	2418	$rmp->{origin_map} = $exit->map->path;
1727	$rmp->{origin_x} = $exit->x;	2419	$rmp->{origin_x} = $exit->x;
1728	$rmp->{origin_y} = $exit->y;	2420	$rmp->{origin_y} = $exit->y;
1729	}	2421	}
1730		2422
1731	$rmp->{random_seed} ||= $exit->random_seed;	2423	$rmp->{random_seed} ||= $exit->random_seed;
1732		2424
1733	my $data = cf::to_json $rmp;	2425	my $data = cf::to_json $rmp;
1734	my $md5 = Digest::MD5::md5_hex $data;	2426	my $md5 = Digest::MD5::md5_hex $data;
		2427	my $meta = "$RANDOMDIR/$md5.meta";
1735		2428
1736	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2429	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1737	aio_write $fh, 0, (length $data), $data, 0;	2430	aio_write $fh, 0, (length $data), $data, 0;
		2431	undef $fh;
		2432	aio_rename "$meta~", $meta;
1738		2433
1739	$exit->slaying ("?random/$md5");	2434	$exit->slaying ("?random/$md5");
1740	$exit->msg (undef);	2435	$exit->msg (undef);
1741	}	2436	}
1742	}	2437	}
…		…
1744	sub cf::object::player::enter_exit {	2439	sub cf::object::player::enter_exit {
1745	my ($self, $exit) = @_;	2440	my ($self, $exit) = @_;
1746		2441
1747	return unless $self->type == cf::PLAYER;	2442	return unless $self->type == cf::PLAYER;
1748		2443
		2444	if ($exit->slaying eq "/!") {
		2445	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2446	# the problem is that $exit might not survive long enough
		2447	# so it needs to be done right now, right here
		2448	cf::sync_job { prepare_random_map $exit };
		2449	}
		2450
		2451	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2452	my $hp = $exit->stats->hp;
		2453	my $sp = $exit->stats->sp;
		2454
1749	$self->enter_link;	2455	$self->enter_link;
		2456
		2457	# if exit is damned, update players death & WoR home-position
		2458	$self->contr->savebed ($slaying, $hp, $sp)
		2459	if $exit->flag (FLAG_DAMNED);
1750		2460
1751	(async {	2461	(async {
1752	$self->deactivate_recursive; # just to be sure	2462	$self->deactivate_recursive; # just to be sure
1753	unless (eval {	2463	unless (eval {
1754	prepare_random_map $exit	2464	$self->goto ($slaying, $hp, $sp);
1755	if $exit->slaying eq "/!";
1756
1757	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1758	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1759		2465
1760	1;	2466	1;
1761	}) {	2467	}) {
1762	$self->message ("Something went wrong deep within the crossfire server. "	2468	$self->message ("Something went wrong deep within the crossfire server. "
1763	. "I'll try to bring you back to the map you were before. "	2469	. "I'll try to bring you back to the map you were before. "
1764	. "Please report this to the dungeon master",	2470	. "Please report this to the dungeon master!",
1765	cf::NDI_UNIQUE | cf::NDI_RED);	2471	cf::NDI_UNIQUE | cf::NDI_RED);
1766		2472
1767	warn "ERROR in enter_exit: $@";	2473	warn "ERROR in enter_exit: $@";
1768	$self->leave_link;	2474	$self->leave_link;
1769	}	2475	}
1770	})->prio (1);	2476	})->prio (1);
…		…
1783		2489
1784	sub cf::client::send_drawinfo {	2490	sub cf::client::send_drawinfo {
1785	my ($self, $text, $flags) = @_;	2491	my ($self, $text, $flags) = @_;
1786		2492
1787	utf8::encode $text;	2493	utf8::encode $text;
1788	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2494	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1789	}	2495	}
1790		2496
		2497	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2498
		2499	Send a drawinfo or msg packet to the client, formatting the msg for the
		2500	client if neccessary. C<$type> should be a string identifying the type of
		2501	the message, with C<log> being the default. If C<$color> is negative, suppress
		2502	the message unless the client supports the msg packet.
		2503
		2504	=cut
		2505
		2506	sub cf::client::send_msg {
		2507	my ($self, $channel, $msg, $color, @extra) = @_;
		2508
		2509	$msg = $self->pl->expand_cfpod ($msg);
		2510
		2511	$color &= ~cf::NDI_UNIQUE; # just in case...
		2512
		2513	if (ref $channel) {
		2514	# send meta info to client, if not yet sent
		2515	unless (exists $self->{channel}{$channel->{id}}) {
		2516	$self->{channel}{$channel->{id}} = $channel;
		2517	$self->ext_event (channel_info => %$channel);
		2518	}
		2519
		2520	$channel = $channel->{id};
		2521	}
		2522
		2523	return unless @extra || length $msg;
		2524
		2525	if ($self->can_msg) {
		2526	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2527	} else {
		2528	# replace some tags by gcfclient-compatible ones
		2529	for ($msg) {
		2530	1 while
		2531	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2532	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2533	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2534	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2535	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2536	}
		2537
		2538	if ($color >= 0) {
		2539	if (0 && $msg =~ /\[/) {
		2540	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2541	} else {
		2542	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2543	$self->send_packet ("drawinfo $color $msg")
		2544	}
		2545	}
		2546	}
		2547	}
		2548
		2549	=item $client->ext_event ($type, %msg)
		2550
		2551	Sends an ext event to the client.
		2552
		2553	=cut
		2554
		2555	sub cf::client::ext_event($$%) {
		2556	my ($self, $type, %msg) = @_;
		2557
		2558	return unless $self->extcmd;
		2559
		2560	$msg{msgtype} = "event_$type";
		2561	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2562	}
1791		2563
1792	=item $success = $client->query ($flags, "text", \&cb)	2564	=item $success = $client->query ($flags, "text", \&cb)
1793		2565
1794	Queues a query to the client, calling the given callback with	2566	Queues a query to the client, calling the given callback with
1795	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2567	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1796	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2568	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1797		2569
1798	Queries can fail, so check the return code. Or don't, as queries will become	2570	Queries can fail, so check the return code. Or don't, as queries will
1799	reliable at some point in the future.	2571	become reliable at some point in the future.
1800		2572
1801	=cut	2573	=cut
1802		2574
1803	sub cf::client::query {	2575	sub cf::client::query {
1804	my ($self, $flags, $text, $cb) = @_;	2576	my ($self, $flags, $text, $cb) = @_;
…		…
1812	utf8::encode $text;	2584	utf8::encode $text;
1813	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2585	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1814		2586
1815	$self->send_packet ($self->{query_queue}[0][0])	2587	$self->send_packet ($self->{query_queue}[0][0])
1816	if @{ $self->{query_queue} } == 1;	2588	if @{ $self->{query_queue} } == 1;
		2589
		2590	1
1817	}	2591	}
1818		2592
1819	cf::client->attach (	2593	cf::client->attach (
		2594	on_connect => sub {
		2595	my ($ns) = @_;
		2596
		2597	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2598	},
1820	on_reply => sub {	2599	on_reply => sub {
1821	my ($ns, $msg) = @_;	2600	my ($ns, $msg) = @_;
1822		2601
1823	# this weird shuffling is so that direct followup queries	2602	# this weird shuffling is so that direct followup queries
1824	# get handled first	2603	# get handled first
1825	my $queue = delete $ns->{query_queue}	2604	my $queue = delete $ns->{query_queue}
1826	or return; # be conservative, not sure how that can happen, but we saw a crash here	2605	or return; # be conservative, not sure how that can happen, but we saw a crash here
1827		2606
1828	(shift @$queue)->[1]->($msg);	2607	(shift @$queue)->[1]->($msg);
		2608	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1829		2609
1830	push @{ $ns->{query_queue} }, @$queue;	2610	push @{ $ns->{query_queue} }, @$queue;
1831		2611
1832	if (@{ $ns->{query_queue} } == @$queue) {	2612	if (@{ $ns->{query_queue} } == @$queue) {
1833	if (@$queue) {	2613	if (@$queue) {
…		…
1835	} else {	2615	} else {
1836	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2616	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1837	}	2617	}
1838	}	2618	}
1839	},	2619	},
		2620	on_exticmd => sub {
		2621	my ($ns, $buf) = @_;
		2622
		2623	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2624
		2625	if (ref $msg) {
		2626	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2627	if (my %reply = $cb->($ns, $msg)) {
		2628	$reply{msgid} = $msg->{msgid};
		2629	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2630	}
		2631	}
		2632	} else {
		2633	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2634	}
		2635
		2636	cf::override;
		2637	},
1840	);	2638	);
1841		2639
1842	=item $client->async (\&cb)	2640	=item $client->async (\&cb)
1843		2641
1844	Create a new coroutine, running the specified callback. The coroutine will	2642	Create a new coroutine, running the specified callback. The coroutine will
…		…
1891		2689
1892	# here we export the classes and methods available to script code	2690	# here we export the classes and methods available to script code
1893		2691
1894	=pod	2692	=pod
1895		2693
1896	The following fucntions and emthods are available within a safe environment:	2694	The following functions and methods are available within a safe environment:
1897		2695
1898	cf::object contr pay_amount pay_player map	2696	cf::object
		2697	contr pay_amount pay_player map x y force_find force_add
		2698	insert remove
		2699
1899	cf::object::player player	2700	cf::object::player
1900	cf::player peaceful	2701	player
1901	cf::map trigger	2702
		2703	cf::player
		2704	peaceful
		2705
		2706	cf::map
		2707	trigger
1902		2708
1903	=cut	2709	=cut
1904		2710
1905	for (	2711	for (
1906	["cf::object" => qw(contr pay_amount pay_player map)],	2712	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2713	insert remove)],
1907	["cf::object::player" => qw(player)],	2714	["cf::object::player" => qw(player)],
1908	["cf::player" => qw(peaceful)],	2715	["cf::player" => qw(peaceful)],
1909	["cf::map" => qw(trigger)],	2716	["cf::map" => qw(trigger)],
1910	) {	2717	) {
1911	no strict 'refs';	2718	no strict 'refs';
…		…
1982	=back	2789	=back
1983		2790
1984	=cut	2791	=cut
1985		2792
1986	#############################################################################	2793	#############################################################################
		2794	# the server's init and main functions
1987		2795
1988	=head2 EXTENSION DATABASE SUPPORT	2796	sub load_facedata($) {
		2797	my ($path) = @_;
1989		2798
1990	Crossfire maintains a very simple database for extension use. It can	2799	warn "loading facedata from $path\n";
1991	currently store anything that can be serialised using Storable, which
1992	excludes objects.
1993		2800
1994	The parameter C<$family> should best start with the name of the extension	2801	my $facedata;
1995	using it, it should be unique.	2802	0 < aio_load $path, $facedata
		2803	or die "$path: $!";
1996		2804
1997	=over 4	2805	$facedata = Coro::Storable::thaw $facedata;
1998		2806
1999	=item $hashref = cf::db_get $family	2807	$facedata->{version} == 2
		2808	or cf::cleanup "$path: version mismatch, cannot proceed.";
2000		2809
2001	Return a hashref for use by the extension C<$family>, which can be
2002	modified. After modifications, you have to call C<cf::db_dirty> or
2003	C<cf::db_sync>.
2004
2005	=item $value = cf::db_get $family => $key
2006
2007	Returns a single value from the database
2008
2009	=item cf::db_put $family => $hashref
2010
2011	Stores the given family hashref into the database. Updates are delayed, if
2012	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2013
2014	=item cf::db_put $family => $key => $value
2015
2016	Stores the given C<$value> in the family hash. Updates are delayed, if you
2017	want the data to be synced to disk immediately, use C<cf::db_sync>.
2018
2019	=item cf::db_dirty
2020
2021	Marks the database as dirty, to be updated at a later time.
2022
2023	=item cf::db_sync
2024
2025	Immediately write the database to disk I<if it is dirty>.
2026
2027	=cut
2028
2029	our $DB;
2030
2031	{
2032	my $path = cf::localdir . "/database.pst";
2033
2034	sub db_load() {
2035	$DB = stat $path ? Storable::retrieve $path : { };
2036	}	2810	{
		2811	my $faces = $facedata->{faceinfo};
2037		2812
2038	my $pid;	2813	while (my ($face, $info) = each %$faces) {
		2814	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2815	cf::face::set_visibility $idx, $info->{visibility};
		2816	cf::face::set_magicmap $idx, $info->{magicmap};
		2817	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2818	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2039		2819
2040	sub db_save() {	2820	cf::cede_to_tick;
2041	waitpid $pid, 0 if $pid;
2042	if (0 == ($pid = fork)) {
2043	$DB->{_meta}{version} = 1;
2044	Storable::nstore $DB, "$path~";
2045	rename "$path~", $path;
2046	cf::_exit 0 if defined $pid;
2047	}
2048	}
2049
2050	my $dirty;
2051
2052	sub db_sync() {
2053	db_save if $dirty;
2054	undef $dirty;
2055	}
2056
2057	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2058	db_sync;
2059	});
2060
2061	sub db_dirty() {
2062	$dirty = 1;
2063	$idle->start;
2064	}
2065
2066	sub db_get($;$) {
2067	@_ >= 2
2068	? $DB->{$_[0]}{$_[1]}
2069	: ($DB->{$_[0]} ||= { })
2070	}
2071
2072	sub db_put($$;$) {
2073	if (@_ >= 3) {
2074	$DB->{$_[0]}{$_[1]} = $_[2];
2075	} else {
2076	$DB->{$_[0]} = $_[1];
2077	}
2078	db_dirty;
2079	}
2080
2081	cf::global->attach (
2082	prio => 10000,
2083	on_cleanup => sub {
2084	db_sync;
2085	},	2821	}
2086	);
2087	}
2088		2822
2089	#############################################################################	2823	while (my ($face, $info) = each %$faces) {
2090	# the server's main()	2824	next unless $info->{smooth};
		2825	my $idx = cf::face::find $face
		2826	or next;
		2827	if (my $smooth = cf::face::find $info->{smooth}) {
		2828	cf::face::set_smooth $idx, $smooth;
		2829	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2830	} else {
		2831	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2832	}
		2833
		2834	cf::cede_to_tick;
		2835	}
		2836	}
		2837
		2838	{
		2839	my $anims = $facedata->{animinfo};
		2840
		2841	while (my ($anim, $info) = each %$anims) {
		2842	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2843	cf::cede_to_tick;
		2844	}
		2845
		2846	cf::anim::invalidate_all; # d'oh
		2847	}
		2848
		2849	{
		2850	# TODO: for gcfclient pleasure, we should give resources
		2851	# that gcfclient doesn't grok a >10000 face index.
		2852	my $res = $facedata->{resource};
		2853	my $enc = JSON::XS->new->utf8->canonical;
		2854
		2855	while (my ($name, $info) = each %$res) {
		2856	my $meta = $enc->encode ({
		2857	name => $name,
		2858	type => $info->{type},
		2859	copyright => $info->{copyright}, #TODO#
		2860	});
		2861
		2862	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2863
		2864	if ($name =~ /\.jpg$/) {
		2865	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2866	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2867	} else {
		2868	my $data = pack "(w/a*)*", $meta, $info->{data};
		2869	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2870
		2871	cf::face::set_type $idx, 1;
		2872	cf::face::set_data $idx, 0, $data, $chk;
		2873	}
		2874
		2875	cf::cede_to_tick;
		2876	}
		2877	}
		2878
		2879	1
		2880	}
		2881
		2882	sub reload_regions {
		2883	load_resource_file "$MAPDIR/regions"
		2884	or die "unable to load regions file\n";
		2885
		2886	for (cf::region::list) {
		2887	$_->{match} = qr/$_->{match}/
		2888	if exists $_->{match};
		2889	}
		2890	}
		2891
		2892	sub reload_facedata {
		2893	load_facedata "$DATADIR/facedata"
		2894	or die "unable to load facedata\n";
		2895	}
		2896
		2897	sub reload_archetypes {
		2898	load_resource_file "$DATADIR/archetypes"
		2899	or die "unable to load archetypes\n";
		2900	#d# NEED to laod twice to resolve forward references
		2901	# this really needs to be done in an extra post-pass
		2902	# (which needs to be synchronous, so solve it differently)
		2903	load_resource_file "$DATADIR/archetypes"
		2904	or die "unable to load archetypes\n";
		2905	}
		2906
		2907	sub reload_treasures {
		2908	load_resource_file "$DATADIR/treasures"
		2909	or die "unable to load treasurelists\n";
		2910	}
		2911
		2912	sub reload_resources {
		2913	warn "reloading resource files...\n";
		2914
		2915	reload_regions;
		2916	reload_facedata;
		2917	#reload_archetypes;#d#
		2918	reload_archetypes;
		2919	reload_treasures;
		2920
		2921	warn "finished reloading resource files\n";
		2922	}
		2923
		2924	sub init {
		2925	reload_resources;
		2926	}
2091		2927
2092	sub cfg_load {	2928	sub cfg_load {
2093	open my $fh, "<:utf8", cf::confdir . "/config"	2929	open my $fh, "<:utf8", "$CONFDIR/config"
2094	or return;	2930	or return;
2095		2931
2096	local $/;	2932	local $/;
2097	*CFG = YAML::Syck::Load <$fh>;	2933	*CFG = YAML::Syck::Load <$fh>;
2098		2934
…		…
2112		2948
2113	sub main {	2949	sub main {
2114	# we must not ever block the main coroutine	2950	# we must not ever block the main coroutine
2115	local $Coro::idle = sub {	2951	local $Coro::idle = sub {
2116	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2952	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2953	(async {
2117	async { Event::one_event };	2954	Event::one_event;
		2955	})->prio (Coro::PRIO_MAX);
2118	};	2956	};
2119		2957
2120	cfg_load;	2958	cfg_load;
2121	db_load;	2959	db_init;
2122	load_extensions;	2960	load_extensions;
		2961
		2962	$TICK_WATCHER->start;
2123	Event::loop;	2963	Event::loop;
2124	}	2964	}
2125		2965
2126	#############################################################################	2966	#############################################################################
2127	# initialisation	2967	# initialisation and cleanup
2128		2968
		2969	# install some emergency cleanup handlers
		2970	BEGIN {
		2971	for my $signal (qw(INT HUP TERM)) {
		2972	Event->signal (
		2973	reentrant => 0,
		2974	data => WF_AUTOCANCEL,
		2975	signal => $signal,
		2976	prio => 0,
		2977	cb => sub {
		2978	cf::cleanup "SIG$signal";
		2979	},
		2980	);
		2981	}
		2982	}
		2983
		2984	sub write_runtime {
		2985	my $runtime = "$LOCALDIR/runtime";
		2986
		2987	# first touch the runtime file to show we are still running:
		2988	# the fsync below can take a very very long time.
		2989
		2990	IO::AIO::aio_utime $runtime, undef, undef;
		2991
		2992	my $guard = cf::lock_acquire "write_runtime";
		2993
		2994	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2995	or return;
		2996
		2997	my $value = $cf::RUNTIME + 90 + 10;
		2998	# 10 is the runtime save interval, for a monotonic clock
		2999	# 60 allows for the watchdog to kill the server.
		3000
		3001	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3002	and return;
		3003
		3004	# always fsync - this file is important
		3005	aio_fsync $fh
		3006	and return;
		3007
		3008	# touch it again to show we are up-to-date
		3009	aio_utime $fh, undef, undef;
		3010
		3011	close $fh
		3012	or return;
		3013
		3014	aio_rename "$runtime~", $runtime
		3015	and return;
		3016
		3017	warn "runtime file written.\n";
		3018
		3019	1
		3020	}
		3021
		3022	sub emergency_save() {
		3023	my $freeze_guard = cf::freeze_mainloop;
		3024
		3025	warn "enter emergency perl save\n";
		3026
		3027	cf::sync_job {
		3028	# use a peculiar iteration method to avoid tripping on perl
		3029	# refcount bugs in for. also avoids problems with players
		3030	# and maps saved/destroyed asynchronously.
		3031	warn "begin emergency player save\n";
		3032	for my $login (keys %cf::PLAYER) {
		3033	my $pl = $cf::PLAYER{$login} or next;
		3034	$pl->valid or next;
		3035	$pl->save;
		3036	}
		3037	warn "end emergency player save\n";
		3038
		3039	warn "begin emergency map save\n";
		3040	for my $path (keys %cf::MAP) {
		3041	my $map = $cf::MAP{$path} or next;
		3042	$map->valid or next;
		3043	$map->save;
		3044	}
		3045	warn "end emergency map save\n";
		3046
		3047	warn "begin emergency database checkpoint\n";
		3048	BDB::db_env_txn_checkpoint $DB_ENV;
		3049	warn "end emergency database checkpoint\n";
		3050	};
		3051
		3052	warn "leave emergency perl save\n";
		3053	}
		3054
		3055	sub post_cleanup {
		3056	my ($make_core) = @_;
		3057
		3058	warn Carp::longmess "post_cleanup backtrace"
		3059	if $make_core;
		3060	}
		3061
2129	sub reload() {	3062	sub do_reload_perl() {
2130	# can/must only be called in main	3063	# can/must only be called in main
2131	if ($Coro::current != $Coro::main) {	3064	if ($Coro::current != $Coro::main) {
2132	warn "can only reload from main coroutine\n";	3065	warn "can only reload from main coroutine";
2133	return;	3066	return;
2134	}	3067	}
2135		3068
2136	warn "reloading...";	3069	warn "reloading...";
2137		3070
2138	my $guard = freeze_mainloop;	3071	warn "entering sync_job";
		3072
		3073	cf::sync_job {
		3074	cf::write_runtime; # external watchdog should not bark
2139	cf::emergency_save;	3075	cf::emergency_save;
		3076	cf::write_runtime; # external watchdog should not bark
2140		3077
2141	eval {	3078	warn "syncing database to disk";
		3079	BDB::db_env_txn_checkpoint $DB_ENV;
		3080
2142	# if anything goes wrong in here, we should simply crash as we already saved	3081	# if anything goes wrong in here, we should simply crash as we already saved
2143		3082
2144	# cancel all watchers	3083	warn "cancelling all WF_AUTOCANCEL watchers";
2145	for (Event::all_watchers) {	3084	for (Event::all_watchers) {
2146	$_->cancel if $_->data & WF_AUTOCANCEL;	3085	$_->cancel if $_->data & WF_AUTOCANCEL;
2147	}	3086	}
2148		3087
		3088	warn "flushing outstanding aio requests";
		3089	for (;;) {
		3090	BDB::flush;
		3091	IO::AIO::flush;
		3092	Coro::cede;
		3093	last unless IO::AIO::nreqs || BDB::nreqs;
		3094	warn "iterate...";
		3095	}
		3096
		3097	++$RELOAD;
		3098
2149	# cancel all extension coros	3099	warn "cancelling all extension coros";
2150	$_->cancel for values %EXT_CORO;	3100	$_->cancel for values %EXT_CORO;
2151	%EXT_CORO = ();	3101	%EXT_CORO = ();
2152		3102
2153	# unload all extensions	3103	warn "removing commands";
2154	for (@exts) {	3104	%COMMAND = ();
		3105
		3106	warn "removing ext/exti commands";
		3107	%EXTCMD = ();
		3108	%EXTICMD = ();
		3109
		3110	warn "unloading/nuking all extensions";
		3111	for my $pkg (@EXTS) {
2155	warn "unloading <$_>";	3112	warn "... unloading $pkg";
2156	unload_extension $_;	3113
		3114	if (my $cb = $pkg->can ("unload")) {
		3115	eval {
		3116	$cb->($pkg);
		3117	1
		3118	} or warn "$pkg unloaded, but with errors: $@";
2157	}	3119	}
2158		3120
		3121	warn "... nuking $pkg";
		3122	Symbol::delete_package $pkg;
		3123	}
		3124
2159	# unload all modules loaded from $LIBDIR	3125	warn "unloading all perl modules loaded from $LIBDIR";
2160	while (my ($k, $v) = each %INC) {	3126	while (my ($k, $v) = each %INC) {
2161	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3127	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2162		3128
2163	warn "removing <$k>";	3129	warn "... unloading $k";
2164	delete $INC{$k};	3130	delete $INC{$k};
2165		3131
2166	$k =~ s/\.pm$//;	3132	$k =~ s/\.pm$//;
2167	$k =~ s/\//::/g;	3133	$k =~ s/\//::/g;
2168		3134
…		…
2171	}	3137	}
2172		3138
2173	Symbol::delete_package $k;	3139	Symbol::delete_package $k;
2174	}	3140	}
2175		3141
2176	# sync database to disk
2177	cf::db_sync;
2178	IO::AIO::flush;
2179
2180	# get rid of safe::, as good as possible	3142	warn "getting rid of safe::, as good as possible";
2181	Symbol::delete_package "safe::$_"	3143	Symbol::delete_package "safe::$_"
2182	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3144	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2183		3145
2184	# remove register_script_function callbacks
2185	# TODO
2186
2187	# unload cf.pm "a bit"	3146	warn "unloading cf.pm \"a bit\"";
2188	delete $INC{"cf.pm"};	3147	delete $INC{"cf.pm"};
		3148	delete $INC{"cf/pod.pm"};
2189		3149
2190	# don't, removes xs symbols, too,	3150	# don't, removes xs symbols, too,
2191	# and global variables created in xs	3151	# and global variables created in xs
2192	#Symbol::delete_package __PACKAGE__;	3152	#Symbol::delete_package __PACKAGE__;
2193		3153
2194	# reload cf.pm	3154	warn "unload completed, starting to reload now";
		3155
2195	warn "reloading cf.pm";	3156	warn "reloading cf.pm";
2196	require cf;	3157	require cf;
2197	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3158	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2198		3159
2199	# load config and database again	3160	warn "loading config and database again";
2200	cf::cfg_load;	3161	cf::cfg_load;
2201	cf::db_load;
2202		3162
2203	# load extensions
2204	warn "load extensions";	3163	warn "loading extensions";
2205	cf::load_extensions;	3164	cf::load_extensions;
2206		3165
2207	# reattach attachments to objects	3166	warn "reattaching attachments to objects/players";
2208	warn "reattach";	3167	_global_reattach; # objects, sockets
2209	_global_reattach;	3168	warn "reattaching attachments to maps";
2210	reattach $_ for values %MAP;	3169	reattach $_ for values %MAP;
2211	};	3170	warn "reattaching attachments to players";
		3171	reattach $_ for values %PLAYER;
2212		3172
2213	if ($@) {	3173	warn "leaving sync_job";
		3174
		3175	1
		3176	} or do {
2214	warn $@;	3177	warn $@;
2215	warn "error while reloading, exiting.";	3178	warn "error while reloading, exiting.";
2216	exit 1;	3179	exit 1;
2217	}	3180	};
2218		3181
2219	warn "reloaded successfully";	3182	warn "reloaded";
2220	};	3183	};
2221		3184
2222	#############################################################################	3185	our $RELOAD_WATCHER; # used only during reload
2223		3186
2224	unless ($LINK_MAP) {	3187	sub reload_perl() {
2225	$LINK_MAP = cf::map::new;	3188	# doing reload synchronously and two reloads happen back-to-back,
		3189	# coro crashes during coro_state_free->destroy here.
2226		3190
2227	$LINK_MAP->width (41);	3191	$RELOAD_WATCHER ||= Event->timer (
2228	$LINK_MAP->height (41);	3192	reentrant => 0,
2229	$LINK_MAP->alloc;
2230	$LINK_MAP->path ("{link}");
2231	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2232	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2233
2234	# dirty hack because... archetypes are not yet loaded
2235	Event->timer (
2236	after => 10,	3193	after => 0,
		3194	data => WF_AUTOCANCEL,
2237	cb => sub {	3195	cb => sub {
2238	$_[0]->w->cancel;	3196	do_reload_perl;
2239		3197	undef $RELOAD_WATCHER;
2240	# provide some exits "home"
2241	my $exit = cf::object::new "exit";
2242
2243	$exit->slaying ($EMERGENCY_POSITION->[0]);
2244	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2245	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2246
2247	$LINK_MAP->insert ($exit->clone, 19, 19);
2248	$LINK_MAP->insert ($exit->clone, 19, 20);
2249	$LINK_MAP->insert ($exit->clone, 19, 21);
2250	$LINK_MAP->insert ($exit->clone, 20, 19);
2251	$LINK_MAP->insert ($exit->clone, 20, 21);
2252	$LINK_MAP->insert ($exit->clone, 21, 19);
2253	$LINK_MAP->insert ($exit->clone, 21, 20);
2254	$LINK_MAP->insert ($exit->clone, 21, 21);
2255
2256	$exit->destroy;
2257	});	3198	},
2258		3199	);
2259	$LINK_MAP->{deny_save} = 1;
2260	$LINK_MAP->{deny_reset} = 1;
2261
2262	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2263	}	3200	}
2264
2265	register "<global>", __PACKAGE__;
2266		3201
2267	register_command "reload" => sub {	3202	register_command "reload" => sub {
2268	my ($who, $arg) = @_;	3203	my ($who, $arg) = @_;
2269		3204
2270	if ($who->flag (FLAG_WIZ)) {	3205	if ($who->flag (FLAG_WIZ)) {
2271	$who->message ("start of reload.");
2272	reload;
2273	$who->message ("end of reload.");	3206	$who->message ("reloading server.");
		3207	async { reload_perl };
2274	}	3208	}
2275	};	3209	};
2276		3210
2277	unshift @INC, $LIBDIR;	3211	unshift @INC, $LIBDIR;
2278		3212
		3213	my $bug_warning = 0;
		3214
		3215	our @WAIT_FOR_TICK;
		3216	our @WAIT_FOR_TICK_BEGIN;
		3217
		3218	sub wait_for_tick {
		3219	return unless $TICK_WATCHER->is_active;
		3220	return if $Coro::current == $Coro::main;
		3221
		3222	my $signal = new Coro::Signal;
		3223	push @WAIT_FOR_TICK, $signal;
		3224	$signal->wait;
		3225	}
		3226
		3227	sub wait_for_tick_begin {
		3228	return unless $TICK_WATCHER->is_active;
		3229	return if $Coro::current == $Coro::main;
		3230
		3231	my $signal = new Coro::Signal;
		3232	push @WAIT_FOR_TICK_BEGIN, $signal;
		3233	$signal->wait;
		3234	}
		3235
		3236	my $min = 1e6;#d#
		3237	my $avg = 10;
2279	$TICK_WATCHER = Event->timer (	3238	$TICK_WATCHER = Event->timer (
2280	reentrant => 0,	3239	reentrant => 0,
		3240	parked => 1,
2281	prio => 0,	3241	prio => 0,
2282	at => $NEXT_TICK || $TICK,	3242	at => $NEXT_TICK || $TICK,
2283	data => WF_AUTOCANCEL,	3243	data => WF_AUTOCANCEL,
2284	cb => sub {	3244	cb => sub {
		3245	if ($Coro::current != $Coro::main) {
		3246	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3247	unless ++$bug_warning > 10;
		3248	return;
		3249	}
		3250
		3251	$NOW = $tick_start = Event::time;
		3252
2285	cf::server_tick; # one server iteration	3253	cf::server_tick; # one server iteration
		3254
		3255	0 && sync_job {#d#
		3256	for(1..10) {
		3257	my $t = Event::time;
		3258	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3259	or die;
		3260
		3261	$map->width (50);
		3262	$map->height (50);
		3263	$map->alloc;
		3264	$map->_load_objects ("/tmp/x.map", 1);
		3265	my $t = Event::time - $t;
		3266
		3267	#next unless $t < 0.0013;#d#
		3268	if ($t < $min) {
		3269	$min = $t;
		3270	}
		3271	$avg = $avg * 0.99 + $t * 0.01;
		3272	}
		3273	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3274	exit 0;
		3275	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3276	};
		3277
2286	$RUNTIME += $TICK;	3278	$RUNTIME += $TICK;
2287	$NEXT_TICK += $TICK;	3279	$NEXT_TICK += $TICK;
2288		3280
		3281	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3282	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3283	Coro::async_pool {
		3284	write_runtime
		3285	or warn "ERROR: unable to write runtime file: $!";
		3286	};
		3287	}
		3288
		3289	# my $AFTER = Event::time;
		3290	# warn $AFTER - $NOW;#d#
		3291
		3292	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3293	$sig->send;
		3294	}
		3295	while (my $sig = shift @WAIT_FOR_TICK) {
		3296	$sig->send;
		3297	}
		3298
		3299	$NOW = Event::time;
		3300
2289	# if we are delayed by four ticks or more, skip them all	3301	# if we are delayed by four ticks or more, skip them all
2290	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3302	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2291		3303
2292	$TICK_WATCHER->at ($NEXT_TICK);	3304	$TICK_WATCHER->at ($NEXT_TICK);
2293	$TICK_WATCHER->start;	3305	$TICK_WATCHER->start;
		3306
		3307	$LOAD = ($NOW - $tick_start) / $TICK;
		3308	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3309
		3310	_post_tick;
		3311
		3312
2294	},	3313	},
2295	);	3314	);
2296		3315
		3316	{
2297	IO::AIO::max_poll_time $TICK * 0.2;	3317	BDB::max_poll_time $TICK * 0.1;
2298		3318	$BDB_POLL_WATCHER = Event->io (
2299	Event->io (	3319	reentrant => 0,
2300	fd => IO::AIO::poll_fileno,	3320	fd => BDB::poll_fileno,
2301	poll => 'r',	3321	poll => 'r',
2302	prio => 5,	3322	prio => 0,
2303	data => WF_AUTOCANCEL,
2304	cb => \&IO::AIO::poll_cb,
2305	);
2306
2307	Event->timer (
2308	data => WF_AUTOCANCEL,	3323	data => WF_AUTOCANCEL,
2309	after => 0,	3324	cb => \&BDB::poll_cb,
2310	interval => 10,	3325	);
2311	cb => sub {	3326	BDB::min_parallel 8;
2312	(Coro::unblock_sub {	3327
2313	write_runtime	3328	BDB::set_sync_prepare {
2314	or warn "ERROR: unable to write runtime file: $!";	3329	my $status;
		3330	my $current = $Coro::current;
		3331	(
		3332	sub {
		3333	$status = $!;
		3334	$current->ready; undef $current;
		3335	},
		3336	sub {
		3337	Coro::schedule while defined $current;
		3338	$! = $status;
		3339	},
		3340	)
		3341	};
		3342
		3343	unless ($DB_ENV) {
		3344	$DB_ENV = BDB::db_env_create;
		3345
		3346	cf::sync_job {
		3347	eval {
		3348	BDB::db_env_open
		3349	$DB_ENV,
		3350	$BDBDIR,
		3351	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3352	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3353	0666;
		3354
		3355	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3356
		3357	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3358	$DB_ENV->set_lk_detect;
		3359	};
		3360
		3361	cf::cleanup "db_env_open(db): $@" if $@;
2315	})->();	3362	};
2316	},	3363	}
2317	);	3364	}
		3365
		3366	{
		3367	IO::AIO::min_parallel 8;
		3368
		3369	undef $Coro::AIO::WATCHER;
		3370	IO::AIO::max_poll_time $TICK * 0.1;
		3371	$AIO_POLL_WATCHER = Event->io (
		3372	reentrant => 0,
		3373	data => WF_AUTOCANCEL,
		3374	fd => IO::AIO::poll_fileno,
		3375	poll => 'r',
		3376	prio => 6,
		3377	cb => \&IO::AIO::poll_cb,
		3378	);
		3379	}
		3380
		3381	my $_log_backtrace;
		3382
		3383	sub _log_backtrace {
		3384	my ($msg, @addr) = @_;
		3385
		3386	$msg =~ s/\n//;
		3387
		3388	# limit the # of concurrent backtraces
		3389	if ($_log_backtrace < 2) {
		3390	++$_log_backtrace;
		3391	async {
		3392	my @bt = fork_call {
		3393	@addr = map { sprintf "%x", $_ } @addr;
		3394	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3395	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3396	or die "addr2line: $!";
		3397
		3398	my @funcs;
		3399	my @res = <$fh>;
		3400	chomp for @res;
		3401	while (@res) {
		3402	my ($func, $line) = splice @res, 0, 2, ();
		3403	push @funcs, "[$func] $line";
		3404	}
		3405
		3406	@funcs
		3407	};
		3408
		3409	LOG llevInfo, "[ABT] $msg\n";
		3410	LOG llevInfo, "[ABT] $_\n" for @bt;
		3411	--$_log_backtrace;
		3412	};
		3413	} else {
		3414	LOG llevInfo, "[ABT] $msg\n";
		3415	LOG llevInfo, "[ABT] [suppressed]\n";
		3416	}
		3417	}
		3418
		3419	# load additional modules
		3420	use cf::pod;
2318		3421
2319	END { cf::emergency_save }	3422	END { cf::emergency_save }
2320		3423
2321	1	3424	1
2322		3425

Diff Legend

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