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.61 by root, Sun Sep 3 22:45:56 2006 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 2007 UTC

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

Diff Legend

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