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.62 by root, Fri Sep 8 16:51:44 2006 UTC vs.
Revision 1.343 by root, Mon Aug 27 01:13:48 2007 UTC

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

Diff Legend

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