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

Diff Legend

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