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

Diff Legend

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