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

Diff Legend

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