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.292 by root, Tue Jul 3 00:54:57 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	1 while s/\s*\n\s*\n\s*/\n/;
		1418
		1419	$_
		1420	}
		1421
		1422	sub hintmode {
		1423	$_[0]{hintmode} = $_[1] if @_ > 1;
		1424	$_[0]{hintmode}
		1425	}
		1426
		1427	=item $player->ext_reply ($msgid, %msg)
		1428
		1429	Sends an ext reply to the player.
		1430
		1431	=cut
		1432
		1433	sub ext_reply($$%) {
		1434	my ($self, $id, %msg) = @_;
		1435
		1436	$msg{msgid} = $id;
		1437	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
		1438	}
		1439
		1440	=item $player->ext_event ($type, %msg)
		1441
		1442	Sends an ext event to the client.
		1443
		1444	=cut
		1445
		1446	sub ext_event($$%) {
		1447	my ($self, $type, %msg) = @_;
		1448
		1449	$self->ns->ext_event ($type, %msg);
		1450	}
		1451
		1452	=head3 cf::region
		1453
		1454	=over 4
		1455
		1456	=cut
		1457
		1458	package cf::region;
		1459
		1460	=item cf::region::find_by_path $path
		1461
		1462	Tries to decuce the likely region for a map knowing only its path.
		1463
		1464	=cut
		1465
		1466	sub find_by_path($) {
		1467	my ($path) = @_;
		1468
		1469	my ($match, $specificity);
		1470
		1471	for my $region (list) {
		1472	if ($region->match && $path =~ $region->match) {
		1473	($match, $specificity) = ($region, $region->specificity)
		1474	if $region->specificity > $specificity;
		1475	}
		1476	}
		1477
		1478	$match
		1479	}
		1480
		1481	=back
		1482
		1483	=head3 cf::map
		1484
		1485	=over 4
		1486
		1487	=cut
		1488
		1489	package cf::map;
		1490
		1491	use Fcntl;
		1492	use Coro::AIO;
		1493
		1494	use overload
		1495	'""' => \&as_string,
		1496	fallback => 1;
		1497
		1498	our $MAX_RESET = 3600;
		1499	our $DEFAULT_RESET = 3000;
		1500
		1501	sub generate_random_map {
		1502	my ($self, $rmp) = @_;
		1503	# mit "rum" bekleckern, nicht
		1504	$self->_create_random_map (
		1505	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1506	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1507	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1508	$rmp->{exit_on_final_map},
		1509	$rmp->{xsize}, $rmp->{ysize},
		1510	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1511	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1512	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1513	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1514	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1515	(cf::region::find $rmp->{region}), $rmp->{custom}
		1516	)
		1517	}
		1518
		1519	=item cf::map->register ($regex, $prio)
		1520
		1521	Register a handler for the map path matching the given regex at the
		1522	givne priority (higher is better, built-in handlers have priority 0, the
		1523	default).
		1524
		1525	=cut
		1526
635	sub register {	1527	sub register {
		1528	my (undef, $regex, $prio) = @_;
		1529	my $pkg = caller;
		1530
		1531	no strict;
		1532	push @{"$pkg\::ISA"}, __PACKAGE__;
		1533
		1534	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1535	}
		1536
		1537	# also paths starting with '/'
		1538	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1539
		1540	sub thawer_merge {
636	my ($base, $pkg) = @_;	1541	my ($self, $merge) = @_;
637		1542
638	#TODO	1543	# we have to keep some variables in memory intact
639	}	1544	local $self->{path};
		1545	local $self->{load_path};
640		1546
641	sub load_extension {	1547	$self->SUPER::thawer_merge ($merge);
		1548	}
		1549
		1550	sub normalise {
642	my ($path) = @_;	1551	my ($path, $base) = @_;
643		1552
644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1553	$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		1554
650	warn "loading '$path' into '$pkg'\n";	1555	$path =~ s/\.map$//;
651		1556
652	open my $fh, "<:utf8", $path	1557	# map plan:
653	or die "$path: $!";	1558	#
		1559	# /! non-realised random map exit (special hack!)
		1560	# {... are special paths that are not being touched
		1561	# ?xxx/... are special absolute paths
		1562	# ?random/... random maps
		1563	# /... normal maps
		1564	# ~user/... per-player map of a specific user
654		1565
655	my $source =	1566	$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		1567
661	eval $source	1568	# treat it as relative path if it starts with
662	or die $@ ? "$path: $@\n"	1569	# something that looks reasonable
663	: "extension disabled.\n";	1570	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1571	$base or Carp::carp "normalise called with relative path and no base: '$path'";
664		1572
665	push @exts, $pkg;	1573	$base =~ s{[^/]+/?$}{};
666	$ext_pkg{$base} = $pkg;	1574	$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	# }	1575	}
684		1576
685	# remove commands	1577	for ($path) {
686	for my $name (keys %COMMAND) {	1578	redo if s{//}{/};
687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1579	redo if s{/\.?/}{/};
		1580	redo if s{/[^/]+/\.\./}{/};
		1581	}
688		1582
689	if (@cb) {	1583	$path
690	$COMMAND{$name} = \@cb;	1584	}
		1585
		1586	sub new_from_path {
		1587	my (undef, $path, $base) = @_;
		1588
		1589	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1590
		1591	$path = normalise $path, $base;
		1592
		1593	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1594	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1595	my $self = bless cf::map::new, $pkg;
		1596	$self->{path} = $path; $self->path ($path);
		1597	$self->init; # pass $1 etc.
		1598	return $self;
		1599	}
		1600	}
		1601
		1602	Carp::carp "unable to resolve path '$path' (base '$base').";
		1603	()
		1604	}
		1605
		1606	sub init {
		1607	my ($self) = @_;
		1608
		1609	$self
		1610	}
		1611
		1612	sub as_string {
		1613	my ($self) = @_;
		1614
		1615	"$self->{path}"
		1616	}
		1617
		1618	# the displayed name, this is a one way mapping
		1619	sub visible_name {
		1620	&as_string
		1621	}
		1622
		1623	# the original (read-only) location
		1624	sub load_path {
		1625	my ($self) = @_;
		1626
		1627	"$MAPDIR/$self->{path}.map"
		1628	}
		1629
		1630	# the temporary/swap location
		1631	sub save_path {
		1632	my ($self) = @_;
		1633
		1634	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1635	"$TMPDIR/$path.map"
		1636	}
		1637
		1638	# the unique path, undef == no special unique path
		1639	sub uniq_path {
		1640	my ($self) = @_;
		1641
		1642	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1643	"$UNIQUEDIR/$path"
		1644	}
		1645
		1646	# and all this just because we cannot iterate over
		1647	# all maps in C++...
		1648	sub change_all_map_light {
		1649	my ($change) = @_;
		1650
		1651	$_->change_map_light ($change)
		1652	for grep $_->outdoor, values %cf::MAP;
		1653	}
		1654
		1655	sub decay_objects {
		1656	my ($self) = @_;
		1657
		1658	return if $self->{deny_reset};
		1659
		1660	$self->do_decay_objects;
		1661	}
		1662
		1663	sub unlink_save {
		1664	my ($self) = @_;
		1665
		1666	utf8::encode (my $save = $self->save_path);
		1667	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1668	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1669	}
		1670
		1671	sub load_header_from($) {
		1672	my ($self, $path) = @_;
		1673
		1674	utf8::encode $path;
		1675	#aio_open $path, O_RDONLY, 0
		1676	# or return;
		1677
		1678	$self->_load_header ($path)
		1679	or return;
		1680
		1681	$self->{load_path} = $path;
		1682
		1683	1
		1684	}
		1685
		1686	sub load_header_orig {
		1687	my ($self) = @_;
		1688
		1689	$self->load_header_from ($self->load_path)
		1690	}
		1691
		1692	sub load_header_temp {
		1693	my ($self) = @_;
		1694
		1695	$self->load_header_from ($self->save_path)
		1696	}
		1697
		1698	sub prepare_temp {
		1699	my ($self) = @_;
		1700
		1701	$self->last_access ((delete $self->{last_access})
		1702	|| $cf::RUNTIME); #d#
		1703	# safety
		1704	$self->{instantiate_time} = $cf::RUNTIME
		1705	if $self->{instantiate_time} > $cf::RUNTIME;
		1706	}
		1707
		1708	sub prepare_orig {
		1709	my ($self) = @_;
		1710
		1711	$self->{load_original} = 1;
		1712	$self->{instantiate_time} = $cf::RUNTIME;
		1713	$self->last_access ($cf::RUNTIME);
		1714	$self->instantiate;
		1715	}
		1716
		1717	sub load_header {
		1718	my ($self) = @_;
		1719
		1720	if ($self->load_header_temp) {
		1721	$self->prepare_temp;
691	} else {	1722	} else {
692	delete $COMMAND{$name};	1723	$self->load_header_orig
693	}	1724	or return;
		1725	$self->prepare_orig;
		1726	}
		1727
		1728	$self->{deny_reset} = 1
		1729	if $self->no_reset;
		1730
		1731	$self->default_region (cf::region::find_by_path $self->{path})
		1732	unless $self->default_region;
		1733
694	}	1734	1
		1735	}
