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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.213 by root, Tue Feb 13 20:01:04 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;
		24	use IO::AIO 2.32 ();
10	use YAML::Syck ();	25	use YAML::Syck ();
11	use Time::HiRes;	26	use Time::HiRes;
12	use Event;	27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		30
13	$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
14		34
15	# 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?
16	$YAML::Syck::ImplicitUnicode = 1;	36	$YAML::Syck::ImplicitUnicode = 1;
17		37
18	use strict;	38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
19		39
20	_init_vars;
21
22	our %COMMAND = ();	40	our %COMMAND = ();
		41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
		44	our %EXTCMD = ();
		45	our %EXT_CORO = (); # coroutines bound to extensions
		46	our %EXT_MAP = (); # pluggable maps
		47
23	our @EVENT;	48	our @EVENT;
24	our $LIBDIR = maps_directory "perl";	49	our $LIBDIR = datadir . "/ext";
25		50
26	our $TICK = MAX_TIME * 1e-6;	51	our $TICK = MAX_TIME * 1e-6;
27	our $TICK_WATCHER;	52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $WRITE_RUNTIME_WATCHER;
28	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;
29		61
30	our %CFG;	62	our %CFG;
31		63
32	our $uptime;	64	our $UPTIME; $UPTIME ||= time;
		65	our $RUNTIME;
33		66
34	$uptime ||= time;	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;
35		99
36	#############################################################################	100	#############################################################################
37		101
38	=head2 GLOBAL VARIABLES	102	=head2 GLOBAL VARIABLES
39		103
40	=over 4	104	=over 4
		105
		106	=item $cf::UPTIME
		107
		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.
41		114
42	=item $cf::LIBDIR	115	=item $cf::LIBDIR
43		116
44	The perl library directory, where extensions and cf-specific modules can	117	The perl library directory, where extensions and cf-specific modules can
45	be found. It will be added to C<@INC> automatically.	118	be found. It will be added to C<@INC> automatically.
46		119
		120	=item $cf::NOW
		121
		122	The time of the last (current) server tick.
		123
47	=item $cf::TICK	124	=item $cf::TICK
48		125
49	The interval between server ticks, in seconds.	126	The interval between server ticks, in seconds.
50		127
51	=item %cf::CFG	128	=item %cf::CFG
52		129
53	Configuration for the server, loaded from C</etc/crossfire/config>, or	130	Configuration for the server, loaded from C</etc/crossfire/config>, or
54	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.
55		139
56	=back	140	=back
57		141
58	=cut	142	=cut
59		143
60	BEGIN {	144	BEGIN {
61	*CORE::GLOBAL::warn = sub {	145	*CORE::GLOBAL::warn = sub {
62	my $msg = join "", @_;	146	my $msg = join "", @_;
		147	utf8::encode $msg;
		148
63	$msg .= "\n"	149	$msg .= "\n"
64	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
65		151
66	print STDERR "cfperl: $msg";
67	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
68	};	153	};
69	}	154	}
70		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';
71	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		162
73	# 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
74	# within the Safe compartment.	164	# within the Safe compartment.
75	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	165	for my $pkg (qw(
		166	cf::global cf::attachable
		167	cf::object cf::object::player
		168	cf::client cf::player
		169	cf::arch cf::living
		170	cf::map cf::party cf::region
		171	)) {
76	no strict 'refs';	172	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	173	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	174	}
79		175
80	$Event::DIED = sub {	176	$Event::DIED = sub {
81	warn "error in event callback: @_";	177	warn "error in event callback: @_";
82	};	178	};
83		179
84	my %ext_pkg;
85	my @exts;
86	my @hook;
87	my %command;
88	my %extcmd;
89
90	=head2 UTILITY FUNCTIONS	180	=head2 UTILITY FUNCTIONS
91		181
92	=over 4	182	=over 4
93		183
		184	=item dumpval $ref
		185
94	=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	}
95		206
96	use JSON::Syck (); # TODO# replace by JSON::PC once working	207	use JSON::Syck (); # TODO# replace by JSON::PC once working
97		208
98	=item $ref = cf::from_json $json	209	=item $ref = cf::from_json $json
99		210
…		…
115	sub to_json($) {	226	sub to_json($) {
116	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
117	JSON::Syck::Dump $_[0]	228	JSON::Syck::Dump $_[0]
118	}	229	}
119		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
120	=back	386	=back
121		387
122	=cut	388	=cut
123		389
124	#############################################################################	390	#############################################################################
125		391
126	=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+).
127		401
128	=over 4	402	=over 4
129		403
130	=item $object->attach ($attachment, key => $value...)
131
132	=item $object->detach ($attachment)
133
134	Attach/detach a pre-registered attachment to an object.
135
136	=item $player->attach ($attachment, key => $value...)
137
138	=item $player->detach ($attachment)
139
140	Attach/detach a pre-registered attachment to a player.
141
142	=item $map->attach ($attachment, key => $value...)	404	=item $attachable->attach ($attachment, key => $value...)
143		405
144	=item $map->detach ($attachment)	406	=item $attachable->detach ($attachment)
145		407
146	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.
147		410
148	=item $bool = $object->attached ($name)	411	Example, attach a minesweeper attachment to the given object, making it a
		412	10x10 minesweeper game:
