ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

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

Diff Legend

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