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

Diff Legend

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