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

Diff Legend

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