695		1736
696	# remove extcmds	1737	sub find;
697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1738	sub find {
698	delete $EXTCMD{$name};	1739	my ($path, $origin) = @_;
		1740
		1741	$path = normalise $path, $origin && $origin->path;
		1742
		1743	cf::lock_wait "map_find:$path";
		1744
		1745	$cf::MAP{$path} || do {
		1746	my $guard = cf::lock_acquire "map_find:$path";
		1747	my $map = new_from_path cf::map $path
		1748	or return;
		1749
		1750	$map->{last_save} = $cf::RUNTIME;
		1751
		1752	$map->load_header
		1753	or return;
		1754
		1755	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1756	# doing this can freeze the server in a sync job, obviously
		1757	#$cf::WAIT_FOR_TICK->wait;
		1758	$map->reset;
		1759	undef $guard;
		1760	return find $path;
		1761	}
		1762
		1763	$cf::MAP{$path} = $map
		1764	}
		1765	}
		1766
		1767	sub pre_load { }
		1768	sub post_load { }
		1769
		1770	sub load {
		1771	my ($self) = @_;
		1772
		1773	local $self->{deny_reset} = 1; # loading can take a long time
		1774
		1775	my $path = $self->{path};
		1776
699	}	1777	{
		1778	my $guard = cf::lock_acquire "map_load:$path";
700		1779
701	if (my $cb = $pkg->can ("unload")) {	1780	return if $self->in_memory != cf::MAP_SWAPPED;
702	eval {	1781
703	$cb->($pkg);	1782	$self->in_memory (cf::MAP_LOADING);
		1783
		1784	$self->alloc;
		1785
		1786	$self->pre_load;
		1787	Coro::cede;
		1788
		1789	$self->_load_objects ($self->{load_path}, 1)
		1790	or return;
		1791
		1792	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1793	if delete $self->{load_original};
		1794
		1795	if (my $uniq = $self->uniq_path) {
		1796	utf8::encode $uniq;
		1797	if (aio_open $uniq, O_RDONLY, 0) {
		1798	$self->clear_unique_items;
		1799	$self->_load_objects ($uniq, 0);
704	1	1800	}
705	} or warn "$pkg unloaded, but with errors: $@";	1801	}
706	}
707		1802
708	Symbol::delete_package $pkg;	1803	Coro::cede;
709	}	1804	# now do the right thing for maps
		1805	$self->link_multipart_objects;
		1806	$self->difficulty ($self->estimate_difficulty)
		1807	unless $self->difficulty;
		1808	Coro::cede;