149		413
150	=item $bool = $player->attached ($name)	414	$obj->attach (minesweeper => width => 10, height => 10);
151		415
152	=item $bool = $map->attached ($name)	416	=item $bool = $attachable->attached ($name)
153		417
154	Checks wether the named attachment is currently attached to the object.	418	Checks wether the named attachment is currently attached to the object.
155		419
156	=item cf::attach_global ...	420	=item cf::CLASS->attach ...
157		421
158	Attach handlers for global events.	422	=item cf::CLASS->detach ...
159		423
160	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
161	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:
162		458
163	=over 4	459	=over 4
164		460
165	=item prio => $number	461	=item prio => $number
166		462
…		…
168	by another C<prio> setting). Lower priority handlers get executed	464	by another C<prio> setting). Lower priority handlers get executed
169	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
170	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
171	unless you know what you are doing.	467	unless you know what you are doing.
172		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
173	=item on_I<event> => \&cb	475	=item on_I<event> => \&cb
174		476
175	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
176	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
177	handlers are recognised generally depends on the type of object these	479	handlers are recognised generally depends on the type of object these
…		…
186	package and register them. Only handlers for eevents supported by the	488	package and register them. Only handlers for eevents supported by the
187	object/class are recognised.	489	object/class are recognised.
188		490
189	=back	491	=back
190		492
191	=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:
192		495
193	Attach handlers for a specific object type (e.g. TRANSPORT) and	496	cf::object::attachment sockpuppet =>
194	subtype. If C<$subtype> is zero or undef, matches all objects of the given	497	on_skill_attack => sub {
195	type.	498	my ($self, $victim) = @_;
196		499	...
197	=item cf::attach_to_objects ...
198
199	Attach handlers to all objects. Do not use this except for debugging or
200	very rare events, as handlers are (obviously) called for I<all> objects in
201	the game.
202
203	=item cf::attach_to_players ...
204
205	Attach handlers to all players.
206
207	=item cf::attach_to_maps ...
208
209	Attach handlers to all maps.
210
211	=item cf:register_attachment $name, ...
212
213	Register an attachment by name through which objects can refer to this
214	attachment.
215
216	=item cf:register_player_attachment $name, ...
217
218	Register an attachment by name through which players can refer to this
219	attachment.
220
221	=item cf:register_map_attachment $name, ...
222
223	Register an attachment by name through which maps can refer to this
224	attachment.
225
226	=cut
227
228	# the following variables are defined in .xs and must not be re-created
229	our @CB_GLOBAL = (); # registry for all global events
230	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
231	our @CB_PLAYER = ();
232	our @CB_TYPE = (); # registry for type (cf-object class) based events
233	our @CB_MAP = ();
234
235	my %attachment;
236
237	sub _attach_cb($\%$$$) {
238	my ($registry, $undo, $event, $prio, $cb) = @_;
239
240	use sort 'stable';
241
242	$cb = [$prio, $cb];
243
244	@{$registry->[$event]} = sort
245	{ $a->[0] cmp $b->[0] }
246	@{$registry->[$event] || []}, $cb;
247
248	push @{$undo->{cb}}, [$event, $cb];
249	}
250
251	# attach handles attaching event callbacks
252	# the only thing the caller has to do is pass the correct
253	# registry (== where the callback attaches to).
254	sub _attach(\@$@) {
255	my ($registry, $klass, @arg) = @_;
256
257	my $prio = 0;
258
259	my %undo = (
260	registry => $registry,
261	cb => [],
262	);
263
264	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
265
266	while (@arg) {
267	my $type = shift @arg;
268
269	if ($type eq "prio") {
270	$prio = shift @arg;
271
272	} elsif ($type eq "package") {
273	my $pkg = shift @arg;
274
275	while (my ($name, $id) = each %cb_id) {
276	if (my $cb = $pkg->can ($name)) {
277	_attach_cb $registry, %undo, $id, $prio, $cb;
278	}
279	}	500	}
280
281	} elsif (exists $cb_id{$type}) {
282	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
283
284	} elsif (ref $type) {
285	warn "attaching objects not supported, ignoring.\n";
286
287	} else {
288	shift @arg;
289	warn "attach argument '$type' not supported, ignoring.\n";
290	}
291	}
292
293	\%undo
294	}
295
296	sub _attach_attachment {
297	my ($obj, $name, %arg) = @_;
298
299	return if exists $obj->{_attachment}{$name};
300
301	my $res;
302
303	if (my $attach = $attachment{$name}) {
304	my $registry = $obj->registry;
305
306	for (@$attach) {
307	my ($klass, @attach) = @$_;
308	$res = _attach @$registry, $klass, @attach;
309	}
310
311	$obj->{$name} = \%arg;
312	} else {
313	warn "object uses attachment '$name' that is not available, postponing.\n";
314	}
315
316	$obj->{_attachment}{$name} = undef;
317
318	$res->{attachment} = $name;
319	$res
320	}
321
322	*cf::object::attach =
323	*cf::player::attach =
324	*cf::map::attach = sub {
325	my ($obj, $name, %arg) = @_;
326
327	_attach_attachment $obj, $name, %arg;
328	};
329
330	# all those should be optimised
331	*cf::object::detach =
332	*cf::player::detach =
333	*cf::map::detach = sub {
334	my ($obj, $name) = @_;
335
336	delete $obj->{_attachment}{$name};
337	reattach ($obj);
338	};
339
340	*cf::object::attached =
341	*cf::player::attached =
342	*cf::map::attached = sub {
343	my ($obj, $name) = @_;
344
345	exists $obj->{_attachment}{$name}
346	};
347
348	sub attach_global {
349	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
350	}
351
352	sub attach_to_type {
353	my $type = shift;
354	my $subtype = shift;
355
356	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
357	}
358
359	sub attach_to_objects {
360	_attach @CB_OBJECT, KLASS_OBJECT, @_
361	}
362
363	sub attach_to_players {
364	_attach @CB_PLAYER, KLASS_PLAYER, @_
365	}
366
367	sub attach_to_maps {
368	_attach @CB_MAP, KLASS_MAP, @_
369	}
370
371	sub register_attachment {
372	my $name = shift;
373
374	$attachment{$name} = [[KLASS_OBJECT, @_]];
375	}
376
377	sub register_player_attachment {
378	my $name = shift;
379
380	$attachment{$name} = [[KLASS_PLAYER, @_]];
381	}
382
383	sub register_map_attachment {
384	my $name = shift;
385
386	$attachment{$name} = [[KLASS_MAP, @_]];
387	}
388
389	our $override;
390	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
391
392	sub override {
393	$override = 1;
394	@invoke_results = ();
395	}
396
397	sub do_invoke {
398	my $event = shift;
399	my $callbacks = shift;
400
401	@invoke_results = ();
402
403	local $override;
404
405	for (@$callbacks) {
406	eval { &{$_->[1]} };
407
408	if ($@) {
409	warn "$@";
410	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
411	override;
412	}
413
414	return 1 if $override;
415	}
416
417	0	501	}
418	}
419		502
420	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	503	=item $attachable->valid
421
422	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
423
424	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
425
426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428	Generate a global/object/player/map-specific event with the given arguments.
429
430	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
431	removed in future versions), and there is no public API to access override
432	results (if you must, access C<@cf::invoke_results> directly).
433
434	=back
435
436	=cut
437
438	#############################################################################
439
440	=head2 METHODS VALID FOR ALL CORE OBJECTS
441
442	=over 4
443
444	=item $object->valid, $player->valid, $map->valid
445		504
446	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
447	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
448	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
449	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
450	exception.	509	exception.
451		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
452	=back	700	=back
453		701
454	=cut	702	=cut
455
456	*cf::object::valid =
457	*cf::player::valid =
458	*cf::map::valid = \&cf::_valid;
459		703
460	#############################################################################	704	#############################################################################
461	# object support	705	# object support
462		706
463	sub instantiate {
464	my ($obj, $data) = @_;
465
466	$data = from_json $data;
467
468	for (@$data) {
469	my ($name, $args) = @$_;
470
471	$obj->attach ($name, %{$args || {} });
472	}
473	}
474
475	# basically do the same as instantiate, without calling instantiate
476	sub reattach {	707	sub reattach {
		708	# basically do the same as instantiate, without calling instantiate
477	my ($obj) = @_;	709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		712
478	my $registry = $obj->registry;	713	my $registry = $obj->registry;
479		714
480	@$registry = ();	715	@$registry = ();
481		716
482	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	717	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
483		718
484	for my $name (keys %{ $obj->{_attachment} || {} }) {	719	for my $name (keys %{ $obj->{_attachment} || {} }) {
485	if (my $attach = $attachment{$name}) {	720	if (my $attach = $attachment{$name}) {
486	for (@$attach) {	721	for (@$attach) {
487	my ($klass, @attach) = @$_;	722	my ($klass, @attach) = @$_;
488	_attach @$registry, $klass, @attach;	723	_attach $registry, $klass, @attach;
489	}	724	}
490	} else {	725	} else {
491	warn "object uses attachment '$name' that is not available, postponing.\n";	726	warn "object uses attachment '$name' that is not available, postponing.\n";
492	}	727	}
493	}	728	}
494	}	729	}
495		730
496	sub object_freezer_save {	731	cf::attachable->attach (
497	my ($filename, $rdata, $objs) = @_;
498
499	if (length $$rdata) {
500	warn sprintf "saving %s (%d,%d)\n",
501	$filename, length $$rdata, scalar @$objs;
502
503	if (open my $fh, ">:raw", "$filename~") {
504	chmod SAVE_MODE, $fh;
505	syswrite $fh, $$rdata;
506	close $fh;
507
508	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
509	chmod SAVE_MODE, $fh;
510	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
511	close $fh;
512	rename "$filename.pst~", "$filename.pst";
513	} else {
514	unlink "$filename.pst";
515	}
516
517	rename "$filename~", $filename;
518	} else {
519	warn "FATAL: $filename~: $!\n";
520	}
521	} else {
522	unlink $filename;
523	unlink "$filename.pst";
524	}
525	}
526
527	sub object_thawer_load {
528	my ($filename) = @_;
529
530	local $/;
531
532	my $av;
533
534	#TODO: use sysread etc.
535	if (open my $data, "<:raw:perlio", $filename) {
536	$data = <$data>;
537	if (open my $pst, "<:raw:perlio", "$filename.pst") {
538	$av = eval { (Storable::thaw <$pst>)->{objs} };
539	}
540	return ($data, $av);
541	}
542
543	()
544	}
545
546	attach_to_objects
547	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,
548	on_clone => sub {	745	on_clone => sub {
549	my ($src, $dst) = @_;	746	my ($src, $dst) = @_;
550		747
551	@{$dst->registry} = @{$src->registry};	748	@{$dst->registry} = @{$src->registry};
552		749
553	%$dst = %$src;	750	%$dst = %$src;
554		751
555	%{$dst->{_attachment}} = %{$src->{_attachment}}	752	%{$dst->{_attachment}} = %{$src->{_attachment}}
556	if exists $src->{_attachment};	753	if exists $src->{_attachment};
557	},	754	},
558	;	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	}
559		830
560	#############################################################################	831	#############################################################################
561	# old plug-in events	832	# command handling &c
562		833
563	sub inject_event {	834	=item cf::register_command $name => \&callback($ob,$args);
564	my $extension = shift;
565	my $event_code = shift;
566		835
567	my $cb = $hook[$event_code]{$extension}	836	Register a callback for execution when the client sends the user command
568	or return;	837	$name.
569		838
570	&$cb	839	=cut
571	}
572
573	sub inject_global_event {
574	my $event = shift;
575
576	my $cb = $hook[$event]
577	or return;
578
579	List::Util::max map &$_, values %$cb
580	}
581
582	sub inject_command {
583	my ($name, $obj, $params) = @_;
584
585	for my $cmd (@{ $command{$name} }) {
586	$cmd->[1]->($obj, $params);
587	}
588
589	-1
590	}
591		840
592	sub register_command {	841	sub register_command {
593	my ($name, $time, $cb) = @_;	842	my ($name, $cb) = @_;
594		843
595	my $caller = caller;	844	my $caller = caller;
596	#warn "registering command '$name/$time' to '$caller'";	845	#warn "registering command '$name/$time' to '$caller'";
597		846
598	push @{ $command{$name} }, [$time, $cb, $caller];	847	push @{ $COMMAND{$name} }, [$caller, $cb];
599	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
600	}	848	}
		849
		850	=item cf::register_extcmd $name => \&callback($pl,$packet);
		851
		852	Register a callbackf ro execution when the client sends an extcmd packet.
		853
		854	If the callback returns something, it is sent back as if reply was being
		855	called.
		856
		857	=cut
