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

Diff Legend

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