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

Diff Legend

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