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

Diff Legend

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