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

Diff Legend

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