601		858
602	sub register_extcmd {	859	sub register_extcmd {
603	my ($name, $cb) = @_;	860	my ($name, $cb) = @_;
604		861
605	my $caller = caller;	862	$EXTCMD{$name} = $cb;
606	#warn "registering extcmd '$name' to '$caller'";
607
608	$extcmd{$name} = [$cb, $caller];
609	}	863	}
610		864
611	sub register {	865	cf::player->attach (
612	my ($base, $pkg) = @_;	866	on_command => sub {
		867	my ($pl, $name, $params) = @_;
613		868
614	#TODO	869	my $cb = $COMMAND{$name}
615	}	870	or return;
		871
		872	for my $cmd (@$cb) {
		873	$cmd->[1]->($pl->ob, $params);
		874	}
		875
		876	cf::override;
		877	},
		878	on_extcmd => sub {
		879	my ($pl, $buf) = @_;
		880
		881	my $msg = eval { from_json $buf };
		882
		883	if (ref $msg) {
		884	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		885	if (my %reply = $cb->($pl, $msg)) {
		886	$pl->ext_reply ($msg->{msgid}, %reply);
		887	}
		888	}
		889	} else {
		890	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		891	}
		892
		893	cf::override;
		894	},
		895	);
616		896
617	sub load_extension {	897	sub load_extension {
618	my ($path) = @_;	898	my ($path) = @_;
619		899
620	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
621	my $base = $1;	901	my $base = $1;
622	my $pkg = $1;	902	my $pkg = $1;
623	$pkg =~ s/[^[:word:]]/_/g;	903	$pkg =~ s/[^[:word:]]/_/g;
624	$pkg = "ext::$pkg";	904	$pkg = "ext::$pkg";
625		905
626	warn "loading '$path' into '$pkg'\n";	906	warn "... loading '$path' into '$pkg'\n";
627		907
628	open my $fh, "<:utf8", $path	908	open my $fh, "<:utf8", $path
629	or die "$path: $!";	909	or die "$path: $!";
630		910
631	my $source =	911	my $source =
632	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8;\n"
633	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
634	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
635	. "\n};\n1";	915	. "\n};\n1";
636		916
637	eval $source	917	unless (eval $source) {
638	or die "$path: $@";	918	my $msg = $@ ? "$path: $@\n"
639		919	: "extension disabled.\n";
640	push @exts, $pkg;	920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
641	$ext_pkg{$base} = $pkg;	921	warn $@;
642		922	warn "mandatory extension failed to load, exiting.\n";
643	# no strict 'refs';	923	exit 1;
644	# @{"$pkg\::ISA"} = ext::;	924	}
645		925	die $@;
646	register $base, $pkg;
647	}
648
649	sub unload_extension {
650	my ($pkg) = @_;
651
652	warn "removing extension $pkg\n";
653
654	# remove hooks
655	#TODO
656	# for my $idx (0 .. $#PLUGIN_EVENT) {
657	# delete $hook[$idx]{$pkg};
658	# }	926	}
659		927
660	# remove commands	928	push @EXTS, $pkg;
661	for my $name (keys %command) {
662	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
663
664	if (@cb) {
665	$command{$name} = \@cb;
666	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
667	} else {
668	delete $command{$name};
669	delete $COMMAND{"$name\000"};
670	}
671	}
672
673	# remove extcmds
674	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
675	delete $extcmd{$name};
676	}
677
678	if (my $cb = $pkg->can ("unload")) {
679	eval {
680	$cb->($pkg);
681	1
682	} or warn "$pkg unloaded, but with errors: $@";
683	}
684
685	Symbol::delete_package $pkg;
686	}	929	}
687		930
688	sub load_extensions {	931	sub load_extensions {
689	my $LIBDIR = maps_directory "perl";
690
691	for my $ext (<$LIBDIR/*.ext>) {	932	for my $ext (<$LIBDIR/*.ext>) {
692	next unless -r $ext;	933	next unless -r $ext;
693	eval {	934	eval {
694	load_extension $ext;	935	load_extension $ext;
695	1	936	1
696	} or warn "$ext not loaded: $@";	937	} or warn "$ext not loaded: $@";
697	}	938	}
698	}	939	}
699		940
700	#############################################################################	941	#############################################################################
701	# extcmd framework, basically convert ext <msg>
702	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
703		942
704	attach_to_players	943	=head2 CORE EXTENSIONS
705	on_extcmd => sub {	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 {
706	my ($pl, $buf) = @_;	1465	my ($self, $ob) = @_;
707		1466
708	my $msg = eval { from_json $buf };	1467	return find "~" . $ob->name . "/" . $self->{path}
		1468	if $self->per_player;
709		1469
710	if (ref $msg) {	1470	$self
711	if (my $cb = $extcmd{$msg->{msgtype}}) {	1471	}
712	if (my %reply = $cb->[0]->($pl, $msg)) {	1472
713	$pl->ext_reply ($msg->{msgid}, %reply);	1473	# find and load all maps in the 3x3 area around a map
714	}	1474	sub load_diag {
		1475	my ($map) = @_;
		1476
		1477	my @diag; # diagonal neighbours
		1478
		1479	for (0 .. 3) {
		1480	my $neigh = $map->tile_path ($_)
		1481	or next;
		1482	$neigh = find $neigh, $map
		1483	or next;
		1484	$neigh->load;
		1485
		1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1488	}
		1489
		1490	for (@diag) {
		1491	my $neigh = find @$_
		1492	or next;
		1493	$neigh->load;
		1494	}
		1495	}
		1496
		1497	sub find_sync {
		1498	my ($path, $origin) = @_;
		1499
		1500	cf::sync_job { find $path, $origin }
		1501	}
		1502
		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};
715	}	1530	}
		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);
716	} else {	1564	} else {
717	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);
718	}
719
720	cf::override;
721	},	1566	}
722	;	1567	}
723		1568
724	#############################################################################	1569	sub swap_out {
725	# load/save/clean perl data associated with a map
726
727	*cf::mapsupport::on_clean = sub {
728	my ($map) = @_;	1570	my ($self) = @_;
729		1571
730	my $path = $map->tmpname;	1572	# save first because save cedes
731	defined $path or return;	1573	$self->save;
732		1574
733	unlink "$path.pst";	1575	my $lock = cf::lock_acquire "map_data:" . $self->path;
734	};
735		1576
736	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};
737		1580
738	#############################################################################	1581	$self->clear;
739	# load/save perl data associated with player->ob objects	1582	$self->in_memory (cf::MAP_SWAPPED);
740
741	sub all_objects(@) {
742	@_, map all_objects ($_->inv), @_
743	}	1583	}
744		1584
745	# TODO: compatibility cruft, remove when no longer needed	1585	sub reset_at {
746	attach_to_players	1586	my ($self) = @_;
747	on_load => sub {
748	my ($pl, $path) = @_;
749		1587
750	for my $o (all_objects $pl->ob) {	1588	# TODO: safety, remove and allow resettable per-player maps
751	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
752	$o->set_ob_key_value ("_perl_data");	1590	return 1e99 if $self->{deny_reset};
753		1591
754	%$o = %{ Storable::thaw pack "H*", $value };	1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
755	}	1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
756	}	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;
757	},	1622	}
758	;
759		1623
760	#############################################################################	1624	delete $cf::MAP{$self->path};
761		1625
762	=head2 CORE EXTENSIONS	1626	$self->clear;
763		1627
764	Functions and methods that extend core crossfire objects.	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;
765		1687
766	=over 4	1688	=over 4
767		1689
768	=item cf::player::exists $login	1690	=item $ob->inv_recursive
769		1691
770	Returns true when the given account exists.	1692	Returns the inventory of the object _and_ their inventories, recursively.
771		1693
772	=cut	1694	=cut
773		1695
774	sub cf::player::exists($) {	1696	sub inv_recursive_;
775	cf::player::find $_[0]	1697	sub inv_recursive_ {
776	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1698	map { $_, inv_recursive_ $_->inv } @_
777	}	1699	}
778		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
779	=item $object->reply ($npc, $msg[, $flags])	1713	=item $player_object->reply ($npc, $msg[, $flags])
780		1714
781	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>
782	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
783	dialogue with the given NPC character.	1717	dialogue with the given NPC character.
784		1718
785	=cut	1719	=cut
786		1720
787	# rough implementation of a future "reply" method that works	1721	# rough implementation of a future "reply" method that works
788	# with dialog boxes.	1722	# with dialog boxes.
		1723	#TODO: the first argument must go, split into a $npc->reply_to ( method
789	sub cf::object::player::reply($$$;$) {	1724	sub cf::object::player::reply($$$;$) {
790	my ($self, $npc, $msg, $flags) = @_;	1725	my ($self, $npc, $msg, $flags) = @_;
791		1726
792	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1727	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
793		1728
…		…
797	$msg = $npc->name . " says: $msg" if $npc;	1732	$msg = $npc->name . " says: $msg" if $npc;
798	$self->message ($msg, $flags);	1733	$self->message ($msg, $flags);
799	}	1734	}
800	}	1735	}
801		1736
802	=item $player->ext_reply ($msgid, $msgtype, %msg)	1737	=item $player_object->may ("access")
803		1738
804	Sends an ext reply to the player.	1739	Returns wether the given player is authorized to access resource "access"
		1740	(e.g. "command_wizcast").
805		1741
806	=cut	1742	=cut
807		1743
808	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	$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 {
809	my ($self, $id, %msg) = @_;	1939	my ($self, $exit) = @_;
810		1940
811	$msg{msgid} = $id;	1941	return unless $self->type == cf::PLAYER;
812		1942
813	$self->send ("ext " . to_json \%msg);	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);
814	}	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	);
815		2071
816	=back	2072	=back
817		2073
818	=cut
819
820	#############################################################################
821		2074
822	=head2 SAFE SCRIPTING	2075	=head2 SAFE SCRIPTING
823		2076
824	Functions that provide a safe environment to compile and execute	2077	Functions that provide a safe environment to compile and execute
825	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
826	itself. Looping constructs, I/O operators and other built-in functionality	2079	itself. Looping constructs, I/O operators and other built-in functionality
827	is not available in the safe scripting environment, and the number of	2080	is not available in the safe scripting environment, and the number of
828	functions and methods that cna be called is greatly reduced.	2081	functions and methods that can be called is greatly reduced.
829		2082
830	=cut	2083	=cut
831		2084
832	our $safe = new Safe "safe";	2085	our $safe = new Safe "safe";
833	our $safe_hole = new Safe::Hole;	2086	our $safe_hole = new Safe::Hole;
…		…
840		2093
841	=pod	2094	=pod
842		2095
843	The following fucntions and emthods are available within a safe environment:	2096	The following fucntions and emthods are available within a safe environment:
844		2097
845	cf::object contr pay_amount pay_player	2098	cf::object contr pay_amount pay_player map
846	cf::object::player player	2099	cf::object::player player
847	cf::player peaceful	2100	cf::player peaceful
		2101	cf::map trigger
848		2102
849	=cut	2103	=cut
850		2104
851	for (	2105	for (
852	["cf::object" => qw(contr pay_amount pay_player)],	2106	["cf::object" => qw(contr pay_amount pay_player map)],
853	["cf::object::player" => qw(player)],	2107	["cf::object::player" => qw(player)],
854	["cf::player" => qw(peaceful)],	2108	["cf::player" => qw(peaceful)],
		2109	["cf::map" => qw(trigger)],
855	) {	2110	) {
856	no strict 'refs';	2111	no strict 'refs';
857	my ($pkg, @funs) = @$_;	2112	my ($pkg, @funs) = @$_;
858	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2113	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
859	for @funs;	2114	for @funs;
…		…
939	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
940	using it, it should be unique.	2195	using it, it should be unique.
941		2196
942	=over 4	2197	=over 4
943		2198
944	=item $hashref = cf::db_get $family
945
946	Return a hashref for use by the extension C<$family>, which can be
947	modified. After modifications, you have to call C<cf::db_dirty> or
948	C<cf::db_sync>.
949
950	=item $value = cf::db_get $family => $key	2199	=item $value = cf::db_get $family => $key
951		2200
952	Returns a single value from the database	2201	Returns a single value from the database.
953
954	=item cf::db_put $family => $hashref
955
956	Stores the given family hashref into the database. Updates are delayed, if
957	you want the data to be synced to disk immediately, use C<cf::db_sync>.
958		2202
959	=item cf::db_put $family => $key => $value	2203	=item cf::db_put $family => $key => $value
960		2204
961	Stores the given C<$value> in the family hash. Updates are delayed, if you	2205	Stores the given C<$value> in the family.
962	want the data to be synced to disk immediately, use C<cf::db_sync>.
963		2206
964	=item cf::db_dirty
965
966	Marks the database as dirty, to be updated at a later time.
967
968	=item cf::db_sync
969
970	Immediately write the database to disk I<if it is dirty>.
971
972	=cut	2207	=cut
973		2208
974	{	2209	our $DB;
975	my $db;	2210
		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
976	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;
977		2230
978	sub db_load() {	2231	cf::db_put (board => data => $pst->{board});
979	warn "loading database $path\n";#d# remove later	2232	cf::db_put (guildrules => data => $pst->{guildrules});
980	$db = stat $path ? Storable::retrieve $path : { };	2233	cf::db_put (rent => balance => $pst->{rent}{balance});
981	}	2234	BDB::db_env_txn_checkpoint $DB_ENV;
982		2235
983	my $pid;	2236	unlink $path;
984
985	sub db_save() {
986	warn "saving database $path\n";#d# remove later
987	waitpid $pid, 0 if $pid;
988	if (0 == ($pid = fork)) {
989	$db->{_meta}{version} = 1;
990	Storable::nstore $db, "$path~";
991	rename "$path~", $path;
992	cf::_exit 0 if defined $pid;
993	}	2237	};
994	}
995
996	my $dirty;
997
998	sub db_sync() {
999	db_save if $dirty;
1000	undef $dirty;
1001	}
1002
1003	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1004	db_sync;
1005	});
1006
1007	sub db_dirty() {
1008	$dirty = 1;
1009	$idle->start;
1010	}
1011
1012	sub db_get($;$) {
1013	@_ >= 2
1014	? $db->{$_[0]}{$_[1]}
1015	: ($db->{$_[0]} ||= { })
1016	}
1017
1018	sub db_put($$;$) {
1019	if (@_ >= 3) {
1020	$db->{$_[0]}{$_[1]} = $_[2];
1021	} else {
1022	$db->{$_[0]} = $_[1];
1023	}
1024	db_dirty;
1025	}
1026
1027	attach_global
1028	prio => 10000,
1029	on_cleanup => sub {
1030	db_sync;
1031	},	2238	}
1032	;	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 { };
1033	}	2256	}
1034		2257
1035	#############################################################################	2258	#############################################################################
1036	# 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	}
1037		2265
1038	sub cfg_load {	2266	sub cfg_load {
1039	open my $fh, "<:utf8", cf::confdir . "/config"	2267	open my $fh, "<:utf8", cf::confdir . "/config"
1040	or return;	2268	or return;
1041		2269
1042	local $/;	2270	local $/;
1043	*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;
1044	}	2289	}
1045		2290
1046	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
1047	cfg_load;	2300	cfg_load;
1048	db_load;	2301	db_init;
1049	load_extensions;	2302	load_extensions;
		2303
		2304	$TICK_WATCHER->start;
		2305	$WRITE_RUNTIME_WATCHER->start;
1050	Event::loop;	2306	Event::loop;
1051	}	2307	}
1052		2308
1053	#############################################################################	2309	#############################################################################
1054	# initialisation	2310	# initialisation and cleanup
1055		2311
		2312	# install some emergency cleanup handlers
		2313	BEGIN {
		2314	for my $signal (qw(INT HUP TERM)) {
		2315	Event->signal (
		2316	reentrant => 0,
		2317	data => WF_AUTOCANCEL,
		2318	signal => $signal,
		2319	prio => 0,
		2320	cb => sub {
		2321	cf::cleanup "SIG$signal";
		2322	},
		2323	);
		2324	}
		2325	}
		2326
		2327	sub emergency_save() {
		2328	my $freeze_guard = cf::freeze_mainloop;
		2329
		2330	warn "enter emergency perl save\n";
		2331
		2332	cf::sync_job {
		2333	# use a peculiar iteration method to avoid tripping on perl
		2334	# refcount bugs in for. also avoids problems with players
		2335	# and maps saved/destroyed asynchronously.
		2336	warn "begin emergency player save\n";
		2337	for my $login (keys %cf::PLAYER) {
		2338	my $pl = $cf::PLAYER{$login} or next;
		2339	$pl->valid or next;
		2340	$pl->save;
		2341	}
		2342	warn "end emergency player save\n";
		2343
		2344	warn "begin emergency map save\n";
		2345	for my $path (keys %cf::MAP) {
		2346	my $map = $cf::MAP{$path} or next;
		2347	$map->valid or next;
		2348	$map->save;
		2349	}
		2350	warn "end emergency map save\n";
		2351
		2352	warn "begin emergency database checkpoint\n";
		2353	BDB::db_env_txn_checkpoint $DB_ENV;
		2354	warn "end emergency database checkpoint\n";
		2355	};
		2356
		2357	warn "leave emergency perl save\n";
		2358	}
		2359
		2360	sub post_cleanup {
		2361	my ($make_core) = @_;
		2362
		2363	warn Carp::longmess "post_cleanup backtrace"
		2364	if $make_core;
		2365	}
		2366
1056	sub _perl_reload(&) {	2367	sub reload() {
1057	my ($msg) = @_;	2368	# can/must only be called in main
		2369	if ($Coro::current != $Coro::main) {
		2370	warn "can only reload from main coroutine";
		2371	return;
		2372	}
1058		2373
1059	$msg->("reloading...");	2374	warn "reloading...";
1060		2375
1061	eval {	2376	warn "entering sync_job";
1062	# cancel all watchers	2377
		2378	cf::sync_job {
		2379	cf::write_runtime;
		2380	cf::emergency_save;
		2381	cf::write_runtime;
		2382
		2383	warn "syncing database to disk";
		2384	BDB::db_env_txn_checkpoint $DB_ENV;
		2385
		2386	# if anything goes wrong in here, we should simply crash as we already saved
		2387
		2388	warn "cancelling all WF_AUTOCANCEL watchers";
1063	$_->cancel for Event::all_watchers;	2389	for (Event::all_watchers) {
		2390	$_->cancel if $_->data & WF_AUTOCANCEL;
		2391	}
1064		2392
1065	# unload all extensions	2393	warn "flushing outstanding aio requests";
1066	for (@exts) {	2394	for (;;) {
1067	$msg->("unloading <$_>");	2395	BDB::flush;
1068	unload_extension $_;	2396	IO::AIO::flush;
		2397	Coro::cede;
		2398	last unless IO::AIO::nreqs || BDB::nreqs;
		2399	warn "iterate...";
		2400	}
		2401
		2402	warn "cancelling all extension coros";
		2403	$_->cancel for values %EXT_CORO;
		2404	%EXT_CORO = ();
		2405
		2406	warn "removing commands";
		2407	%COMMAND = ();
		2408
		2409	warn "removing ext commands";
		2410	%EXTCMD = ();
		2411
		2412	warn "unloading/nuking all extensions";
		2413	for my $pkg (@EXTS) {
		2414	warn "... unloading $pkg";
		2415
		2416	if (my $cb = $pkg->can ("unload")) {
		2417	eval {
		2418	$cb->($pkg);
		2419	1
		2420	} or warn "$pkg unloaded, but with errors: $@";
1069	}	2421	}
1070		2422
		2423	warn "... nuking $pkg";
		2424	Symbol::delete_package $pkg;
		2425	}
		2426
1071	# unload all modules loaded from $LIBDIR	2427	warn "unloading all perl modules loaded from $LIBDIR";
1072	while (my ($k, $v) = each %INC) {	2428	while (my ($k, $v) = each %INC) {
1073	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2429	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1074		2430
1075	$msg->("removing <$k>");	2431	warn "... unloading $k";
1076	delete $INC{$k};	2432	delete $INC{$k};
1077		2433
1078	$k =~ s/\.pm$//;	2434	$k =~ s/\.pm$//;
1079	$k =~ s/\//::/g;	2435	$k =~ s/\//::/g;
1080		2436
…		…
1083	}	2439	}
1084		2440
1085	Symbol::delete_package $k;	2441	Symbol::delete_package $k;
1086	}	2442	}
1087		2443
1088	# sync database to disk
1089	cf::db_sync;
1090
1091	# get rid of safe::, as good as possible	2444	warn "getting rid of safe::, as good as possible";
1092	Symbol::delete_package "safe::$_"	2445	Symbol::delete_package "safe::$_"
1093	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2446	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1094		2447
1095	# remove register_script_function callbacks
1096	# TODO
1097
1098	# unload cf.pm "a bit"	2448	warn "unloading cf.pm \"a bit\"";
1099	delete $INC{"cf.pm"};	2449	delete $INC{"cf.pm"};
1100		2450
1101	# don't, removes xs symbols, too,	2451	# don't, removes xs symbols, too,
1102	# and global variables created in xs	2452	# and global variables created in xs
1103	#Symbol::delete_package __PACKAGE__;	2453	#Symbol::delete_package __PACKAGE__;
1104		2454
1105	# reload cf.pm	2455	warn "unload completed, starting to reload now";
		2456
1106	$msg->("reloading cf.pm");	2457	warn "reloading cf.pm";
1107	require cf;	2458	require cf;
		2459	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1108		2460
1109	# load config and database again	2461	warn "loading config and database again";
1110	cf::cfg_load;	2462	cf::cfg_load;
1111	cf::db_load;
1112		2463
1113	# load extensions	2464	warn "loading extensions";
1114	$msg->("load extensions");
1115	cf::load_extensions;	2465	cf::load_extensions;
1116		2466
1117	# reattach attachments to objects	2467	warn "reattaching attachments to objects/players";
1118	$msg->("reattach");
1119	_global_reattach;	2468	_global_reattach;
		2469	warn "reattaching attachments to maps";
		2470	reattach $_ for values %MAP;
		2471
		2472	warn "loading reloadable resources";
		2473	load_resources;
		2474
		2475	warn "leaving sync_job";
		2476
		2477	1
		2478	} or do {
		2479	warn $@;
		2480	warn "error while reloading, exiting.";
		2481	exit 1;
1120	};	2482	};
1121	$msg->($@) if $@;
1122		2483
1123	$msg->("reloaded");	2484	warn "reloaded";
1124	};	2485	};
1125		2486
1126	sub perl_reload() {	2487	our $RELOAD_WATCHER; # used only during reload
1127	_perl_reload {
1128	warn $_[0];
1129	print "$_[0]\n";
1130	};
1131	}
1132		2488
1133	register_command "perl-reload", 0, sub {	2489	register_command "reload" => sub {
1134	my ($who, $arg) = @_;	2490	my ($who, $arg) = @_;
1135		2491
1136	if ($who->flag (FLAG_WIZ)) {	2492	if ($who->flag (FLAG_WIZ)) {
1137	_perl_reload {	2493	$who->message ("reloading server.");
1138	warn $_[0];	2494
1139	$who->message ($_[0]);	2495	# doing reload synchronously and two reloads happen back-to-back,
		2496	# coro crashes during coro_state_free->destroy here.
		2497
		2498	$RELOAD_WATCHER ||= Event->timer (
		2499	reentrant => 0,
		2500	after => 0,
		2501	data => WF_AUTOCANCEL,
		2502	cb => sub {
		2503	reload;
		2504	undef $RELOAD_WATCHER;
		2505	},
1140	};	2506	);
1141	}	2507	}
1142	};	2508	};
1143		2509
1144	register "<global>", __PACKAGE__;
1145
1146	unshift @INC, $LIBDIR;	2510	unshift @INC, $LIBDIR;
1147		2511
		2512	my $bug_warning = 0;
		2513
1148	$TICK_WATCHER = Event->timer (	2514	$TICK_WATCHER = Event->timer (
		2515	reentrant => 0,
		2516	parked => 1,
1149	prio => 1,	2517	prio => 0,
1150	at => $NEXT_TICK || 1,	2518	at => $NEXT_TICK || $TICK,
		2519	data => WF_AUTOCANCEL,
1151	cb => sub {	2520	cb => sub {
		2521	if ($Coro::current != $Coro::main) {
		2522	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2523	unless ++$bug_warning > 10;
		2524	return;
		2525	}
		2526
		2527	$NOW = Event::time;
		2528
1152	cf::server_tick; # one server iteration	2529	cf::server_tick; # one server iteration
1153		2530	$RUNTIME += $TICK;
1154	my $NOW = Event::time;
1155	$NEXT_TICK += $TICK;	2531	$NEXT_TICK += $TICK;
1156		2532
		2533	$WAIT_FOR_TICK->broadcast;
		2534	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2535
		2536	# my $AFTER = Event::time;
		2537	# warn $AFTER - $NOW;#d#
		2538
1157	# if we are delayed by four ticks, skip them all	2539	# if we are delayed by four ticks or more, skip them all
1158	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2540	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1159		2541
1160	$TICK_WATCHER->at ($NEXT_TICK);	2542	$TICK_WATCHER->at ($NEXT_TICK);
1161	$TICK_WATCHER->start;	2543	$TICK_WATCHER->start;
1162	},	2544	},
1163	);	2545	);
1164		2546
		2547	{
		2548	BDB::max_poll_time $TICK * 0.1;
		2549	$BDB_POLL_WATCHER = Event->io (
		2550	reentrant => 0,
		2551	fd => BDB::poll_fileno,
		2552	poll => 'r',
		2553	prio => 0,
		2554	data => WF_AUTOCANCEL,
		2555	cb => \&BDB::poll_cb,
		2556	);
		2557	BDB::min_parallel 8;
		2558
		2559	BDB::set_sync_prepare {
		2560	my $status;
		2561	my $current = $Coro::current;
		2562	(
		2563	sub {
		2564	$status = $!;
		2565	$current->ready; undef $current;
		2566	},
		2567	sub {
		2568	Coro::schedule while defined $current;
		2569	$! = $status;
		2570	},
		2571	)
		2572	};
		2573
		2574	unless ($DB_ENV) {
		2575	$DB_ENV = BDB::db_env_create;
		2576
		2577	cf::sync_job {
		2578	eval {
		2579	BDB::db_env_open
		2580	$DB_ENV,
		2581	$BDB_ENV_DIR,
		2582	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2583	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2584	0666;
		2585
		2586	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2587
		2588	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2589	$DB_ENV->set_lk_detect;
		2590	};
		2591
		2592	cf::cleanup "db_env_open(db): $@" if $@;
		2593	};
		2594	}
		2595	}
		2596
		2597	{
		2598	IO::AIO::min_parallel 8;
		2599
		2600	undef $Coro::AIO::WATCHER;
		2601	IO::AIO::max_poll_time $TICK * 0.1;
		2602	$AIO_POLL_WATCHER = Event->io (
		2603	reentrant => 0,
		2604	fd => IO::AIO::poll_fileno,
		2605	poll => 'r',
		2606	prio => 6,
		2607	data => WF_AUTOCANCEL,
		2608	cb => \&IO::AIO::poll_cb,
		2609	);
		2610	}
		2611
		2612	$WRITE_RUNTIME_WATCHER = Event->timer (
		2613	reentrant => 0,
		2614	data => WF_AUTOCANCEL,
		2615	parked => 1,
		2616	after => 1,
		2617	interval => 10,
		2618	prio => 6, # keep it lowest so it acts like a watchdog
		2619	cb => sub {
		2620	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
		2621
		2622	Coro::async_pool {
		2623	write_runtime
		2624	or warn "ERROR: unable to write runtime file: $!";
		2625	};
		2626	},
		2627	);
		2628
		2629	END { cf::emergency_save }
		2630
1165	1	2631	1
1166		2632

Diff Legend

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