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

Diff Legend

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