ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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