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.106 by root, Sun Dec 31 17:29:22 2006 UTC vs.
Revision 1.288 by root, Mon Jun 25 07:40:53 2007 UTC

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

Diff Legend

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