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

Diff Legend

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