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.95 by root, Fri Dec 22 02:04:20 2006 UTC vs.
Revision 1.297 by root, Thu Jul 5 08:10:30 2007 UTC

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

Diff Legend

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