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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.261 by root, Fri Apr 27 20:09:48 2007 UTC

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

Diff Legend

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