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

Diff Legend

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