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

Diff Legend

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