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.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.323 by root, Sat Jul 28 12:02:58 2007 UTC

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

Diff Legend

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