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.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.226 by root, Wed Mar 14 04:12:29 2007 UTC

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

Diff Legend

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