710		1809
711	sub load_extensions {	1810	unless ($self->{deny_activate}) {
712	for my $ext (<$LIBDIR/*.ext>) {	1811	$self->decay_objects;
713	next unless -r $ext;	1812	$self->fix_auto_apply;
714	eval {	1813	$self->update_buttons;
715	load_extension $ext;	1814	Coro::cede;
716	1	1815	$self->set_darkness_map;
717	} or warn "$ext not loaded: $@";	1816	Coro::cede;
718	}	1817	$self->activate;
719	}	1818	}
720		1819
721	#############################################################################	1820	$self->in_memory (cf::MAP_IN_MEMORY);
722	# load/save/clean perl data associated with a map	1821	}
723		1822
724	*cf::mapsupport::on_clean = sub {	1823	$self->post_load;
		1824	}
		1825
		1826	sub customise_for {
		1827	my ($self, $ob) = @_;
		1828
		1829	return find "~" . $ob->name . "/" . $self->{path}
		1830	if $self->per_player;
		1831
		1832	# return find "?party/" . $ob->name . "/" . $self->{path}
		1833	# if $self->per_party;
		1834
		1835	$self
		1836	}
		1837
		1838	# find and load all maps in the 3x3 area around a map
		1839	sub load_diag {
725	my ($map) = @_;	1840	my ($map) = @_;
726		1841
727	my $path = $map->tmpname;	1842	my @diag; # diagonal neighbours
728	defined $path or return;
729		1843
730	unlink "$path.pst";	1844	for (0 .. 3) {
731	};	1845	my $neigh = $map->tile_path ($_)
		1846	or next;
		1847	$neigh = find $neigh, $map
		1848	or next;
		1849	$neigh->load;
732		1850
733	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1851	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1852	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1853	}
734		1854
735	#############################################################################	1855	for (@diag) {
736	# load/save perl data associated with player->ob objects	1856	my $neigh = find @$_
737		1857	or next;
738	sub all_objects(@) {	1858	$neigh->load;
739	@_, map all_objects ($_->inv), @_	1859	}
740	}	1860	}
741		1861
742	# TODO: compatibility cruft, remove when no longer needed	1862	sub find_sync {
743	cf::player->attach (	1863	my ($path, $origin) = @_;
744	on_load => sub {
745	my ($pl, $path) = @_;
746		1864
747	for my $o (all_objects $pl->ob) {	1865	cf::sync_job { find $path, $origin }
748	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1866	}
749	$o->set_ob_key_value ("_perl_data");
750		1867
751	%$o = %{ Storable::thaw pack "H*", $value };	1868	sub do_load_sync {
		1869	my ($map) = @_;
		1870
		1871	cf::sync_job { $map->load };
		1872	}
		1873
		1874	our %MAP_PREFETCH;
		1875	our $MAP_PREFETCHER = undef;
		1876
		1877	sub find_async {
		1878	my ($path, $origin) = @_;
		1879
		1880	$path = normalise $path, $origin && $origin->{path};
		1881
		1882	if (my $map = $cf::MAP{$path}) {
		1883	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1884	}
		1885
		1886	undef $MAP_PREFETCH{$path};
		1887	$MAP_PREFETCHER ||= cf::async {
		1888	while (%MAP_PREFETCH) {
		1889	for my $path (keys %MAP_PREFETCH) {
		1890	my $map = find $path
		1891	or next;
		1892	$map->load;
		1893
		1894	delete $MAP_PREFETCH{$path};
752	}	1895	}
753	}	1896	}
		1897	undef $MAP_PREFETCHER;
		1898	};
		1899	$MAP_PREFETCHER->prio (6);
		1900
		1901	()
		1902	}
		1903
		1904	sub save {
		1905	my ($self) = @_;
		1906
		1907	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1908
		1909	$self->{last_save} = $cf::RUNTIME;
		1910
		1911	return unless $self->dirty;
		1912
		1913	my $save = $self->save_path; utf8::encode $save;
		1914	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1915
		1916	$self->{load_path} = $save;
		1917
		1918	return if $self->{deny_save};
		1919
		1920	local $self->{last_access} = $self->last_access;#d#
		1921
		1922	cf::async {
		1923	$_->contr->save for $self->players;
		1924	};
		1925
		1926	if ($uniq) {
		1927	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1928	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1929	} else {
		1930	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754	},	1931	}
755	);	1932	}
756		1933
757	#############################################################################	1934	sub swap_out {
		1935	my ($self) = @_;
758		1936
759	=head2 CORE EXTENSIONS	1937	# save first because save cedes
		1938	$self->save;
760		1939
761	Functions and methods that extend core crossfire objects.	1940	my $lock = cf::lock_acquire "map_data:" . $self->path;
762		1941
763	=head3 cf::player	1942	return if $self->players;
		1943	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1944	return if $self->{deny_save};
		1945
		1946	$self->clear;
		1947	$self->in_memory (cf::MAP_SWAPPED);
		1948	}
		1949
		1950	sub reset_at {
		1951	my ($self) = @_;
		1952
		1953	# TODO: safety, remove and allow resettable per-player maps
		1954	return 1e99 if $self->{deny_reset};
		1955
		1956	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1957	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1958
		1959	$time + $to
		1960	}
		1961
		1962	sub should_reset {
		1963	my ($self) = @_;
		1964
		1965	$self->reset_at <= $cf::RUNTIME
		1966	}
		1967
		1968	sub reset {
		1969	my ($self) = @_;
		1970
		1971	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1972
		1973	return if $self->players;
		1974
		1975	warn "resetting map ", $self->path;
		1976
		1977	$self->in_memory (cf::MAP_SWAPPED);
		1978
		1979	# need to save uniques path
		1980	unless ($self->{deny_save}) {
		1981	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1982
		1983	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1984	if $uniq;
		1985	}
		1986
		1987	delete $cf::MAP{$self->path};
		1988
		1989	$self->clear;
		1990
		1991	$_->clear_links_to ($self) for values %cf::MAP;
		1992
		1993	$self->unlink_save;
		1994	$self->destroy;
		1995	}
		1996
		1997	my $nuke_counter = "aaaa";
		1998
		1999	sub nuke {
		2000	my ($self) = @_;
		2001
		2002	delete $cf::MAP{$self->path};
		2003
		2004	$self->unlink_save;
		2005
		2006	bless $self, "cf::map";
		2007	delete $self->{deny_reset};
		2008	$self->{deny_save} = 1;
		2009	$self->reset_timeout (1);
		2010	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2011
		2012	$cf::MAP{$self->path} = $self;
		2013
		2014	$self->reset; # polite request, might not happen
		2015	}
		2016
		2017	=item $maps = cf::map::tmp_maps
		2018
		2019	Returns an arrayref with all map paths of currently instantiated and saved
		2020	maps. May block.
		2021
		2022	=cut
		2023
		2024	sub tmp_maps() {
		2025	[
		2026	map {
		2027	utf8::decode $_;
		2028	/\.map$/
		2029	? normalise $_
		2030	: ()
		2031	} @{ aio_readdir $TMPDIR or [] }
		2032	]
		2033	}
		2034
		2035	=item $maps = cf::map::random_maps
		2036
		2037	Returns an arrayref with all map paths of currently instantiated and saved
		2038	random maps. May block.
		2039
		2040	=cut
		2041
		2042	sub random_maps() {
		2043	[
		2044	map {
		2045	utf8::decode $_;
		2046	/\.map$/
		2047	? normalise "?random/$_"
		2048	: ()
		2049	} @{ aio_readdir $RANDOMDIR or [] }
		2050	]
		2051	}
		2052
		2053	=item cf::map::unique_maps
		2054
		2055	Returns an arrayref of paths of all shared maps that have
		2056	instantiated unique items. May block.
		2057
		2058	=cut
		2059
		2060	sub unique_maps() {
		2061	[
		2062	map {
		2063	utf8::decode $_;
		2064	/\.map$/
		2065	? normalise $_
		2066	: ()
		2067	} @{ aio_readdir $UNIQUEDIR or [] }
		2068	]
		2069	}
		2070
		2071	package cf;
		2072
		2073	=back
		2074
		2075	=head3 cf::object
		2076
		2077	=cut
		2078
		2079	package cf::object;
764		2080
765	=over 4	2081	=over 4
766		2082
767	=item cf::player::exists $login	2083	=item $ob->inv_recursive
768		2084
769	Returns true when the given account exists.	2085	Returns the inventory of the object _and_ their inventories, recursively.
770		2086
771	=cut	2087	=cut
772		2088
773	sub cf::player::exists($) {	2089	sub inv_recursive_;
774	cf::player::find $_[0]	2090	sub inv_recursive_ {
775	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2091	map { $_, inv_recursive_ $_->inv } @_
776	}	2092	}
777		2093
778	=item $player->ext_reply ($msgid, $msgtype, %msg)	2094	sub inv_recursive {
779		2095	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	}	2096	}
		2097
		2098	package cf;
791		2099
792	=back	2100	=back
793		2101
794	=head3 cf::object::player	2102	=head3 cf::object::player
795		2103
…		…
811		2119
812	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2120	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
813		2121
814	if ($self->{record_replies}) {	2122	if ($self->{record_replies}) {
815	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2123	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2124
816	} else {	2125	} else {
		2126	my $pl = $self->contr;
		2127
		2128	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2129	my $diag = $pl->{npc_dialog};
		2130	$diag->{pl}->ext_reply (
		2131	$diag->{id},
		2132	msgtype => "reply",
		2133	msg => $diag->{pl}->expand_cfpod ($msg),
		2134	add_topics => []
		2135	);
		2136
		2137	} else {
817	$msg = $npc->name . " says: $msg" if $npc;	2138	$msg = $npc->name . " says: $msg" if $npc;
818	$self->message ($msg, $flags);	2139	$self->message ($msg, $flags);
		2140	}
819	}	2141	}
820	}	2142	}
821		2143
822	=item $player_object->may ("access")	2144	=item $player_object->may ("access")
823		2145
…		…
833	(ref $cf::CFG{"may_$access"}	2155	(ref $cf::CFG{"may_$access"}
834	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2156	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835	: $cf::CFG{"may_$access"})	2157	: $cf::CFG{"may_$access"})
836	}	2158	}
837		2159
		2160	=item $player_object->enter_link
		2161
		2162	Freezes the player and moves him/her to a special map (C<{link}>).
		2163
		2164	The player should be reasonably safe there for short amounts of time. You
		2165	I<MUST> call C<leave_link> as soon as possible, though.
		2166
		2167	Will never block.
		2168
		2169	=item $player_object->leave_link ($map, $x, $y)
		2170
		2171	Moves the player out of the special C<{link}> map onto the specified
		2172	map. If the map is not valid (or omitted), the player will be moved back
		2173	to the location he/she was before the call to C<enter_link>, or, if that
		2174	fails, to the emergency map position.
		2175
		2176	Might block.
		2177
		2178	=cut
		2179
		2180	sub link_map {
		2181	unless ($LINK_MAP) {
		2182	$LINK_MAP = cf::map::find "{link}"
		2183	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2184	$LINK_MAP->load;
		2185	}
		2186
		2187	$LINK_MAP
		2188	}
		2189
		2190	sub cf::object::player::enter_link {
		2191	my ($self) = @_;
		2192
		2193	$self->deactivate_recursive;
		2194
		2195	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2196
		2197	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2198	if $self->map && $self->map->{path} ne "{link}";
		2199
		2200	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2201	}
		2202
		2203	sub cf::object::player::leave_link {
		2204	my ($self, $map, $x, $y) = @_;
		2205
		2206	return unless $self->contr->active;
		2207
		2208	my $link_pos = delete $self->{_link_pos};
		2209
		2210	unless ($map) {
		2211	# restore original map position
		2212	($map, $x, $y) = @{ $link_pos || [] };
		2213	$map = cf::map::find $map;
		2214
		2215	unless ($map) {
		2216	($map, $x, $y) = @$EMERGENCY_POSITION;
		2217	$map = cf::map::find $map
		2218	or die "FATAL: cannot load emergency map\n";
		2219	}
		2220	}
		2221
		2222	($x, $y) = (-1, -1)
		2223	unless (defined $x) && (defined $y);
		2224
		2225	# use -1 or undef as default coordinates, not 0, 0
		2226	($x, $y) = ($map->enter_x, $map->enter_y)
		2227	if $x <=0 && $y <= 0;
		2228
		2229	$map->load;
		2230	$map->load_diag;
		2231
		2232	return unless $self->contr->active;
		2233	$self->activate_recursive;
		2234
		2235	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2236	$self->enter_map ($map, $x, $y);
		2237	}
		2238
		2239	=item $player_object->goto ($path, $x, $y[, $check->($map)])
		2240
		2241	Moves the player to the given map-path and coordinates by first freezing
		2242	her, loading and preparing them map, calling the provided $check callback
		2243	that has to return the map if sucecssful, and then unfreezes the player on
		2244	the new (success) or old (failed) map position.
		2245
		2246	=cut
		2247
		2248	our $GOTOGEN;
		2249
		2250	sub cf::object::player::goto {
		2251	my ($self, $path, $x, $y, $check) = @_;
		2252
		2253	# do generation counting so two concurrent goto's will be executed in-order
		2254	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2255
		2256	$self->enter_link;
		2257
		2258	(async {
		2259	my $map = eval {
		2260	my $map = cf::map::find $path;
		2261
		2262	if ($map) {
		2263	$map = $map->customise_for ($self);
		2264	$map = $check->($map) if $check && $map;
		2265	} else {
		2266	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2267	}
		2268
		2269	$map
		2270	};
		2271
		2272	if ($@) {
		2273	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2274	LOG llevError | logBacktrace, Carp::longmess $@;
		2275	}
		2276
		2277	if ($gen == $self->{_goto_generation}) {
		2278	delete $self->{_goto_generation};
		2279	$self->leave_link ($map, $x, $y);
		2280	}
		2281	})->prio (1);
		2282	}
		2283
		2284	=item $player_object->enter_exit ($exit_object)
		2285
		2286	=cut
		2287
		2288	sub parse_random_map_params {
		2289	my ($spec) = @_;
		2290
		2291	my $rmp = { # defaults
		2292	xsize => (cf::rndm 15, 40),
		2293	ysize => (cf::rndm 15, 40),
		2294	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2295	#layout => string,
		2296	};
		2297
		2298	for (split /\n/, $spec) {
		2299	my ($k, $v) = split /\s+/, $_, 2;
		2300
		2301	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2302	}
		2303
		2304	$rmp
		2305	}
		2306
		2307	sub prepare_random_map {
		2308	my ($exit) = @_;
		2309
		2310	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2311
		2312	# all this does is basically replace the /! path by
		2313	# a new random map path (?random/...) with a seed
		2314	# that depends on the exit object
		2315
		2316	my $rmp = parse_random_map_params $exit->msg;
		2317
		2318	if ($exit->map) {
		2319	$rmp->{region} = $exit->region->name;
		2320	$rmp->{origin_map} = $exit->map->path;
		2321	$rmp->{origin_x} = $exit->x;
		2322	$rmp->{origin_y} = $exit->y;
		2323	}
		2324
		2325	$rmp->{random_seed} ||= $exit->random_seed;
		2326
		2327	my $data = cf::to_json $rmp;
		2328	my $md5 = Digest::MD5::md5_hex $data;
		2329	my $meta = "$RANDOMDIR/$md5.meta";
		2330
		2331	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2332	aio_write $fh, 0, (length $data), $data, 0;
		2333	undef $fh;
		2334	aio_rename "$meta~", $meta;
		2335
		2336	$exit->slaying ("?random/$md5");
		2337	$exit->msg (undef);
		2338	}
		2339	}
		2340
		2341	sub cf::object::player::enter_exit {
		2342	my ($self, $exit) = @_;
		2343
		2344	return unless $self->type == cf::PLAYER;
		2345
		2346	if ($exit->slaying eq "/!") {
		2347	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2348	# the problem is that $exit might not survive long enough
		2349	# so it needs to be done right now, right here
		2350	cf::sync_job { prepare_random_map $exit };
		2351	}
		2352
		2353	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2354	my $hp = $exit->stats->hp;
		2355	my $sp = $exit->stats->sp;
		2356
		2357	$self->enter_link;
		2358
		2359	(async {
		2360	$self->deactivate_recursive; # just to be sure
		2361	unless (eval {
		2362	$self->goto ($slaying, $hp, $sp);
		2363
		2364	1;
		2365	}) {
		2366	$self->message ("Something went wrong deep within the crossfire server. "
		2367	. "I'll try to bring you back to the map you were before. "
		2368	. "Please report this to the dungeon master!",
		2369	cf::NDI_UNIQUE | cf::NDI_RED);
		2370
		2371	warn "ERROR in enter_exit: $@";
		2372	$self->leave_link;
		2373	}
		2374	})->prio (1);
		2375	}
		2376
838	=head3 cf::client	2377	=head3 cf::client
839		2378
840	=over 4	2379	=over 4
841		2380
842	=item $client->send_drawinfo ($text, $flags)	2381	=item $client->send_drawinfo ($text, $flags)
…		…
848		2387
849	sub cf::client::send_drawinfo {	2388	sub cf::client::send_drawinfo {
850	my ($self, $text, $flags) = @_;	2389	my ($self, $text, $flags) = @_;
851		2390
852	utf8::encode $text;	2391	utf8::encode $text;
853	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2392	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
854	}	2393	}
855		2394
		2395	=item $client->send_msg ($color, $type, $msg, [extra...])
		2396
		2397	Send a drawinfo or msg packet to the client, formatting the msg for the
		2398	client if neccessary. C<$type> should be a string identifying the type of
		2399	the message, with C<log> being the default. If C<$color> is negative, suppress
		2400	the message unless the client supports the msg packet.
		2401
		2402	=cut
		2403
		2404	sub cf::client::send_msg {
		2405	my ($self, $color, $type, $msg, @extra) = @_;
		2406
		2407	$msg = $self->pl->expand_cfpod ($msg);
		2408
		2409	if ($self->can_msg) {
		2410	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2411	} else {
		2412	# replace some tags by gcfclient-compatible ones
		2413	for ($msg) {
		2414	1 while
		2415	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2416	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2417	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2418	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2419	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2420	}
		2421
		2422	if ($color >= 0) {
		2423	if (0 && $msg =~ /\[/) {
		2424	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2425	} else {
		2426	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2427	$self->send_packet ("drawinfo $color $msg")
		2428	}
		2429	}
		2430	}
		2431	}
		2432
		2433	=item $client->ext_event ($type, %msg)
		2434
		2435	Sends an ext event to the client.
		2436
		2437	=cut
		2438
		2439	sub cf::client::ext_event($$%) {
		2440	my ($self, $type, %msg) = @_;
		2441
		2442	$msg{msgtype} = "event_$type";
		2443	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2444	}
856		2445
857	=item $success = $client->query ($flags, "text", \&cb)	2446	=item $success = $client->query ($flags, "text", \&cb)
858		2447
859	Queues a query to the client, calling the given callback with	2448	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>,	2449	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>.	2450	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
862		2451
863	Queries can fail, so check the return code. Or don't, as queries will become	2452	Queries can fail, so check the return code. Or don't, as queries will
864	reliable at some point in the future.	2453	become reliable at some point in the future.
865		2454
866	=cut	2455	=cut
867		2456
868	sub cf::client::query {	2457	sub cf::client::query {
869	my ($self, $flags, $text, $cb) = @_;	2458	my ($self, $flags, $text, $cb) = @_;
…		…
877	utf8::encode $text;	2466	utf8::encode $text;
878	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2467	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
879		2468
880	$self->send_packet ($self->{query_queue}[0][0])	2469	$self->send_packet ($self->{query_queue}[0][0])
881	if @{ $self->{query_queue} } == 1;	2470	if @{ $self->{query_queue} } == 1;
		2471
		2472	1
882	}	2473	}
883		2474
884	cf::client->attach (	2475	cf::client->attach (
		2476	on_connect => sub {
		2477	my ($ns) = @_;
		2478
		2479	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2480	},
885	on_reply => sub {	2481	on_reply => sub {
886	my ($ns, $msg) = @_;	2482	my ($ns, $msg) = @_;
887		2483
888	# this weird shuffling is so that direct followup queries	2484	# this weird shuffling is so that direct followup queries
889	# get handled first	2485	# get handled first
890	my $queue = delete $ns->{query_queue};	2486	my $queue = delete $ns->{query_queue}
		2487	or return; # be conservative, not sure how that can happen, but we saw a crash here
891		2488
892	(shift @$queue)->[1]->($msg);	2489	(shift @$queue)->[1]->($msg);
		2490	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
893		2491
894	push @{ $ns->{query_queue} }, @$queue;	2492	push @{ $ns->{query_queue} }, @$queue;
895		2493
896	if (@{ $ns->{query_queue} } == @$queue) {	2494	if (@{ $ns->{query_queue} } == @$queue) {
897	if (@$queue) {	2495	if (@$queue) {
898	$ns->send_packet ($ns->{query_queue}[0][0]);	2496	$ns->send_packet ($ns->{query_queue}[0][0]);
899	} else {	2497	} else {
900	$ns->state (ST_PLAYING);	2498	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
901	}	2499	}
902	}	2500	}
		2501	},
		2502	on_exticmd => sub {
		2503	my ($ns, $buf) = @_;
		2504
		2505	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2506
		2507	if (ref $msg) {
		2508	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2509	if (my %reply = $cb->($ns, $msg)) {
		2510	$reply{msgid} = $msg->{msgid};
		2511	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2512	}
		2513	}
		2514	} else {
		2515	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2516	}
		2517
		2518	cf::override;
		2519	},
		2520	);
		2521
		2522	=item $client->async (\&cb)
		2523
		2524	Create a new coroutine, running the specified callback. The coroutine will
		2525	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2526	or loss of connection).
		2527
		2528	=cut
		2529
		2530	sub cf::client::async {
		2531	my ($self, $cb) = @_;
		2532
		2533	my $coro = &Coro::async ($cb);
		2534
		2535	$coro->on_destroy (sub {
		2536	delete $self->{_coro}{$coro+0};
		2537	});
		2538
		2539	$self->{_coro}{$coro+0} = $coro;
		2540
		2541	$coro
		2542	}
		2543
		2544	cf::client->attach (
		2545	on_destroy => sub {
		2546	my ($ns) = @_;
		2547
		2548	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
903	},	2549	},
904	);	2550	);
905		2551
906	=back	2552	=back
907		2553
…		…
925		2571
926	# here we export the classes and methods available to script code	2572	# here we export the classes and methods available to script code
927		2573
928	=pod	2574	=pod
929		2575
930	The following fucntions and emthods are available within a safe environment:	2576	The following functions and methods are available within a safe environment:
931		2577
932	cf::object contr pay_amount pay_player map	2578	cf::object contr pay_amount pay_player map
933	cf::object::player player	2579	cf::object::player player
934	cf::player peaceful	2580	cf::player peaceful
935	cf::map trigger	2581	cf::map trigger
…		…
1016	=back	2662	=back
1017		2663
1018	=cut	2664	=cut
1019		2665
1020	#############################################################################	2666	#############################################################################
		2667	# the server's init and main functions
1021		2668
1022	=head2 EXTENSION DATABASE SUPPORT	2669	sub load_facedata($) {
		2670	my ($path) = @_;
1023		2671
1024	Crossfire maintains a very simple database for extension use. It can	2672	warn "loading facedata from $path\n";
1025	currently store anything that can be serialised using Storable, which
1026	excludes objects.
1027		2673
1028	The parameter C<$family> should best start with the name of the extension	2674	my $facedata;
1029	using it, it should be unique.	2675	0 < aio_load $path, $facedata
		2676	or die "$path: $!";
1030		2677
1031	=over 4	2678	$facedata = Coro::Storable::thaw $facedata;
1032		2679
1033	=item $hashref = cf::db_get $family	2680	$facedata->{version} == 2
		2681	or cf::cleanup "$path: version mismatch, cannot proceed.";
1034		2682
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	}	2683	{
		2684	my $faces = $facedata->{faceinfo};
1072		2685
1073	my $pid;	2686	while (my ($face, $info) = each %$faces) {
1074		2687	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1075	sub db_save() {	2688	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1076	warn "saving database $path\n";#d# remove later	2689	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1077	waitpid $pid, 0 if $pid;	2690	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1078	if (0 == ($pid = fork)) {	2691	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	},	2692	}
1122	);
1123	}
1124		2693
1125	#############################################################################	2694	while (my ($face, $info) = each %$faces) {
1126	# the server's main()	2695	next unless $info->{smooth};
		2696	my $idx = cf::face::find $face
		2697	or next;
		2698	if (my $smooth = cf::face::find $info->{smooth}) {
		2699	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2700	} else {
		2701	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2702	}
		2703	Coro::cede;
		2704	}
		2705	}
		2706
		2707	{
		2708	my $anims = $facedata->{animinfo};
		2709
		2710	while (my ($anim, $info) = each %$anims) {
		2711	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2712	Coro::cede;
		2713	}
		2714
		2715	cf::anim::invalidate_all; # d'oh
		2716	}
		2717
		2718	1
		2719	}
		2720
		2721	sub reload_regions {
		2722	load_resource_file "$MAPDIR/regions"
		2723	or die "unable to load regions file\n";
		2724	}
		2725
		2726	sub reload_facedata {
		2727	load_facedata "$DATADIR/facedata"
		2728	or die "unable to load facedata\n";
		2729	}
		2730
		2731	sub reload_archetypes {
		2732	load_resource_file "$DATADIR/archetypes"
		2733	or die "unable to load archetypes\n";
		2734	#d# NEED to laod twice to resolve forward references
		2735	# this really needs to be done in an extra post-pass
		2736	# (which needs to be synchronous, so solve it differently)
		2737	load_resource_file "$DATADIR/archetypes"
		2738	or die "unable to load archetypes\n";
		2739	}
		2740
		2741	sub reload_treasures {
		2742	load_resource_file "$DATADIR/treasures"
		2743	or die "unable to load treasurelists\n";
		2744	}
		2745
		2746	sub reload_resources {
		2747	warn "reloading resource files...\n";
		2748
		2749	reload_regions;
		2750	reload_facedata;
		2751	#reload_archetypes;#d#
		2752	reload_archetypes;
		2753	reload_treasures;
		2754
		2755	warn "finished reloading resource files\n";
		2756	}
		2757
		2758	sub init {
		2759	reload_resources;
		2760	}
1127		2761
1128	sub cfg_load {	2762	sub cfg_load {
1129	open my $fh, "<:utf8", cf::confdir . "/config"	2763	open my $fh, "<:utf8", "$CONFDIR/config"
1130	or return;	2764	or return;
1131		2765
1132	local $/;	2766	local $/;
1133	*CFG = YAML::Syck::Load <$fh>;	2767	*CFG = YAML::Syck::Load <$fh>;
		2768
		2769	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2770
		2771	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2772	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2773
		2774	if (exists $CFG{mlockall}) {
		2775	eval {
		2776	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2777	and die "WARNING: m(un)lockall failed: $!\n";
		2778	};
		2779	warn $@ if $@;
		2780	}
1134	}	2781	}
1135		2782
1136	sub main {	2783	sub main {
		2784	# we must not ever block the main coroutine
		2785	local $Coro::idle = sub {
		2786	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2787	(async {
		2788	Event::one_event;
		2789	})->prio (Coro::PRIO_MAX);
		2790	};
		2791
1137	cfg_load;	2792	cfg_load;
1138	db_load;	2793	db_init;
1139	load_extensions;	2794	load_extensions;
		2795
		2796	$TICK_WATCHER->start;
1140	Event::loop;	2797	Event::loop;
1141	}	2798	}
1142		2799
1143	#############################################################################	2800	#############################################################################
1144	# initialisation	2801	# initialisation and cleanup
1145		2802
1146	sub _perl_reload(&) {	2803	# install some emergency cleanup handlers
		2804	BEGIN {
		2805	for my $signal (qw(INT HUP TERM)) {
		2806	Event->signal (
		2807	reentrant => 0,
		2808	data => WF_AUTOCANCEL,
		2809	signal => $signal,
		2810	prio => 0,
		2811	cb => sub {
		2812	cf::cleanup "SIG$signal";
		2813	},
		2814	);
		2815	}
		2816	}
		2817
		2818	sub write_runtime {
		2819	my $runtime = "$LOCALDIR/runtime";
		2820
		2821	# first touch the runtime file to show we are still running:
		2822	# the fsync below can take a very very long time.
		2823
		2824	IO::AIO::aio_utime $runtime, undef, undef;
		2825
		2826	my $guard = cf::lock_acquire "write_runtime";
		2827
		2828	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2829	or return;
		2830
		2831	my $value = $cf::RUNTIME + 90 + 10;
		2832	# 10 is the runtime save interval, for a monotonic clock
		2833	# 60 allows for the watchdog to kill the server.
		2834
		2835	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2836	and return;
		2837
		2838	# always fsync - this file is important
		2839	aio_fsync $fh
		2840	and return;
		2841
		2842	# touch it again to show we are up-to-date
		2843	aio_utime $fh, undef, undef;
		2844
		2845	close $fh
		2846	or return;
		2847
		2848	aio_rename "$runtime~", $runtime
		2849	and return;
		2850
		2851	warn "runtime file written.\n";
		2852
		2853	1
		2854	}
		2855
		2856	sub emergency_save() {
		2857	my $freeze_guard = cf::freeze_mainloop;
		2858
		2859	warn "enter emergency perl save\n";
		2860
		2861	cf::sync_job {
		2862	# use a peculiar iteration method to avoid tripping on perl
		2863	# refcount bugs in for. also avoids problems with players
		2864	# and maps saved/destroyed asynchronously.
		2865	warn "begin emergency player save\n";
		2866	for my $login (keys %cf::PLAYER) {
		2867	my $pl = $cf::PLAYER{$login} or next;
		2868	$pl->valid or next;
		2869	$pl->save;
		2870	}
		2871	warn "end emergency player save\n";
		2872
		2873	warn "begin emergency map save\n";
		2874	for my $path (keys %cf::MAP) {
		2875	my $map = $cf::MAP{$path} or next;
		2876	$map->valid or next;
		2877	$map->save;
		2878	}
		2879	warn "end emergency map save\n";
		2880
		2881	warn "begin emergency database checkpoint\n";
		2882	BDB::db_env_txn_checkpoint $DB_ENV;
		2883	warn "end emergency database checkpoint\n";
		2884	};
		2885
		2886	warn "leave emergency perl save\n";
		2887	}
		2888
		2889	sub post_cleanup {
1147	my ($msg) = @_;	2890	my ($make_core) = @_;
1148		2891
1149	$msg->("reloading...");	2892	warn Carp::longmess "post_cleanup backtrace"
		2893	if $make_core;
		2894	}
1150		2895
1151	eval {	2896	sub do_reload_perl() {
1152	# cancel all watchers	2897	# can/must only be called in main
		2898	if ($Coro::current != $Coro::main) {
		2899	warn "can only reload from main coroutine";
		2900	return;
		2901	}
		2902
		2903	warn "reloading...";
		2904
		2905	warn "entering sync_job";
		2906
		2907	cf::sync_job {
		2908	cf::write_runtime; # external watchdog should not bark
		2909	cf::emergency_save;
		2910	cf::write_runtime; # external watchdog should not bark
		2911
		2912	warn "syncing database to disk";
		2913	BDB::db_env_txn_checkpoint $DB_ENV;
		2914
		2915	# if anything goes wrong in here, we should simply crash as we already saved
		2916
		2917	warn "cancelling all WF_AUTOCANCEL watchers";
1153	for (Event::all_watchers) {	2918	for (Event::all_watchers) {
1154	$_->cancel if $_->data & WF_AUTOCANCEL;	2919	$_->cancel if $_->data & WF_AUTOCANCEL;
1155	}	2920	}
1156		2921
1157	# unload all extensions	2922	warn "flushing outstanding aio requests";
1158	for (@exts) {	2923	for (;;) {
1159	$msg->("unloading <$_>");	2924	BDB::flush;
1160	unload_extension $_;	2925	IO::AIO::flush;
		2926	Coro::cede;
		2927	last unless IO::AIO::nreqs || BDB::nreqs;
		2928	warn "iterate...";
		2929	}
		2930
		2931	++$RELOAD;
		2932
		2933	warn "cancelling all extension coros";
		2934	$_->cancel for values %EXT_CORO;
		2935	%EXT_CORO = ();
		2936
		2937	warn "removing commands";
		2938	%COMMAND = ();
		2939
		2940	warn "removing ext/exti commands";
		2941	%EXTCMD = ();
		2942	%EXTICMD = ();
		2943
		2944	warn "unloading/nuking all extensions";
		2945	for my $pkg (@EXTS) {
		2946	warn "... unloading $pkg";
		2947
		2948	if (my $cb = $pkg->can ("unload")) {
		2949	eval {
		2950	$cb->($pkg);
		2951	1
		2952	} or warn "$pkg unloaded, but with errors: $@";
1161	}	2953	}
1162		2954
		2955	warn "... nuking $pkg";
		2956	Symbol::delete_package $pkg;
		2957	}
		2958
1163	# unload all modules loaded from $LIBDIR	2959	warn "unloading all perl modules loaded from $LIBDIR";
1164	while (my ($k, $v) = each %INC) {	2960	while (my ($k, $v) = each %INC) {
1165	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2961	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166		2962
1167	$msg->("removing <$k>");	2963	warn "... unloading $k";
1168	delete $INC{$k};	2964	delete $INC{$k};
1169		2965
1170	$k =~ s/\.pm$//;	2966	$k =~ s/\.pm$//;
1171	$k =~ s/\//::/g;	2967	$k =~ s/\//::/g;
1172		2968
…		…
1175	}	2971	}
1176		2972
1177	Symbol::delete_package $k;	2973	Symbol::delete_package $k;
1178	}	2974	}
1179		2975
1180	# sync database to disk
1181	cf::db_sync;
1182
1183	# get rid of safe::, as good as possible	2976	warn "getting rid of safe::, as good as possible";
1184	Symbol::delete_package "safe::$_"	2977	Symbol::delete_package "safe::$_"
1185	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2978	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1186		2979
1187	# remove register_script_function callbacks
1188	# TODO
1189
1190	# unload cf.pm "a bit"	2980	warn "unloading cf.pm \"a bit\"";
1191	delete $INC{"cf.pm"};	2981	delete $INC{"cf.pm"};
		2982	delete $INC{"cf/pod.pm"};
1192		2983
1193	# don't, removes xs symbols, too,	2984	# don't, removes xs symbols, too,
1194	# and global variables created in xs	2985	# and global variables created in xs
1195	#Symbol::delete_package __PACKAGE__;	2986	#Symbol::delete_package __PACKAGE__;
1196		2987
1197	# reload cf.pm	2988	warn "unload completed, starting to reload now";
		2989
1198	$msg->("reloading cf.pm");	2990	warn "reloading cf.pm";
1199	require cf;	2991	require cf;
		2992	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1200		2993
1201	# load config and database again	2994	warn "loading config and database again";
1202	cf::cfg_load;	2995	cf::cfg_load;
1203	cf::db_load;
1204		2996
1205	# load extensions	2997	warn "loading extensions";
1206	$msg->("load extensions");
1207	cf::load_extensions;	2998	cf::load_extensions;
1208		2999
1209	# reattach attachments to objects	3000	warn "reattaching attachments to objects/players";
1210	$msg->("reattach");	3001	_global_reattach; # objects, sockets
1211	_global_reattach;	3002	warn "reattaching attachments to maps";
		3003	reattach $_ for values %MAP;
		3004	warn "reattaching attachments to players";
		3005	reattach $_ for values %PLAYER;
		3006
		3007	warn "leaving sync_job";
		3008
		3009	1
		3010	} or do {
		3011	warn $@;
		3012	warn "error while reloading, exiting.";
		3013	exit 1;
1212	};	3014	};
1213	$msg->($@) if $@;
1214		3015
1215	$msg->("reloaded");	3016	warn "reloaded";
1216	};	3017	};
1217		3018
1218	sub perl_reload() {	3019	our $RELOAD_WATCHER; # used only during reload
1219	_perl_reload {	3020
1220	warn $_[0];	3021	sub reload_perl() {
1221	print "$_[0]\n";	3022	# doing reload synchronously and two reloads happen back-to-back,
		3023	# coro crashes during coro_state_free->destroy here.
		3024
		3025	$RELOAD_WATCHER ||= Event->timer (
		3026	reentrant => 0,
		3027	after => 0,
		3028	data => WF_AUTOCANCEL,
		3029	cb => sub {
		3030	do_reload_perl;
		3031	undef $RELOAD_WATCHER;
		3032	},
1222	};	3033	);
1223	}	3034	}
1224		3035
1225	register "<global>", __PACKAGE__;
1226
1227	register_command "perl-reload" => sub {	3036	register_command "reload" => sub {
1228	my ($who, $arg) = @_;	3037	my ($who, $arg) = @_;
1229		3038
1230	if ($who->flag (FLAG_WIZ)) {	3039	if ($who->flag (FLAG_WIZ)) {
1231	_perl_reload {	3040	$who->message ("reloading server.");
1232	warn $_[0];	3041	async { reload_perl };
1233	$who->message ($_[0]);	3042	}
		3043	};
		3044
		3045	unshift @INC, $LIBDIR;
		3046
		3047	my $bug_warning = 0;
		3048
		3049	our @WAIT_FOR_TICK;
		3050	our @WAIT_FOR_TICK_BEGIN;
		3051
		3052	sub wait_for_tick {
		3053	return unless $TICK_WATCHER->is_active;
		3054	return if $Coro::current == $Coro::main;
		3055
		3056	my $signal = new Coro::Signal;
		3057	push @WAIT_FOR_TICK, $signal;
		3058	$signal->wait;
		3059	}
		3060
		3061	sub wait_for_tick_begin {
		3062	return unless $TICK_WATCHER->is_active;
		3063	return if $Coro::current == $Coro::main;
		3064
		3065	my $signal = new Coro::Signal;
		3066	push @WAIT_FOR_TICK_BEGIN, $signal;
		3067	$signal->wait;
		3068	}
		3069
		3070	my $min = 1e6;#d#
		3071	my $avg = 10;
		3072	$TICK_WATCHER = Event->timer (
		3073	reentrant => 0,
		3074	parked => 1,
		3075	prio => 0,
		3076	at => $NEXT_TICK || $TICK,
		3077	data => WF_AUTOCANCEL,
		3078	cb => sub {
		3079	if ($Coro::current != $Coro::main) {
		3080	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3081	unless ++$bug_warning > 10;
		3082	return;
		3083	}
		3084
		3085	$NOW = $tick_start = Event::time;
		3086
		3087	cf::server_tick; # one server iteration
		3088
		3089	0 && sync_job {#d#
		3090	for(1..10) {
		3091	my $t = Event::time;
		3092	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3093	or die;
		3094
		3095	$map->width (50);
		3096	$map->height (50);
		3097	$map->alloc;
		3098	$map->_load_objects ("/tmp/x.map", 1);
		3099	my $t = Event::time - $t;
		3100
		3101	#next unless $t < 0.0013;#d#
		3102	if ($t < $min) {
		3103	$min = $t;
		3104	}
		3105	$avg = $avg * 0.99 + $t * 0.01;
		3106	}
		3107	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3108	exit 0;
		3109	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1234	};	3110	};
1235	}
1236	};
1237		3111
1238	unshift @INC, $LIBDIR;	3112	$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;	3113	$NEXT_TICK += $TICK;
		3114
		3115	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3116	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3117	Coro::async_pool {
		3118	write_runtime
		3119	or warn "ERROR: unable to write runtime file: $!";
		3120	};
		3121	}
		3122
		3123	# my $AFTER = Event::time;
		3124	# warn $AFTER - $NOW;#d#
		3125
		3126	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3127	$sig->send;
		3128	}
		3129	while (my $sig = shift @WAIT_FOR_TICK) {
		3130	$sig->send;
		3131	}
		3132
		3133	$NOW = Event::time;
1249		3134
1250	# if we are delayed by four ticks or more, skip them all	3135	# if we are delayed by four ticks or more, skip them all
1251	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3136	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1252		3137
1253	$TICK_WATCHER->at ($NEXT_TICK);	3138	$TICK_WATCHER->at ($NEXT_TICK);
1254	$TICK_WATCHER->start;	3139	$TICK_WATCHER->start;
		3140
		3141	$LOAD = ($NOW - $tick_start) / $TICK;
		3142	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3143
		3144	_post_tick;
		3145
		3146
1255	},	3147	},
1256	);	3148	);
1257		3149
		3150	{
		3151	BDB::max_poll_time $TICK * 0.1;
		3152	$BDB_POLL_WATCHER = Event->io (
		3153	reentrant => 0,
		3154	fd => BDB::poll_fileno,
		3155	poll => 'r',
		3156	prio => 0,
		3157	data => WF_AUTOCANCEL,
		3158	cb => \&BDB::poll_cb,
		3159	);
		3160	BDB::min_parallel 8;
		3161
		3162	BDB::set_sync_prepare {
		3163	my $status;
		3164	my $current = $Coro::current;
		3165	(
		3166	sub {
		3167	$status = $!;
		3168	$current->ready; undef $current;
		3169	},
		3170	sub {
		3171	Coro::schedule while defined $current;
		3172	$! = $status;
		3173	},
		3174	)
		3175	};
		3176
		3177	unless ($DB_ENV) {
		3178	$DB_ENV = BDB::db_env_create;
		3179
		3180	cf::sync_job {
		3181	eval {
		3182	BDB::db_env_open
		3183	$DB_ENV,
		3184	$BDBDIR,
		3185	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3186	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3187	0666;
		3188
		3189	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3190
		3191	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3192	$DB_ENV->set_lk_detect;
		3193	};
		3194
		3195	cf::cleanup "db_env_open(db): $@" if $@;
		3196	};
		3197	}
		3198	}
		3199
		3200	{
		3201	IO::AIO::min_parallel 8;
		3202
		3203	undef $Coro::AIO::WATCHER;
1258	IO::AIO::max_poll_time $TICK * 0.2;	3204	IO::AIO::max_poll_time $TICK * 0.1;
1259		3205	$AIO_POLL_WATCHER = Event->io (
1260	Event->io (fd => IO::AIO::poll_fileno,	3206	reentrant => 0,
1261	poll => 'r',
1262	prio => 5,
1263	data => WF_AUTOCANCEL,	3207	data => WF_AUTOCANCEL,
		3208	fd => IO::AIO::poll_fileno,
		3209	poll => 'r',
		3210	prio => 6,
1264	cb => \&IO::AIO::poll_cb);	3211	cb => \&IO::AIO::poll_cb,
		3212	);
		3213	}
		3214
		3215	my $_log_backtrace;
		3216
		3217	sub _log_backtrace {
		3218	my ($msg, @addr) = @_;
		3219
		3220	$msg =~ s/\n//;
		3221
		3222	# limit the # of concurrent backtraces
		3223	if ($_log_backtrace < 2) {
		3224	++$_log_backtrace;
		3225	async {
		3226	my @bt = fork_call {
		3227	@addr = map { sprintf "%x", $_ } @addr;
		3228	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3229	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3230	or die "addr2line: $!";
		3231
		3232	my @funcs;
		3233	my @res = <$fh>;
		3234	chomp for @res;
		3235	while (@res) {
		3236	my ($func, $line) = splice @res, 0, 2, ();
		3237	push @funcs, "[$func] $line";
		3238	}
		3239
		3240	@funcs
		3241	};
		3242
		3243	LOG llevInfo, "[ABT] $msg\n";
		3244	LOG llevInfo, "[ABT] $_\n" for @bt;
		3245	--$_log_backtrace;
		3246	};
		3247	} else {
		3248	LOG llevInfo, "[ABT] $msg\n";
		3249	LOG llevInfo, "[ABT] [suppressed]\n";
		3250	}
		3251	}
		3252
		3253	# load additional modules
		3254	use cf::pod;
		3255
		3256	END { cf::emergency_save }
1265		3257
1266	1	3258	1
1267		3259

Diff Legend

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