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

Diff Legend

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