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

Diff Legend

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