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.85 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.186 by root, Sat Jan 20 01:12:39 2007 UTC

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

Diff Legend

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