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

Diff Legend

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