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

Diff Legend

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