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

Diff Legend

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