ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.167 by root, Sat Jan 13 23:32:43 2007 UTC

15use Coro::Timer; 15use Coro::Timer;
16use Coro::Signal; 16use Coro::Signal;
17use Coro::Semaphore; 17use Coro::Semaphore;
18use Coro::AIO; 18use Coro::AIO;
19 19
20use Data::Dumper;
20use Digest::MD5; 21use Digest::MD5;
21use Fcntl; 22use Fcntl;
22use IO::AIO 2.31 (); 23use IO::AIO 2.32 ();
23use YAML::Syck (); 24use YAML::Syck ();
24use Time::HiRes; 25use Time::HiRes;
25 26
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
27 28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
28# 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?
29$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
30 33
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 35
35our %COMMAND = (); 36our %COMMAND = ();
36our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 40our %EXTCMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps
38 43
39our @EVENT; 44our @EVENT;
40our $LIBDIR = datadir . "/ext"; 45our $LIBDIR = datadir . "/ext";
41 46
42our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
47our %CFG; 52our %CFG;
48 53
49our $UPTIME; $UPTIME ||= time; 54our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 55our $RUNTIME;
51 56
57our %PLAYER; # all users
52our %MAP; # all maps 58our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 59our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random"; 60our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO; 61
62our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
63our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
64
65# used to convert map paths into valid unix filenames by replacing / by ∕
66our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57 67
58binmode STDOUT; 68binmode STDOUT;
59binmode STDERR; 69binmode STDERR;
60 70
61# read virtual server time, if available 71# read virtual server time, if available
69mkdir cf::localdir . "/" . cf::playerdir; 79mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir; 80mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir; 81mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS; 82mkdir $RANDOM_MAPS;
73 83
74# a special map that is always available
75our $LINK_MAP;
76our $EMERGENCY_POSITION; 84our $EMERGENCY_POSITION;
77 85
78############################################################################# 86#############################################################################
79 87
80=head2 GLOBAL VARIABLES 88=head2 GLOBAL VARIABLES
105 113
106=item %cf::CFG 114=item %cf::CFG
107 115
108Configuration for the server, loaded from C</etc/crossfire/config>, or 116Configuration for the server, loaded from C</etc/crossfire/config>, or
109from wherever your confdir points to. 117from wherever your confdir points to.
118
119=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
120
121These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
122or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
123processing has been done. Call C<< ->wait >> on them to maximise the
124window of cpu time available, or simply to synchronise to the server tick.
110 125
111=back 126=back
112 127
113=cut 128=cut
114 129
118 utf8::encode $msg; 133 utf8::encode $msg;
119 134
120 $msg .= "\n" 135 $msg .= "\n"
121 unless $msg =~ /\n$/; 136 unless $msg =~ /\n$/;
122 137
123 LOG llevError, "cfperl: $msg"; 138 LOG llevError, $msg;
124 }; 139 };
125} 140}
126 141
127@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 142@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 143@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146 161
147$Event::DIED = sub { 162$Event::DIED = sub {
148 warn "error in event callback: @_"; 163 warn "error in event callback: @_";
149}; 164};
150 165
151my %ext_pkg;
152my @exts;
153my @hook;
154
155=head2 UTILITY FUNCTIONS 166=head2 UTILITY FUNCTIONS
156 167
157=over 4 168=over 4
158 169
170=item dumpval $ref
171
159=cut 172=cut
173
174sub dumpval {
175 eval {
176 local $SIG{__DIE__};
177 my $d;
178 if (1) {
179 $d = new Data::Dumper([$_[0]], ["*var"]);
180 $d->Terse(1);
181 $d->Indent(2);
182 $d->Quotekeys(0);
183 $d->Useqq(1);
184 #$d->Bless(...);
185 $d->Seen($_[1]) if @_ > 1;
186 $d = $d->Dump();
187 }
188 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
189 $d
190 } || "[unable to dump $_[0]: '$@']";
191}
160 192
161use JSON::Syck (); # TODO# replace by JSON::PC once working 193use JSON::Syck (); # TODO# replace by JSON::PC once working
162 194
163=item $ref = cf::from_json $json 195=item $ref = cf::from_json $json
164 196
180sub to_json($) { 212sub to_json($) {
181 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
182 JSON::Syck::Dump $_[0] 214 JSON::Syck::Dump $_[0]
183} 215}
184 216
185=item my $guard = cf::guard { BLOCK }
186
187Run the given callback when the guard object gets destroyed (useful for
188coroutine cancellations).
189
190You can call C<< ->cancel >> on the guard object to stop the block from
191being executed.
192
193=cut
194
195sub guard(&) {
196 bless \(my $cb = $_[0]), cf::guard::;
197}
198
199sub cf::guard::cancel {
200 ${$_[0]} = sub { };
201}
202
203sub cf::guard::DESTROY {
204 ${$_[0]}->();
205}
206
207=item cf::lock_wait $string 217=item cf::lock_wait $string
208 218
209Wait until the given lock is available. See cf::lock_acquire. 219Wait until the given lock is available. See cf::lock_acquire.
210 220
211=item my $lock = cf::lock_acquire $string 221=item my $lock = cf::lock_acquire $string
212 222
213Wait until the given lock is available and then acquires it and returns 223Wait until the given lock is available and then acquires it and returns
214a guard object. If the guard object gets destroyed (goes out of scope, 224a Coro::guard object. If the guard object gets destroyed (goes out of scope,
215for example when the coroutine gets canceled), the lock is automatically 225for example when the coroutine gets canceled), the lock is automatically
216returned. 226returned.
217 227
218Lock names should begin with a unique identifier (for example, find_map 228Lock names should begin with a unique identifier (for example, cf::map::find
219uses map_find and load_map uses map_load). 229uses map_find and cf::map::load uses map_load).
220 230
221=cut 231=cut
222 232
223our %LOCK; 233our %LOCK;
224 234
238 # wait, to be sure we are not locked 248 # wait, to be sure we are not locked
239 lock_wait $key; 249 lock_wait $key;
240 250
241 $LOCK{$key} = []; 251 $LOCK{$key} = [];
242 252
243 cf::guard { 253 Coro::guard {
244 # wake up all waiters, to be on the safe side 254 # wake up all waiters, to be on the safe side
245 $_->ready for @{ delete $LOCK{$key} }; 255 $_->ready for @{ delete $LOCK{$key} };
246 } 256 }
247} 257}
248 258
259sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active;
261
262 my $guard = Coro::guard { $TICK_WATCHER->start };
263 $TICK_WATCHER->stop;
264 $guard
265}
266
249=item cf::async { BLOCK } 267=item cf::async { BLOCK }
250 268
251Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the 269Currently the same as Coro::async_pool, meaning you cannot use
252error instead of exiting the server in case of a problem. 270C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
271thing you are allowed to do is call C<prio> on it.
253 272
254=cut 273=cut
255 274
256sub async(&) { 275BEGIN { *async = \&Coro::async_pool }
257 my ($cb) = @_;
258
259 Coro::async {
260 eval { $cb->() };
261 warn $@ if $@;
262 }
263}
264 276
265=item cf::sync_job { BLOCK } 277=item cf::sync_job { BLOCK }
266 278
267The design of crossfire+ requires that the main coro ($Coro::main) is 279The design of crossfire+ requires that the main coro ($Coro::main) is
268always able to handle events or runnable, as crossfire+ is only partly 280always able to handle events or runnable, as crossfire+ is only partly
282 # this is the main coro, too bad, we have to block 294 # this is the main coro, too bad, we have to block
283 # till the operation succeeds, freezing the server :/ 295 # till the operation succeeds, freezing the server :/
284 296
285 # TODO: use suspend/resume instead 297 # TODO: use suspend/resume instead
286 # (but this is cancel-safe) 298 # (but this is cancel-safe)
287 local $FREEZE = 1; 299 my $freeze_guard = freeze_mainloop;
288 300
289 my $busy = 1; 301 my $busy = 1;
290 my @res; 302 my @res;
291 303
292 (Coro::async { 304 (async {
293 @res = eval { $job->() }; 305 @res = eval { $job->() };
294 warn $@ if $@; 306 warn $@ if $@;
295 undef $busy; 307 undef $busy;
296 })->prio (Coro::PRIO_MAX); 308 })->prio (Coro::PRIO_MAX);
297 309
298 while ($busy) { 310 while ($busy) {
299 Coro::cede_notself; 311 Coro::cede or Event::one_event;
300 Event::one_event unless Coro::nready;
301 } 312 }
302 313
303 wantarray ? @res : $res[0] 314 wantarray ? @res : $res[0]
304 } else { 315 } else {
305 # we are in another coroutine, how wonderful, everything just works 316 # we are in another coroutine, how wonderful, everything just works
306 317
307 $job->() 318 $job->()
308 } 319 }
309} 320}
310 321
311=item $coro = cf::coro { BLOCK } 322=item $coro = cf::async_ext { BLOCK }
312 323
313Creates and returns a new coro. This coro is automcatially being canceled 324Like async, but this coro is automatically being canceled when the
314when the extension calling this is being unloaded. 325extension calling this is being unloaded.
315 326
316=cut 327=cut
317 328
318sub coro(&) { 329sub async_ext(&) {
319 my $cb = shift; 330 my $cb = shift;
320 331
321 my $coro = &cf::async ($cb); 332 my $coro = &Coro::async ($cb);
322 333
323 $coro->on_destroy (sub { 334 $coro->on_destroy (sub {
324 delete $EXT_CORO{$coro+0}; 335 delete $EXT_CORO{$coro+0};
325 }); 336 });
326 $EXT_CORO{$coro+0} = $coro; 337 $EXT_CORO{$coro+0} = $coro;
327 338
328 $coro 339 $coro
329} 340}
330 341
331sub write_runtime { 342sub write_runtime {
343 return unless $TICK_WATCHER->is_active;
344
332 my $runtime = cf::localdir . "/runtime"; 345 my $runtime = cf::localdir . "/runtime";
333 346
334 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 347 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
335 or return; 348 or return;
336 349
351} 364}
352 365
353=back 366=back
354 367
355=cut 368=cut
356
357#############################################################################
358
359package cf::path;
360
361sub new {
362 my ($class, $path, $base) = @_;
363
364 $path = $path->as_string if ref $path;
365
366 my $self = bless { }, $class;
367
368 # {... are special paths that are not touched
369 # ?xxx/... are special absolute paths
370 # ?random/... random maps
371 # /! non-realised random map exit
372 # /... normal maps
373 # ~/... per-player maps without a specific player (DO NOT USE)
374 # ~user/... per-player map of a specific user
375
376 if ($path =~ /^{/) {
377 # fine as it is
378 } elsif ($path =~ s{^\?random/}{}) {
379 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
380 $self->{random} = cf::from_json $data;
381 } else {
382 if ($path =~ s{^~([^/]+)?}{}) {
383 $self->{user_rel} = 1;
384
385 if (defined $1) {
386 $self->{user} = $1;
387 } elsif ($base =~ m{^~([^/]+)/}) {
388 $self->{user} = $1;
389 } else {
390 warn "cannot resolve user-relative path without user <$path,$base>\n";
391 }
392 } elsif ($path =~ /^\//) {
393 # already absolute
394 } else {
395 $base =~ s{[^/]+/?$}{};
396 return $class->new ("$base/$path");
397 }
398
399 for ($path) {
400 redo if s{/\.?/}{/};
401 redo if s{/[^/]+/\.\./}{/};
402 }
403 }
404
405 $self->{path} = $path;
406
407 $self
408}
409
410# the name / primary key / in-game path
411sub as_string {
412 my ($self) = @_;
413
414 $self->{user_rel} ? "~$self->{user}$self->{path}"
415 : $self->{random} ? "?random/$self->{path}"
416 : $self->{path}
417}
418
419# the displayed name, this is a one way mapping
420sub visible_name {
421 my ($self) = @_;
422
423# if (my $rmp = $self->{random}) {
424# # todo: be more intelligent about this
425# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
426# } else {
427 $self->as_string
428# }
429}
430
431# escape the /'s in the path
432sub _escaped_path {
433 # ∕ is U+2215
434 (my $path = $_[0]{path}) =~ s/\//∕/g;
435 $path
436}
437
438# the original (read-only) location
439sub load_path {
440 my ($self) = @_;
441
442 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
443}
444
445# the temporary/swap location
446sub save_path {
447 my ($self) = @_;
448
449 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
450 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
451 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
452}
453
454# the unique path, might be eq to save_path
455sub uniq_path {
456 my ($self) = @_;
457
458 $self->{user_rel} || $self->{random}
459 ? undef
460 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
461}
462
463# return random map parameters, or undef
464sub random_map_params {
465 my ($self) = @_;
466
467 $self->{random}
468}
469
470# this is somewhat ugly, but style maps do need special treatment
471sub is_style_map {
472 $_[0]{path} =~ m{^/styles/}
473}
474
475package cf;
476 369
477############################################################################# 370#############################################################################
478 371
479=head2 ATTACHABLE OBJECTS 372=head2 ATTACHABLE OBJECTS
480 373
927=cut 820=cut
928 821
929sub register_extcmd { 822sub register_extcmd {
930 my ($name, $cb) = @_; 823 my ($name, $cb) = @_;
931 824
932 my $caller = caller;
933 #warn "registering extcmd '$name' to '$caller'";
934
935 $EXTCMD{$name} = [$cb, $caller]; 825 $EXTCMD{$name} = $cb;
936} 826}
937 827
938cf::player->attach ( 828cf::player->attach (
939 on_command => sub { 829 on_command => sub {
940 my ($pl, $name, $params) = @_; 830 my ($pl, $name, $params) = @_;
953 843
954 my $msg = eval { from_json $buf }; 844 my $msg = eval { from_json $buf };
955 845
956 if (ref $msg) { 846 if (ref $msg) {
957 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 847 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
958 if (my %reply = $cb->[0]->($pl, $msg)) { 848 if (my %reply = $cb->($pl, $msg)) {
959 $pl->ext_reply ($msg->{msgid}, %reply); 849 $pl->ext_reply ($msg->{msgid}, %reply);
960 } 850 }
961 } 851 }
962 } else { 852 } else {
963 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 853 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
965 855
966 cf::override; 856 cf::override;
967 }, 857 },
968); 858);
969 859
970sub register {
971 my ($base, $pkg) = @_;
972
973 #TODO
974}
975
976sub load_extension { 860sub load_extension {
977 my ($path) = @_; 861 my ($path) = @_;
978 862
979 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 863 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
980 my $base = $1; 864 my $base = $1;
981 my $pkg = $1; 865 my $pkg = $1;
982 $pkg =~ s/[^[:word:]]/_/g; 866 $pkg =~ s/[^[:word:]]/_/g;
983 $pkg = "ext::$pkg"; 867 $pkg = "ext::$pkg";
984 868
985 warn "loading '$path' into '$pkg'\n"; 869 warn "... loading '$path' into '$pkg'\n";
986 870
987 open my $fh, "<:utf8", $path 871 open my $fh, "<:utf8", $path
988 or die "$path: $!"; 872 or die "$path: $!";
989 873
990 my $source = 874 my $source =
991 "package $pkg; use strict; use utf8;\n" 875 "package $pkg; use strict; use utf8;\n"
992 . "#line 1 \"$path\"\n{\n" 876 . "#line 1 \"$path\"\n{\n"
993 . (do { local $/; <$fh> }) 877 . (do { local $/; <$fh> })
994 . "\n};\n1"; 878 . "\n};\n1";
995 879
996 eval $source 880 unless (eval $source) {
997 or die $@ ? "$path: $@\n" 881 my $msg = $@ ? "$path: $@\n"
998 : "extension disabled.\n"; 882 : "extension disabled.\n";
999 883 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
1000 push @exts, $pkg; 884 warn $@;
1001 $ext_pkg{$base} = $pkg; 885 warn "mandatory extension failed to load, exiting.\n";
1002 886 exit 1;
1003# no strict 'refs'; 887 }
1004# @{"$pkg\::ISA"} = ext::; 888 die $@;
1005
1006 register $base, $pkg;
1007}
1008
1009sub unload_extension {
1010 my ($pkg) = @_;
1011
1012 warn "removing extension $pkg\n";
1013
1014 # remove hooks
1015 #TODO
1016# for my $idx (0 .. $#PLUGIN_EVENT) {
1017# delete $hook[$idx]{$pkg};
1018# } 889 }
1019 890
1020 # remove commands 891 push @EXTS, $pkg;
1021 for my $name (keys %COMMAND) {
1022 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1023
1024 if (@cb) {
1025 $COMMAND{$name} = \@cb;
1026 } else {
1027 delete $COMMAND{$name};
1028 }
1029 }
1030
1031 # remove extcmds
1032 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1033 delete $EXTCMD{$name};
1034 }
1035
1036 if (my $cb = $pkg->can ("unload")) {
1037 eval {
1038 $cb->($pkg);
1039 1
1040 } or warn "$pkg unloaded, but with errors: $@";
1041 }
1042
1043 Symbol::delete_package $pkg;
1044} 892}
1045 893
1046sub load_extensions { 894sub load_extensions {
1047 for my $ext (<$LIBDIR/*.ext>) { 895 for my $ext (<$LIBDIR/*.ext>) {
1048 next unless -r $ext; 896 next unless -r $ext;
1052 } or warn "$ext not loaded: $@"; 900 } or warn "$ext not loaded: $@";
1053 } 901 }
1054} 902}
1055 903
1056############################################################################# 904#############################################################################
1057# load/save/clean perl data associated with a map
1058
1059*cf::mapsupport::on_clean = sub {
1060 my ($map) = @_;
1061
1062 my $path = $map->tmpname;
1063 defined $path or return;
1064
1065 unlink "$path.pst";
1066};
1067
1068cf::map->attach (prio => -10000, package => cf::mapsupport::);
1069
1070#############################################################################
1071# load/save perl data associated with player->ob objects
1072
1073sub all_objects(@) {
1074 @_, map all_objects ($_->inv), @_
1075}
1076
1077# TODO: compatibility cruft, remove when no longer needed
1078cf::player->attach (
1079 on_load => sub {
1080 my ($pl, $path) = @_;
1081
1082 for my $o (all_objects $pl->ob) {
1083 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1084 $o->set_ob_key_value ("_perl_data");
1085
1086 %$o = %{ Storable::thaw pack "H*", $value };
1087 }
1088 }
1089 },
1090);
1091
1092#############################################################################
1093 905
1094=head2 CORE EXTENSIONS 906=head2 CORE EXTENSIONS
1095 907
1096Functions and methods that extend core crossfire objects. 908Functions and methods that extend core crossfire objects.
1097 909
910=cut
911
912package cf::player;
913
914use Coro::AIO;
915
1098=head3 cf::player 916=head3 cf::player
1099 917
1100=over 4 918=over 4
1101 919
1102=item cf::player::exists $login 920=item cf::player::find $login
1103 921
1104Returns true when the given account exists. 922Returns the given player object, loading it if necessary (might block).
1105 923
1106=cut 924=cut
1107 925
1108sub cf::player::exists($) { 926sub playerdir($) {
1109 cf::player::find $_[0] 927 cf::localdir
1110 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 928 . "/"
929 . cf::playerdir
930 . "/"
931 . (ref $_[0] ? $_[0]->ob->name : $_[0])
932}
933
934sub path($) {
935 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
936
937 (playerdir $login) . "/$login.pl"
938}
939
940sub find_active($) {
941 $cf::PLAYER{$_[0]}
942 and $cf::PLAYER{$_[0]}->active
943 and $cf::PLAYER{$_[0]}
944}
945
946sub exists($) {
947 my ($login) = @_;
948
949 $cf::PLAYER{$login}
950 or cf::sync_job { !aio_stat $login }
951}
952
953sub find($) {
954 return $cf::PLAYER{$_[0]} || do {
955 my $login = $_[0];
956
957 my $guard = cf::lock_acquire "user_find:$login";
958
959 $cf::PLAYER{$_[0]} || do {
960 my $pl = load_pl path $login
961 or return;
962 $cf::PLAYER{$login} = $pl
963 }
964 }
965}
966
967sub save($) {
968 my ($pl) = @_;
969
970 return if $pl->{deny_save};
971
972 my $path = path $pl;
973 my $guard = cf::lock_acquire "user_save:$path";
974
975 return if $pl->{deny_save};
976
977 aio_mkdir playerdir $pl, 0770;
978 $pl->{last_save} = $cf::RUNTIME;
979
980 $pl->save_pl ($path);
981 Coro::cede;
982}
983
984sub new($) {
985 my ($login) = @_;
986
987 my $self = create;
988
989 $self->ob->name ($login);
990 $self->{deny_save} = 1;
991
992 $cf::PLAYER{$login} = $self;
993
994 $self
995}
996
997=item $pl->quit_character
998
999Nukes the player without looking back. If logged in, the connection will
1000be destroyed. May block for a long time.
1001
1002=cut
1003
1004sub quit_character {
1005 my ($pl) = @_;
1006
1007 $pl->{deny_save} = 1;
1008 $pl->password ("*"); # this should lock out the player until we nuked the dir
1009
1010 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1011 $pl->deactivate;
1012 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1013 $pl->ns->destroy if $pl->ns;
1014
1015 my $path = playerdir $pl;
1016 my $temp = "$path~$cf::RUNTIME~deleting~";
1017 aio_rename $path, $temp;
1018 delete $cf::PLAYER{$pl->ob->name};
1019 $pl->destroy;
1020 IO::AIO::aio_rmtree $temp;
1021}
1022
1023=item cf::player::list_logins
1024
1025Returns am arrayref of all valid playernames in the system, can take a
1026while and may block, so not sync_job-capable, ever.
1027
1028=cut
1029
1030sub list_logins {
1031 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1032 or return [];
1033
1034 my @logins;
1035
1036 for my $login (@$dirs) {
1037 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1038 aio_read $fh, 0, 512, my $buf, 0 or next;
1039 $buf !~ /^password -------------$/m or next; # official not-valid tag
1040
1041 utf8::decode $login;
1042 push @logins, $login;
1043 }
1044
1045 \@logins
1046}
1047
1048=item $player->maps
1049
1050Returns an arrayref of map paths that are private for this
1051player. May block.
1052
1053=cut
1054
1055sub maps($) {
1056 my ($pl) = @_;
1057
1058 my $files = aio_readdir playerdir $pl
1059 or return;
1060
1061 my @paths;
1062
1063 for (@$files) {
1064 utf8::decode $_;
1065 next if /\.(?:pl|pst)$/;
1066 next unless /^$PATH_SEP/o;
1067
1068 s/\.map$//;
1069 push @paths, "~" . $pl->ob->name . "/" . $_;
1070 }
1071
1072 \@paths
1111} 1073}
1112 1074
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1075=item $player->ext_reply ($msgid, $msgtype, %msg)
1114 1076
1115Sends an ext reply to the player. 1077Sends an ext reply to the player.
1116 1078
1117=cut 1079=cut
1118 1080
1119sub cf::player::ext_reply($$$%) { 1081sub ext_reply($$$%) {
1120 my ($self, $id, %msg) = @_; 1082 my ($self, $id, %msg) = @_;
1121 1083
1122 $msg{msgid} = $id; 1084 $msg{msgid} = $id;
1123 1085
1124 $self->send ("ext " . to_json \%msg); 1086 $self->send ("ext " . cf::to_json \%msg);
1125} 1087}
1088
1089package cf;
1126 1090
1127=back 1091=back
1128 1092
1129 1093
1130=head3 cf::map 1094=head3 cf::map
1136package cf::map; 1100package cf::map;
1137 1101
1138use Fcntl; 1102use Fcntl;
1139use Coro::AIO; 1103use Coro::AIO;
1140 1104
1105use overload
1106 '""' => \&as_string;
1107
1141our $MAX_RESET = 7200; 1108our $MAX_RESET = 3600;
1142our $DEFAULT_RESET = 3600; 1109our $DEFAULT_RESET = 3000;
1143 1110
1144sub generate_random_map { 1111sub generate_random_map {
1145 my ($path, $rmp) = @_; 1112 my ($self, $rmp) = @_;
1146 1113
1147 # mit "rum" bekleckern, nicht 1114 # mit "rum" bekleckern, nicht
1148 cf::map::_create_random_map 1115 $self->_create_random_map (
1149 $path,
1150 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1116 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1151 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1117 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1152 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1118 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1153 $rmp->{exit_on_final_map}, 1119 $rmp->{exit_on_final_map},
1154 $rmp->{xsize}, $rmp->{ysize}, 1120 $rmp->{xsize}, $rmp->{ysize},
1155 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1121 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1156 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1122 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1157 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1123 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1158 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1124 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1159 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1125 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1160 (cf::region::find $rmp->{region}) 1126 (cf::region::find $rmp->{region}), $rmp->{custom}
1127 )
1128}
1129
1130sub register {
1131 my (undef, $regex) = @_;
1132 my $pkg = caller;
1133
1134 no strict;
1135 push @{"$pkg\::ISA"}, __PACKAGE__;
1136
1137 $EXT_MAP{$pkg} = qr<$regex>;
1138}
1139
1140# also paths starting with '/'
1141$EXT_MAP{"cf::map"} = qr{^(?=/)};
1142
1143sub normalise {
1144 my ($path, $base) = @_;
1145
1146 # map plan:
1147 #
1148 # /! non-realised random map exit (special hack!)
1149 # {... are special paths that are not being touched
1150 # ?xxx/... are special absolute paths
1151 # ?random/... random maps
1152 # /... normal maps
1153 # ~user/... per-player map of a specific user
1154
1155 $path =~ s/$PATH_SEP/\//go;
1156
1157 # treat it as relative path if it starts with
1158 # something that looks reasonable
1159 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1160 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1161
1162 $base =~ s{[^/]+/?$}{};
1163 $path = "$base/$path";
1164 }
1165
1166 for ($path) {
1167 redo if s{//}{/};
1168 redo if s{/\.?/}{/};
1169 redo if s{/[^/]+/\.\./}{/};
1170 }
1171
1172 $path
1173}
1174
1175sub new_from_path {
1176 my (undef, $path, $base) = @_;
1177
1178 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1179
1180 $path = normalise $path, $base;
1181
1182 for my $pkg (keys %EXT_MAP) {
1183 if ($path =~ $EXT_MAP{$pkg}) {
1184 my $self = bless cf::map::new, $pkg;
1185 $self->{path} = $path; $self->path ($path);
1186 $self->init; # pass $1 etc.
1187 return $self;
1188 }
1189 }
1190
1191 Carp::carp "unable to resolve path '$path'.";
1192 ()
1193}
1194
1195sub init {
1196 my ($self) = @_;
1197
1198 $self
1199}
1200
1201sub as_string {
1202 my ($self) = @_;
1203
1204 "$self->{path}"
1205}
1206
1207# the displayed name, this is a one way mapping
1208sub visible_name {
1209 &as_string
1210}
1211
1212# the original (read-only) location
1213sub load_path {
1214 my ($self) = @_;
1215
1216 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1217}
1218
1219# the temporary/swap location
1220sub save_path {
1221 my ($self) = @_;
1222
1223 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1224 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1225}
1226
1227# the unique path, undef == no special unique path
1228sub uniq_path {
1229 my ($self) = @_;
1230
1231 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1232 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1161} 1233}
1162 1234
1163# and all this just because we cannot iterate over 1235# and all this just because we cannot iterate over
1164# all maps in C++... 1236# all maps in C++...
1165sub change_all_map_light { 1237sub change_all_map_light {
1167 1239
1168 $_->change_map_light ($change) 1240 $_->change_map_light ($change)
1169 for grep $_->outdoor, values %cf::MAP; 1241 for grep $_->outdoor, values %cf::MAP;
1170} 1242}
1171 1243
1244sub unlink_save {
1245 my ($self) = @_;
1246
1247 utf8::encode (my $save = $self->save_path);
1248 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
1249 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
1250}
1251
1172sub try_load_header($) { 1252sub load_header_from($) {
1173 my ($path) = @_; 1253 my ($self, $path) = @_;
1174 1254
1175 utf8::encode $path; 1255 utf8::encode $path;
1176 aio_open $path, O_RDONLY, 0 1256 aio_open $path, O_RDONLY, 0
1177 or return; 1257 or return;
1178 1258
1179 my $map = cf::map::new 1259 $self->_load_header ($path)
1180 or return; 1260 or return;
1181 1261
1182 $map->load_header ($path) 1262 $self->{load_path} = $path;
1263
1264 1
1265}
1266
1267sub load_orig {
1268 my ($self) = @_;
1269
1270 $self->load_header_from ($self->load_path)
1271}
1272
1273sub load_temp {
1274 my ($self) = @_;
1275
1276 $self->load_header_from ($self->save_path)
1277}
1278
1279sub load_header {
1280 my ($self) = @_;
1281
1282 if ($self->load_temp) {
1283 $self->last_access ((delete $self->{last_access})
1284 || $cf::RUNTIME); #d#
1285 # safety
1286 $self->{instantiate_time} = $cf::RUNTIME
1287 if $self->{instantiate_time} > $cf::RUNTIME;
1288 } else {
1289 $self->load_orig
1183 or return; 1290 or return;
1184 1291
1185 $map->{load_path} = $path; 1292 $self->{load_original} = 1;
1293 $self->{instantiate_time} = $cf::RUNTIME;
1294 $self->last_access ($cf::RUNTIME);
1295 $self->instantiate;
1296 }
1186 1297
1187 $map 1298 1
1188} 1299}
1189 1300
1190sub find_map; 1301sub find;
1191sub find_map { 1302sub find {
1192 my ($path, $origin) = @_; 1303 my ($path, $origin) = @_;
1193 1304
1194 #warn "find_map<$path,$origin>\n";#d#
1195
1196 $path = new cf::path $path, $origin && $origin->path; 1305 $path = normalise $path, $origin && $origin->path;
1197 my $key = $path->as_string;
1198 1306
1199 cf::lock_wait "map_find:$key"; 1307 cf::lock_wait "map_find:$path";
1200 1308
1201 $cf::MAP{$key} || do { 1309 $cf::MAP{$path} || do {
1202 my $guard = cf::lock_acquire "map_find:$key"; 1310 my $guard = cf::lock_acquire "map_find:$path";
1203 1311 my $map = new_from_path cf::map $path
1204 # do it the slow way
1205 my $map = try_load_header $path->save_path;
1206
1207 if ($map) {
1208 # safety
1209 $map->{instantiate_time} = $cf::RUNTIME
1210 if $map->{instantiate_time} > $cf::RUNTIME;
1211 } else {
1212 if (my $rmp = $path->random_map_params) {
1213 $map = generate_random_map $key, $rmp;
1214 } else {
1215 $map = try_load_header $path->load_path;
1216 }
1217
1218 $map or return; 1312 or return;
1219 1313
1220 $map->{load_original} = 1;
1221 $map->{instantiate_time} = $cf::RUNTIME;
1222 $map->instantiate;
1223
1224 # per-player maps become, after loading, normal maps
1225 $map->per_player (0) if $path->{user_rel};
1226 }
1227
1228 $map->path ($key);
1229 $map->{path} = $path;
1230 $map->{last_save} = $cf::RUNTIME; 1314 $map->{last_save} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME); 1315
1316 $map->load_header
1317 or return;
1232 1318
1233 if ($map->should_reset) { 1319 if ($map->should_reset) {
1234 $map->reset; 1320 $map->reset;
1235 undef $guard; 1321 undef $guard;
1236 $map = find_map $path 1322 $map = find $path
1237 or return; 1323 or return;
1238 } 1324 }
1239 1325
1240 $cf::MAP{$key} = $map 1326 $cf::MAP{$path} = $map
1241 } 1327 }
1242} 1328}
1243 1329
1244sub load { 1330sub load {
1245 my ($self) = @_; 1331 my ($self) = @_;
1246 1332
1247 my $path = $self->{path}; 1333 my $path = $self->{path};
1248 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1334 my $guard = cf::lock_acquire "map_load:$path";
1249 1335
1250 return if $self->in_memory != cf::MAP_SWAPPED; 1336 return if $self->in_memory != cf::MAP_SWAPPED;
1251 1337
1252 $self->in_memory (cf::MAP_LOADING); 1338 $self->in_memory (cf::MAP_LOADING);
1253 1339
1254 $self->alloc; 1340 $self->alloc;
1255 $self->load_objects ($self->{load_path}, 1) 1341 $self->_load_objects ($self->{load_path}, 1)
1256 or return; 1342 or return;
1257 1343
1258 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1344 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1259 if delete $self->{load_original}; 1345 if delete $self->{load_original};
1260 1346
1261 if (my $uniq = $path->uniq_path) { 1347 if (my $uniq = $self->uniq_path) {
1262 utf8::encode $uniq; 1348 utf8::encode $uniq;
1263 if (aio_open $uniq, O_RDONLY, 0) { 1349 if (aio_open $uniq, O_RDONLY, 0) {
1264 $self->clear_unique_items; 1350 $self->clear_unique_items;
1265 $self->load_objects ($uniq, 0); 1351 $self->_load_objects ($uniq, 0);
1266 } 1352 }
1267 } 1353 }
1354
1355 Coro::cede;
1268 1356
1269 # now do the right thing for maps 1357 # now do the right thing for maps
1270 $self->link_multipart_objects; 1358 $self->link_multipart_objects;
1271 1359
1272 if ($self->{path}->is_style_map) { 1360 unless ($self->{deny_activate}) {
1273 $self->{deny_save} = 1; 1361 $self->decay_objects;
1274 $self->{deny_reset} = 1;
1275 } else {
1276 $self->fix_auto_apply; 1362 $self->fix_auto_apply;
1277 $self->decay_objects;
1278 $self->update_buttons; 1363 $self->update_buttons;
1364 Coro::cede;
1279 $self->set_darkness_map; 1365 $self->set_darkness_map;
1280 $self->difficulty ($self->estimate_difficulty) 1366 $self->difficulty ($self->estimate_difficulty)
1281 unless $self->difficulty; 1367 unless $self->difficulty;
1368 Coro::cede;
1282 $self->activate; 1369 $self->activate;
1283 } 1370 }
1284 1371
1285 $self->in_memory (cf::MAP_IN_MEMORY); 1372 $self->in_memory (cf::MAP_IN_MEMORY);
1286} 1373}
1287 1374
1288sub load_map_sync { 1375sub customise_for {
1376 my ($self, $ob) = @_;
1377
1378 return find "~" . $ob->name . "/" . $self->{path}
1379 if $self->per_player;
1380
1381 $self
1382}
1383
1384# find and load all maps in the 3x3 area around a map
1385sub load_diag {
1386 my ($map) = @_;
1387
1388 my @diag; # diagonal neighbours
1389
1390 for (0 .. 3) {
1391 my $neigh = $map->tile_path ($_)
1392 or next;
1393 $neigh = find $neigh, $map
1394 or next;
1395 $neigh->load;
1396
1397 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1398 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1399 }
1400
1401 for (@diag) {
1402 my $neigh = find @$_
1403 or next;
1404 $neigh->load;
1405 }
1406}
1407
1408sub find_sync {
1289 my ($path, $origin) = @_; 1409 my ($path, $origin) = @_;
1290 1410
1291 #warn "load_map_sync<$path, $origin>\n";#d# 1411 cf::sync_job { find $path, $origin }
1412}
1292 1413
1293 cf::sync_job { 1414sub do_load_sync {
1294 my $map = cf::map::find_map $path, $origin 1415 my ($map) = @_;
1416
1417 cf::sync_job { $map->load };
1418}
1419
1420our %MAP_PREFETCH;
1421our $MAP_PREFETCHER = Coro::async {
1422 while () {
1423 for my $path (keys %MAP_PREFETCH) {
1424 my $map = find $path
1295 or return; 1425 or next;
1296 $map->load; 1426 $map->load;
1297 $map 1427
1428 delete $MAP_PREFETCH{$path};
1429 }
1430 Coro::schedule;
1298 } 1431 }
1432};
1433
1434sub find_async {
1435 my ($path, $origin) = @_;
1436
1437 $path = normalise $path, $origin && $origin->{path};
1438
1439 if (my $map = $cf::MAP{$path}) {
1440 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1441 }
1442
1443 $MAP_PREFETCH{$path} = 0;
1444 $MAP_PREFETCHER->ready;
1445
1446 ()
1299} 1447}
1300 1448
1301sub save { 1449sub save {
1302 my ($self) = @_; 1450 my ($self) = @_;
1303 1451
1452 my $lock = cf::lock_acquire "map_data:" . $self->path;
1453
1304 $self->{last_save} = $cf::RUNTIME; 1454 $self->{last_save} = $cf::RUNTIME;
1305 1455
1306 return unless $self->dirty; 1456 return unless $self->dirty;
1307 1457
1308 my $save = $self->{path}->save_path; utf8::encode $save; 1458 my $save = $self->save_path; utf8::encode $save;
1309 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1459 my $uniq = $self->uniq_path; utf8::encode $uniq;
1310 1460
1311 $self->{load_path} = $save; 1461 $self->{load_path} = $save;
1312 1462
1313 return if $self->{deny_save}; 1463 return if $self->{deny_save};
1314 1464
1465 local $self->{last_access} = $self->last_access;#d#
1466
1467 cf::async {
1468 $_->contr->save for $self->players;
1469 };
1470
1315 if ($uniq) { 1471 if ($uniq) {
1316 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1472 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1317 $self->save_objects ($uniq, cf::IO_UNIQUES); 1473 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1318 } else { 1474 } else {
1319 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1475 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1320 } 1476 }
1321} 1477}
1322 1478
1323sub swap_out { 1479sub swap_out {
1324 my ($self) = @_; 1480 my ($self) = @_;
1325 1481
1326 # save first because save cedes 1482 # save first because save cedes
1327 $self->save; 1483 $self->save;
1484
1485 my $lock = cf::lock_acquire "map_data:" . $self->path;
1328 1486
1329 return if $self->players; 1487 return if $self->players;
1330 return if $self->in_memory != cf::MAP_IN_MEMORY; 1488 return if $self->in_memory != cf::MAP_IN_MEMORY;
1331 return if $self->{deny_save}; 1489 return if $self->{deny_save};
1332 1490
1336 1494
1337sub reset_at { 1495sub reset_at {
1338 my ($self) = @_; 1496 my ($self) = @_;
1339 1497
1340 # TODO: safety, remove and allow resettable per-player maps 1498 # TODO: safety, remove and allow resettable per-player maps
1341 return 1e99 if $self->{path}{user_rel}; 1499 return 1e99 if $self->isa ("ext::map_per_player");
1342 return 1e99 if $self->{deny_reset}; 1500 return 1e99 if $self->{deny_reset};
1343 1501
1344 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1502 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1345 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1503 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1346 1504
1351 my ($self) = @_; 1509 my ($self) = @_;
1352 1510
1353 $self->reset_at <= $cf::RUNTIME 1511 $self->reset_at <= $cf::RUNTIME
1354} 1512}
1355 1513
1356sub unlink_save {
1357 my ($self) = @_;
1358
1359 utf8::encode (my $save = $self->{path}->save_path);
1360 aioreq_pri 3; IO::AIO::aio_unlink $save;
1361 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1362}
1363
1364sub rename { 1514sub rename {
1365 my ($self, $new_path) = @_; 1515 my ($self, $new_path) = @_;
1366 1516
1517 normalise $new_path;
1518
1367 $self->unlink_save; 1519 $self->unlink_save;
1368 1520
1369 delete $cf::MAP{$self->path}; 1521 delete $cf::MAP{$self->path};
1370 $self->{path} = new cf::path $new_path; 1522 $self->{path} = $new_path; $self->path ($self->{path});
1371 $self->path ($self->{path}->as_string);
1372 $cf::MAP{$self->path} = $self; 1523 $cf::MAP{$self->path} = $self;
1373 1524
1374 $self->save; 1525 $self->save;
1375} 1526}
1376 1527
1377sub reset { 1528sub reset {
1378 my ($self) = @_; 1529 my ($self) = @_;
1379 1530
1531 my $lock = cf::lock_acquire "map_data:$self->{path}";
1532
1380 return if $self->players; 1533 return if $self->players;
1381 return if $self->{path}{user_rel};#d# 1534 return if $self->isa ("ext::map_per_player");#d#
1382 1535
1383 warn "resetting map ", $self->path;#d# 1536 warn "resetting map ", $self->path;#d#
1384 1537
1385 delete $cf::MAP{$self->path}; 1538 delete $cf::MAP{$self->path};
1539
1540 $self->in_memory (cf::MAP_SWAPPED);
1541 $self->clear;
1386 1542
1387 $_->clear_links_to ($self) for values %cf::MAP; 1543 $_->clear_links_to ($self) for values %cf::MAP;
1388 1544
1389 $self->unlink_save; 1545 $self->unlink_save;
1390 $self->destroy; 1546 $self->destroy;
1399 $self->reset_timeout (1); 1555 $self->reset_timeout (1);
1400 $self->rename ("{nuke}/" . ($nuke_counter++)); 1556 $self->rename ("{nuke}/" . ($nuke_counter++));
1401 $self->reset; # polite request, might not happen 1557 $self->reset; # polite request, might not happen
1402} 1558}
1403 1559
1404sub customise_for { 1560=item cf::map::unique_maps
1405 my ($map, $ob) = @_;
1406 1561
1407 if ($map->per_player) { 1562Returns an arrayref of paths of all shared maps that have
1408 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1563instantiated unique items. May block.
1409 }
1410 1564
1411 $map 1565=cut
1412}
1413 1566
1414sub emergency_save { 1567sub unique_maps() {
1415 local $cf::FREEZE = 1; 1568 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1569 or return;
1416 1570
1417 warn "enter emergency map save\n"; 1571 my @paths;
1418 1572
1419 cf::sync_job { 1573 for (@$files) {
1420 warn "begin emergency map save\n"; 1574 utf8::decode $_;
1421 $_->save for values %cf::MAP; 1575 next if /\.pst$/;
1576 next unless /^$PATH_SEP/o;
1577
1578 s/\.map$//;
1579 push @paths, $_;
1422 }; 1580 }
1423 1581
1424 warn "end emergency map save\n"; 1582 \@paths
1425} 1583}
1426 1584
1427package cf; 1585package cf;
1428 1586
1429=back 1587=back
1430 1588
1589=head3 cf::object
1590
1591=cut
1592
1593package cf::object;
1594
1595=over 4
1596
1597=item $ob->inv_recursive
1598
1599Returns the inventory of the object _and_ their inventories, recursively.
1600
1601=cut
1602
1603sub inv_recursive_;
1604sub inv_recursive_ {
1605 map { $_, inv_recursive_ $_->inv } @_
1606}
1607
1608sub inv_recursive {
1609 inv_recursive_ inv $_[0]
1610}
1611
1612package cf;
1613
1614=back
1431 1615
1432=head3 cf::object::player 1616=head3 cf::object::player
1433 1617
1434=over 4 1618=over 4
1435 1619
1475 1659
1476=item $player_object->enter_link 1660=item $player_object->enter_link
1477 1661
1478Freezes the player and moves him/her to a special map (C<{link}>). 1662Freezes the player and moves him/her to a special map (C<{link}>).
1479 1663
1480The player should be reaosnably safe there for short amounts of time. You 1664The player should be reasonably safe there for short amounts of time. You
1481I<MUST> call C<leave_link> as soon as possible, though. 1665I<MUST> call C<leave_link> as soon as possible, though.
1482 1666
1667Will never block.
1668
1483=item $player_object->leave_link ($map, $x, $y) 1669=item $player_object->leave_link ($map, $x, $y)
1484 1670
1485Moves the player out of the specila link map onto the given map. If the 1671Moves the player out of the special C<{link}> map onto the specified
1486map is not valid (or omitted), the player will be moved back to the 1672map. If the map is not valid (or omitted), the player will be moved back
1487location he/she was before the call to C<enter_link>, or, if that fails, 1673to the location he/she was before the call to C<enter_link>, or, if that
1488to the emergency map position. 1674fails, to the emergency map position.
1489 1675
1490Might block. 1676Might block.
1491 1677
1492=cut 1678=cut
1679
1680sub link_map {
1681 unless ($LINK_MAP) {
1682 $LINK_MAP = cf::map::find "{link}"
1683 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1684 $LINK_MAP->load;
1685 }
1686
1687 $LINK_MAP
1688}
1493 1689
1494sub cf::object::player::enter_link { 1690sub cf::object::player::enter_link {
1495 my ($self) = @_; 1691 my ($self) = @_;
1496 1692
1497 $self->deactivate_recursive; 1693 $self->deactivate_recursive;
1498 1694
1499 return if $self->map == $LINK_MAP; 1695 return if UNIVERSAL::isa $self->map, "ext::map_link";
1500 1696
1501 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1697 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1502 if $self->map; 1698 if $self->map;
1503 1699
1504 $self->enter_map ($LINK_MAP, 20, 20); 1700 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1505} 1701}
1506 1702
1507sub cf::object::player::leave_link { 1703sub cf::object::player::leave_link {
1508 my ($self, $map, $x, $y) = @_; 1704 my ($self, $map, $x, $y) = @_;
1509 1705
1510 my $link_pos = delete $self->{_link_pos}; 1706 my $link_pos = delete $self->{_link_pos};
1511 1707
1512 unless ($map) { 1708 unless ($map) {
1513 # restore original map position 1709 # restore original map position
1514 ($map, $x, $y) = @{ $link_pos || [] }; 1710 ($map, $x, $y) = @{ $link_pos || [] };
1515 $map = cf::map::find_map $map; 1711 $map = cf::map::find $map;
1516 1712
1517 unless ($map) { 1713 unless ($map) {
1518 ($map, $x, $y) = @$EMERGENCY_POSITION; 1714 ($map, $x, $y) = @$EMERGENCY_POSITION;
1519 $map = cf::map::find_map $map 1715 $map = cf::map::find $map
1520 or die "FATAL: cannot load emergency map\n"; 1716 or die "FATAL: cannot load emergency map\n";
1521 } 1717 }
1522 } 1718 }
1523 1719
1524 ($x, $y) = (-1, -1) 1720 ($x, $y) = (-1, -1)
1527 # use -1 or undef as default coordinates, not 0, 0 1723 # use -1 or undef as default coordinates, not 0, 0
1528 ($x, $y) = ($map->enter_x, $map->enter_y) 1724 ($x, $y) = ($map->enter_x, $map->enter_y)
1529 if $x <=0 && $y <= 0; 1725 if $x <=0 && $y <= 0;
1530 1726
1531 $map->load; 1727 $map->load;
1728 $map->load_diag;
1532 1729
1730 return unless $self->contr->active;
1533 $self->activate_recursive; 1731 $self->activate_recursive;
1534 $self->enter_map ($map, $x, $y); 1732 $self->enter_map ($map, $x, $y);
1535} 1733}
1536 1734
1537cf::player->attach ( 1735cf::player->attach (
1550 1748
1551 # try to abort aborted map switching on player login :) 1749 # try to abort aborted map switching on player login :)
1552 # should happen only on crashes 1750 # should happen only on crashes
1553 if ($pl->ob->{_link_pos}) { 1751 if ($pl->ob->{_link_pos}) {
1554 $pl->ob->enter_link; 1752 $pl->ob->enter_link;
1555 cf::async { 1753 (async {
1556 # we need this sleep as the login has a concurrent enter_exit running 1754 # we need this sleep as the login has a concurrent enter_exit running
1557 # and this sleep increases chances of the player not ending up in scorn 1755 # and this sleep increases chances of the player not ending up in scorn
1756 $pl->ob->reply (undef,
1757 "There was an internal problem at your last logout, "
1758 . "the server will try to bring you to your intended destination in a second.",
1759 cf::NDI_RED);
1558 Coro::Timer::sleep 1; 1760 Coro::Timer::sleep 1;
1559 $pl->ob->leave_link; 1761 $pl->ob->leave_link;
1560 }; 1762 })->prio (2);
1561 } 1763 }
1562 }, 1764 },
1563); 1765);
1564 1766
1565=item $player_object->goto_map ($path, $x, $y) 1767=item $player_object->goto ($path, $x, $y)
1566 1768
1567=cut 1769=cut
1568 1770
1569sub cf::object::player::goto_map { 1771sub cf::object::player::goto {
1570 my ($self, $path, $x, $y) = @_; 1772 my ($self, $path, $x, $y) = @_;
1571 1773
1572 $self->enter_link; 1774 $self->enter_link;
1573 1775
1574 (cf::async { 1776 (async {
1575 $path = new cf::path $path;
1576
1577 my $map = cf::map::find_map $path->as_string; 1777 my $map = cf::map::find $path;
1578 $map = $map->customise_for ($self) if $map; 1778 $map = $map->customise_for ($self) if $map;
1579 1779
1580# warn "entering ", $map->path, " at ($x, $y)\n" 1780# warn "entering ", $map->path, " at ($x, $y)\n"
1581# if $map; 1781# if $map;
1582 1782
1583 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 1783 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1584 1784
1585 $self->leave_link ($map, $x, $y); 1785 $self->leave_link ($map, $x, $y);
1586 })->prio (1); 1786 })->prio (1);
1587} 1787}
1588 1788
1641 1841
1642 return unless $self->type == cf::PLAYER; 1842 return unless $self->type == cf::PLAYER;
1643 1843
1644 $self->enter_link; 1844 $self->enter_link;
1645 1845
1646 (cf::async { 1846 (async {
1847 $self->deactivate_recursive; # just to be sure
1647 unless (eval { 1848 unless (eval {
1648 prepare_random_map $exit 1849 prepare_random_map $exit
1649 if $exit->slaying eq "/!"; 1850 if $exit->slaying eq "/!";
1650 1851
1651 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 1852 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1652 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); 1853 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1653 1854
1654 1; 1855 1;
1655 }) { 1856 }) {
1656 $self->message ("Something went wrong deep within the crossfire server. " 1857 $self->message ("Something went wrong deep within the crossfire server. "
1657 . "I'll try to bring you back to the map you were before. " 1858 . "I'll try to bring you back to the map you were before. "
1658 . "Please report this to the dungeon master", 1859 . "Please report this to the dungeon master!",
1659 cf::NDI_UNIQUE | cf::NDI_RED); 1860 cf::NDI_UNIQUE | cf::NDI_RED);
1660 1861
1661 warn "ERROR in enter_exit: $@"; 1862 warn "ERROR in enter_exit: $@";
1662 $self->leave_link; 1863 $self->leave_link;
1663 } 1864 }
1731 } 1932 }
1732 } 1933 }
1733 }, 1934 },
1734); 1935);
1735 1936
1736=item $client->coro (\&cb) 1937=item $client->async (\&cb)
1737 1938
1738Create a new coroutine, running the specified callback. The coroutine will 1939Create a new coroutine, running the specified callback. The coroutine will
1739be automatically cancelled when the client gets destroyed (e.g. on logout, 1940be automatically cancelled when the client gets destroyed (e.g. on logout,
1740or loss of connection). 1941or loss of connection).
1741 1942
1742=cut 1943=cut
1743 1944
1744sub cf::client::coro { 1945sub cf::client::async {
1745 my ($self, $cb) = @_; 1946 my ($self, $cb) = @_;
1746 1947
1747 my $coro = &cf::async ($cb); 1948 my $coro = &Coro::async ($cb);
1748 1949
1749 $coro->on_destroy (sub { 1950 $coro->on_destroy (sub {
1750 delete $self->{_coro}{$coro+0}; 1951 delete $self->{_coro}{$coro+0};
1751 }); 1952 });
1752 1953
1990 local $/; 2191 local $/;
1991 *CFG = YAML::Syck::Load <$fh>; 2192 *CFG = YAML::Syck::Load <$fh>;
1992 2193
1993 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2194 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994 2195
2196 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2197 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2198
1995 if (exists $CFG{mlockall}) { 2199 if (exists $CFG{mlockall}) {
1996 eval { 2200 eval {
1997 $CFG{mlockall} ? &mlockall : &munlockall 2201 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998 and die "WARNING: m(un)lockall failed: $!\n"; 2202 and die "WARNING: m(un)lockall failed: $!\n";
1999 }; 2203 };
2000 warn $@ if $@; 2204 warn $@ if $@;
2001 } 2205 }
2002} 2206}
2003 2207
2004sub main { 2208sub main {
2005 # we must not ever block the main coroutine 2209 # we must not ever block the main coroutine
2006 local $Coro::idle = sub { 2210 local $Coro::idle = sub {
2007 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2211 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008 (Coro::unblock_sub {
2009 Event::one_event; 2212 async { Event::one_event };
2010 })->();
2011 }; 2213 };
2012 2214
2013 cfg_load; 2215 cfg_load;
2014 db_load; 2216 db_load;
2015 load_extensions; 2217 load_extensions;
2016 Event::loop; 2218 Event::loop;
2017} 2219}
2018 2220
2019############################################################################# 2221#############################################################################
2020# initialisation 2222# initialisation and cleanup
2223
2224# install some emergency cleanup handlers
2225BEGIN {
2226 for my $signal (qw(INT HUP TERM)) {
2227 Event->signal (
2228 data => WF_AUTOCANCEL,
2229 signal => $signal,
2230 cb => sub {
2231 cf::cleanup "SIG$signal";
2232 },
2233 );
2234 }
2235}
2236
2237sub emergency_save() {
2238 my $freeze_guard = cf::freeze_mainloop;
2239
2240 warn "enter emergency perl save\n";
2241
2242 cf::sync_job {
2243 # use a peculiar iteration method to avoid tripping on perl
2244 # refcount bugs in for. also avoids problems with players
2245 # and maps saved/destroyed asynchronously.
2246 warn "begin emergency player save\n";
2247 for my $login (keys %cf::PLAYER) {
2248 my $pl = $cf::PLAYER{$login} or next;
2249 $pl->valid or next;
2250 $pl->save;
2251 }
2252 warn "end emergency player save\n";
2253
2254 warn "begin emergency map save\n";
2255 for my $path (keys %cf::MAP) {
2256 my $map = $cf::MAP{$path} or next;
2257 $map->valid or next;
2258 $map->save;
2259 }
2260 warn "end emergency map save\n";
2261 };
2262
2263 warn "leave emergency perl save\n";
2264}
2021 2265
2022sub reload() { 2266sub reload() {
2023 # can/must only be called in main 2267 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) { 2268 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n"; 2269 warn "can only reload from main coroutine\n";
2026 return; 2270 return;
2027 } 2271 }
2028 2272
2029 warn "reloading..."; 2273 warn "reloading...";
2030 2274
2031 local $FREEZE = 1; 2275 warn "freezing server";
2276 my $guard = freeze_mainloop;
2032 cf::emergency_save; 2277 cf::emergency_save;
2278
2279 warn "sync database to disk";
2280 cf::db_sync;
2281 IO::AIO::flush;
2033 2282
2034 eval { 2283 eval {
2035 # if anything goes wrong in here, we should simply crash as we already saved 2284 # if anything goes wrong in here, we should simply crash as we already saved
2036 2285
2037 # cancel all watchers 2286 warn "cancel all watchers";
2038 for (Event::all_watchers) { 2287 for (Event::all_watchers) {
2039 $_->cancel if $_->data & WF_AUTOCANCEL; 2288 $_->cancel if $_->data & WF_AUTOCANCEL;
2040 } 2289 }
2041 2290
2042 # cancel all extension coros 2291 warn "cancel all extension coros";
2043 $_->cancel for values %EXT_CORO; 2292 $_->cancel for values %EXT_CORO;
2044 %EXT_CORO = (); 2293 %EXT_CORO = ();
2045 2294
2295 warn "remove commands";
2296 %COMMAND = ();
2297
2298 warn "remove ext commands";
2299 %EXTCMD = ();
2300
2046 # unload all extensions 2301 warn "unload/nuke all extensions";
2047 for (@exts) { 2302 for my $pkg (@EXTS) {
2048 warn "unloading <$_>"; 2303 warn "... unloading $pkg";
2049 unload_extension $_; 2304
2305 if (my $cb = $pkg->can ("unload")) {
2306 eval {
2307 $cb->($pkg);
2308 1
2309 } or warn "$pkg unloaded, but with errors: $@";
2050 } 2310 }
2051 2311
2312 warn "... nuking $pkg";
2313 Symbol::delete_package $pkg;
2314 }
2315
2052 # unload all modules loaded from $LIBDIR 2316 warn "unload all perl modules loaded from $LIBDIR";
2053 while (my ($k, $v) = each %INC) { 2317 while (my ($k, $v) = each %INC) {
2054 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2318 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055 2319
2056 warn "removing <$k>"; 2320 warn "removing <$k>";
2057 delete $INC{$k}; 2321 delete $INC{$k};
2064 } 2328 }
2065 2329
2066 Symbol::delete_package $k; 2330 Symbol::delete_package $k;
2067 } 2331 }
2068 2332
2069 # sync database to disk
2070 cf::db_sync;
2071 IO::AIO::flush;
2072
2073 # get rid of safe::, as good as possible 2333 warn "get rid of safe::, as good as possible";
2074 Symbol::delete_package "safe::$_" 2334 Symbol::delete_package "safe::$_"
2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2335 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076 2336
2077 # remove register_script_function callbacks
2078 # TODO
2079
2080 # unload cf.pm "a bit" 2337 warn "unload cf.pm \"a bit\"";
2081 delete $INC{"cf.pm"}; 2338 delete $INC{"cf.pm"};
2082 2339
2083 # don't, removes xs symbols, too, 2340 # don't, removes xs symbols, too,
2084 # and global variables created in xs 2341 # and global variables created in xs
2085 #Symbol::delete_package __PACKAGE__; 2342 #Symbol::delete_package __PACKAGE__;
2086 2343
2087 # reload cf.pm
2088 warn "reloading cf.pm"; 2344 warn "reloading cf.pm";
2089 require cf; 2345 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2346 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091 2347
2092 # load config and database again 2348 warn "load config and database again";
2093 cf::cfg_load; 2349 cf::cfg_load;
2094 cf::db_load; 2350 cf::db_load;
2095 2351
2096 # load extensions
2097 warn "load extensions"; 2352 warn "load extensions";
2098 cf::load_extensions; 2353 cf::load_extensions;
2099 2354
2100 # reattach attachments to objects 2355 warn "reattach attachments to objects/players";
2101 warn "reattach";
2102 _global_reattach; 2356 _global_reattach;
2357 warn "reattach attachments to maps";
2358 reattach $_ for values %MAP;
2103 }; 2359 };
2104 2360
2105 if ($@) { 2361 if ($@) {
2106 warn $@; 2362 warn $@;
2107 warn "error while reloading, exiting."; 2363 warn "error while reloading, exiting.";
2108 exit 1; 2364 exit 1;
2109 } 2365 }
2110 2366
2111 warn "reloaded successfully"; 2367 warn "reloaded";
2112}; 2368};
2113
2114#############################################################################
2115
2116unless ($LINK_MAP) {
2117 $LINK_MAP = cf::map::new;
2118
2119 $LINK_MAP->width (41);
2120 $LINK_MAP->height (41);
2121 $LINK_MAP->alloc;
2122 $LINK_MAP->path ("{link}");
2123 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126 # dirty hack because... archetypes are not yet loaded
2127 Event->timer (
2128 after => 2,
2129 cb => sub {
2130 $_[0]->w->cancel;
2131
2132 # provide some exits "home"
2133 my $exit = cf::object::new "exit";
2134
2135 $exit->slaying ($EMERGENCY_POSITION->[0]);
2136 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139 $LINK_MAP->insert ($exit->clone, 19, 19);
2140 $LINK_MAP->insert ($exit->clone, 19, 20);
2141 $LINK_MAP->insert ($exit->clone, 19, 21);
2142 $LINK_MAP->insert ($exit->clone, 20, 19);
2143 $LINK_MAP->insert ($exit->clone, 20, 21);
2144 $LINK_MAP->insert ($exit->clone, 21, 19);
2145 $LINK_MAP->insert ($exit->clone, 21, 20);
2146 $LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148 $exit->destroy;
2149 });
2150
2151 $LINK_MAP->{deny_save} = 1;
2152 $LINK_MAP->{deny_reset} = 1;
2153
2154 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155}
2156
2157register "<global>", __PACKAGE__;
2158 2369
2159register_command "reload" => sub { 2370register_command "reload" => sub {
2160 my ($who, $arg) = @_; 2371 my ($who, $arg) = @_;
2161 2372
2162 if ($who->flag (FLAG_WIZ)) { 2373 if ($who->flag (FLAG_WIZ)) {
2172 reentrant => 0, 2383 reentrant => 0,
2173 prio => 0, 2384 prio => 0,
2174 at => $NEXT_TICK || $TICK, 2385 at => $NEXT_TICK || $TICK,
2175 data => WF_AUTOCANCEL, 2386 data => WF_AUTOCANCEL,
2176 cb => sub { 2387 cb => sub {
2177 unless ($FREEZE) { 2388 $NOW = Event::time;
2389
2178 cf::server_tick; # one server iteration 2390 cf::server_tick; # one server iteration
2179 $RUNTIME += $TICK; 2391 $RUNTIME += $TICK;
2180 }
2181
2182 $NEXT_TICK += $TICK; 2392 $NEXT_TICK += $TICK;
2393
2394 $WAIT_FOR_TICK->broadcast;
2395 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2183 2396
2184 # if we are delayed by four ticks or more, skip them all 2397 # if we are delayed by four ticks or more, skip them all
2185 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2398 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2186 2399
2187 $TICK_WATCHER->at ($NEXT_TICK); 2400 $TICK_WATCHER->at ($NEXT_TICK);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines