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.74 by root, Sun Oct 1 15:59:29 2006 UTC vs.
Revision 1.345 by root, Tue Aug 28 19:30:11 2007 UTC

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

Diff Legend

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