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

Diff Legend

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