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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC

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

Diff Legend

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