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

Diff Legend

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