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

Diff Legend

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