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.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.214 by root, Wed Feb 14 00:40:05 2007 UTC

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

Diff Legend

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