ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.300 by root, Tue Jul 10 06:44:29 2007 UTC

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

Diff Legend

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