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.89 by root, Fri Dec 15 19:59:20 2006 UTC vs.
Revision 1.362 by root, Mon Sep 10 12:44:06 2007 UTC

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

Diff Legend

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