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

Diff Legend

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