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

Diff Legend

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