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

Diff Legend

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