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

Diff Legend

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