ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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